Java Doc for PortalObject.java in » Portal » jboss-portal-2.6.4 » org » jboss » portal » core » model » portal » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Portal » jboss portal 2.6.4 » org.jboss.portal.core.model.portal

Source Cross Reference

Class Diagram

Java Document (Java Doc)

org.jboss.portal.core.model.portal .PortalObject

All known Subclasses:   org.jboss.portal.core.impl.model.portal .PortalObjectImpl,
PortalObject
public interface PortalObject extends Comparable(Code)
The base interface for all portal objects.
author:
   Julien Viet
version:
   $Revision: 9031 $

Field Summary
int CONTEXT_MASK
     .
String DEFAULT_OBJECT_NAME
     The default portal name.
int PAGE_MASK
     .
int PORTAL_MASK
     .
String PORTAL_PROP_DEFAULT_OBJECT_NAME
     Portal property name that indicates the name of the default portal to lookup.
int TYPE_CONTEXT
     .
int TYPE_PAGE
     .
int TYPE_PORTAL
     .
int TYPE_WINDOW
     .
int WINDOW_MASK
     .

Method Summary
PortalObject copy(PortalObject parent, String name, boolean deep)
     Copy the portal object as a child of the specified object.
void destroyChild(String name)
     Destroy an existing child.
PortalObject getChild(String name)
     Return a specific child object or null if it does not exist.
Collection getChildren()
     Return all the children of this object.
Collection getChildren(int mask)
     Return all the children of this object filtered with a particular mask.
Map getDeclaredProperties()
     Return a map that contains the object declared properties.
String getDeclaredProperty(String name)
     Return a property declared on that object.
LocalizedString getDisplayName()
     Return the localized string used to represent that object.
PortalObjectId getId()
     Return the object id unique in the scope of its container.
String getListener()
     Returns the listener id or null if there is none.
String getName()
     Return the object name unique in the scope of its parent.
PortalObject getParent()
     Return the parent object.
Map getProperties()
     Returns a read only map that contains the object properties.
String getProperty(String name)
     Return a property of that object.
int getType()
     Returns the type of the object which is a value that discriminates the object type.
void setDeclaredProperty(String name, String value)
     Update a property declared on that object.
void setDisplayName(LocalizedString localizedString)
     Set the localized string used to represent that object.
void setListener(String listener)
     Set a listener id.

Field Detail
CONTEXT_MASK
int CONTEXT_MASK(Code)
.

DEFAULT_OBJECT_NAME
String DEFAULT_OBJECT_NAME(Code)
The default portal name.

PAGE_MASK
int PAGE_MASK(Code)
.

PORTAL_MASK
int PORTAL_MASK(Code)
.

PORTAL_PROP_DEFAULT_OBJECT_NAME
String PORTAL_PROP_DEFAULT_OBJECT_NAME(Code)
Portal property name that indicates the name of the default portal to lookup.

TYPE_CONTEXT
int TYPE_CONTEXT(Code)
.

TYPE_PAGE
int TYPE_PAGE(Code)
.

TYPE_PORTAL
int TYPE_PORTAL(Code)
.

TYPE_WINDOW
int TYPE_WINDOW(Code)
.

WINDOW_MASK
int WINDOW_MASK(Code)
.

Method Detail
copy
PortalObject copy(PortalObject parent, String name, boolean deep) throws DuplicatePortalObjectException, IllegalArgumentException(Code)
Copy the portal object as a child of the specified object.
Parameters:
  parent - the parent of the copy
Parameters:
  name - the name of the child
Parameters:
  deep - true copies recursively children the newly created node child of the specified parent
throws:
  DuplicatePortalObjectException - if the specified parent has already a node with such a name
throws:
  IllegalArgumentException - if the specified parent is null

destroyChild
void destroyChild(String name) throws NoSuchPortalObjectException, IllegalArgumentException(Code)
Destroy an existing child.
Parameters:
  name - the child name
throws:
  NoSuchPortalObjectException - if the child does not exist
throws:
  IllegalArgumentException - if the name argument is null

getChild
PortalObject getChild(String name)(Code)
Return a specific child object or null if it does not exist. a child object.

getChildren
Collection getChildren()(Code)
Return all the children of this object. the children

getChildren
Collection getChildren(int mask)(Code)
Return all the children of this object filtered with a particular mask. the children

getDeclaredProperties
Map getDeclaredProperties()(Code)
Return a map that contains the object declared properties. a map of the properties declared by the object

getDeclaredProperty
String getDeclaredProperty(String name) throws IllegalArgumentException(Code)
Return a property declared on that object. the property value
throws:
  IllegalArgumentException - if the name is null

getDisplayName
LocalizedString getDisplayName()(Code)
Return the localized string used to represent that object. the localized display name

getId
PortalObjectId getId()(Code)
Return the object id unique in the scope of its container. the object id

getListener
String getListener()(Code)
Returns the listener id or null if there is none. the listener

getName
String getName()(Code)
Return the object name unique in the scope of its parent. the object name

getParent
PortalObject getParent()(Code)
Return the parent object. the parent object.

getProperties
Map getProperties()(Code)
Returns a read only map that contains the object properties. a map of the object properties

getProperty
String getProperty(String name) throws IllegalArgumentException(Code)
Return a property of that object. the property value
throws:
  IllegalArgumentException - if the name is null

getType
int getType()(Code)
Returns the type of the object which is a value that discriminates the object type. the object type.

setDeclaredProperty
void setDeclaredProperty(String name, String value) throws IllegalArgumentException(Code)
Update a property declared on that object.
Parameters:
  name - the property name
Parameters:
  value - the property value
throws:
  IllegalArgumentException - if the name argument is null

setDisplayName
void setDisplayName(LocalizedString localizedString)(Code)
Set the localized string used to represent that object.
Parameters:
  the - localized display name

setListener
void setListener(String listener)(Code)
Set a listener id.
Parameters:
  listener - the listener id

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.