站内搜索: 请输入搜索关键词
当前页面: 在线文档首页 > JBOSS Portal 2.6 API 英文版文档

PortalObjectImpl - JBOSS Portal 2.6 API 英文版文档

Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.jboss.portal.core.impl.model.portal
Class PortalObjectImpl

java.lang.Object
  extended byorg.jboss.portal.core.impl.model.portal.PortalObjectImpl
All Implemented Interfaces:
PortalObject
Direct Known Subclasses:
ContextImpl, PageImpl, PortalImpl, WindowImpl
public abstract class PortalObjectImpl
extends java.lang.Object
implements PortalObject

Version:
$Revision: 5448 $
Author:
Julien Viet

Field Summary
protected  java.util.Collection collection
           
protected  java.util.Map declaredPropertyMap
          .
protected  java.lang.Long key
          The primary key when the object is persisted
protected  java.lang.String listener
          .
protected static org.apache.log4j.Logger log
          The logger.
protected  ObjectNode objectNode
          The node.
protected  java.util.Map properties
           
 
Fields inherited from interface org.jboss.portal.core.model.portal.PortalObject
DEFAULT_OBJECT_NAME, PORTAL_PROP_DEFAULT_OBJECT_NAME, TYPE_CONTEXT, TYPE_PAGE, TYPE_PORTAL, TYPE_WINDOW
 
Constructor Summary
PortalObjectImpl()
           
PortalObjectImpl(boolean hibernate)
           
 
Method Summary
(package private)  void addChild(java.lang.String name, PortalObjectImpl childObject)
           
 void destroyChild(java.lang.String name)
          Destroy an existing child.
 PortalObject getChild(java.lang.String name)
          Return a specific child object or null if it does not exist.
 java.util.Collection getChildren()
          Return all the children of this object.
 PortalObjectContainer getContainer()
          Return the container of this object.
 java.util.Map getDeclaredProperties()
          Return a map that contains the object declared properties.
 java.lang.String getDeclaredProperty(java.lang.String name)
          Return a property declared on that object.
 java.util.Map getDeclaredPropertyMap()
           
protected  PortalObject getDefaultChild()
          Return the default child of this object based on the declared property that specifies the default object name.
 java.lang.String getId()
          Return the id in the scope of its container.
 java.lang.Long getKey()
           
 java.lang.String getListener()
          Return the listener id.
 java.lang.String getName()
          Return the name.
 ObjectNode getObjectNode()
           
 PortalObject getParent()
          Return the parent object.
 java.util.Map getProperties()
          Returns a read only map that contains the object properties.
 java.lang.String getProperty(java.lang.String name)
          Return a property of that object.
abstract  int getType()
          A numerical type that discriminates the object.
 void setDeclaredProperty(java.lang.String name, java.lang.String value)
          Update a property declared on that object.
 void setDeclaredPropertyMap(java.util.Map properties)
           
 void setKey(java.lang.Long key)
           
 void setListener(java.lang.String listener)
          Set a listener id.
 void setObjectNode(ObjectNode objectNode)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

log

protected static final org.apache.log4j.Logger log
The logger.

key

protected java.lang.Long key
The primary key when the object is persisted

declaredPropertyMap

protected java.util.Map declaredPropertyMap
.

listener

protected java.lang.String listener
.

objectNode

protected ObjectNode objectNode
The node.

collection

protected java.util.Collection collection

properties

protected java.util.Map properties
Constructor Detail

PortalObjectImpl

public PortalObjectImpl()

PortalObjectImpl

public PortalObjectImpl(boolean hibernate)
Method Detail

addChild

void addChild(java.lang.String name,
              PortalObjectImpl childObject)
        throws DuplicatePortalObjectException,
               java.lang.IllegalArgumentException
Throws:
DuplicatePortalObjectException
java.lang.IllegalArgumentException

getKey

public java.lang.Long getKey()

setKey

public void setKey(java.lang.Long key)

getObjectNode

public ObjectNode getObjectNode()

setObjectNode

public void setObjectNode(ObjectNode objectNode)

destroyChild

public void destroyChild(java.lang.String name)
                  throws NoSuchPortalObjectException
Description copied from interface: PortalObject
Destroy an existing child.

Specified by:
destroyChild in interface PortalObject
Parameters:
name -
Throws:
NoSuchPortalObjectException - if the child does not exist

getId

public java.lang.String getId()
Description copied from interface: PortalObject
Return the id in the scope of its container.

Specified by:
getId in interface PortalObject

getContainer

public PortalObjectContainer getContainer()
Description copied from interface: PortalObject
Return the container of this object.

Specified by:
getContainer in interface PortalObject

getName

public java.lang.String getName()
Description copied from interface: PortalObject
Return the name.

Specified by:
getName in interface PortalObject
Returns:
the name

getChildren

public java.util.Collection getChildren()
Description copied from interface: PortalObject
Return all the children of this object.

Specified by:
getChildren in interface PortalObject
Returns:
the children

getListener

public java.lang.String getListener()
Description copied from interface: PortalObject
Return the listener id.

Specified by:
getListener in interface PortalObject
Returns:
the listener

setListener

public void setListener(java.lang.String listener)
Description copied from interface: PortalObject
Set a listener id.

Specified by:
setListener in interface PortalObject

getParent

public PortalObject getParent()
Description copied from interface: PortalObject
Return the parent object.

Specified by:
getParent in interface PortalObject
Returns:
the parent object.

getChild

public PortalObject getChild(java.lang.String name)
Description copied from interface: PortalObject
Return a specific child object or null if it does not exist.

Specified by:
getChild in interface PortalObject
Returns:
a child object.

getProperties

public java.util.Map getProperties()
Description copied from interface: PortalObject
Returns a read only map that contains the object properties.

Specified by:
getProperties in interface PortalObject

getDeclaredPropertyMap

public java.util.Map getDeclaredPropertyMap()

setDeclaredPropertyMap

public void setDeclaredPropertyMap(java.util.Map properties)

getDeclaredProperties

public java.util.Map getDeclaredProperties()
Description copied from interface: PortalObject
Return a map that contains the object declared properties.

Specified by:
getDeclaredProperties in interface PortalObject

getDeclaredProperty

public java.lang.String getDeclaredProperty(java.lang.String name)
Description copied from interface: PortalObject
Return a property declared on that object.

Specified by:
getDeclaredProperty in interface PortalObject

setDeclaredProperty

public void setDeclaredProperty(java.lang.String name,
                                java.lang.String value)
Description copied from interface: PortalObject
Update a property declared on that object.

Specified by:
setDeclaredProperty in interface PortalObject

getProperty

public java.lang.String getProperty(java.lang.String name)
Description copied from interface: PortalObject
Return a property of that object.

Specified by:
getProperty in interface PortalObject

toString

public java.lang.String toString()

getType

public abstract int getType()
Description copied from interface: PortalObject
A numerical type that discriminates the object.

Specified by:
getType in interface PortalObject
Returns:
the object type.

getDefaultChild

protected PortalObject getDefaultChild()
Return the default child of this object based on the declared property that specifies the default object name.

Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD