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

PortalObjectMetaData - JBOSS Portal 2.2 API 英文版文档


org.jboss.portal.core.metadata
Class PortalObjectMetaData

java.lang.Object
  extended byorg.jboss.portal.core.metadata.PortalObjectMetaData
All Implemented Interfaces:
MetaData
Direct Known Subclasses:
PageMetaData, PortalMetaData, WindowMetaData

public abstract class PortalObjectMetaData
extends java.lang.Object
implements MetaData


Nested Class Summary
static interface PortalObjectMetaData.BuildContext
          Define the spi for creating a portal object.
 
Constructor Summary
PortalObjectMetaData()
           
 
Method Summary
static void buildListenerMetaData(PortalObjectMetaData portalObjectMD, org.w3c.dom.Element listenerElt)
           
static void buildPropertiesMetaData(PortalObjectMetaData portalObjectMD, org.w3c.dom.Element propertiesElt)
           
static java.util.Set buildSecurityConstraintMetaData(org.w3c.dom.Element portalObjectElt)
           
protected  void configure(PortalObject object, PortalObjectMetaData.BuildContext buildContext)
           
static void configurePolicy(PortalPolicyConfig policyConfig, boolean overwrite, java.lang.String handle, java.util.Set secureMD)
           
abstract  PortalObject create(PortalObject parent, PortalObjectMetaData.BuildContext buildContext)
          Create an instance of the corresponding portal object.
 java.util.Map getChildren()
           
protected  java.util.Set getDefaultSecurityConstraints()
          Override to propose a better default for each class.
 java.lang.String getListener()
           
 java.lang.String getName()
           
 java.util.Map getProperties()
           
 java.util.Set getSecurityConstraints()
           
static void removePolicy(PortalPolicyConfig policyConfig, java.lang.String handle)
           
 void setChildren(java.util.Map children)
           
 void setListener(java.lang.String listener)
           
 void setName(java.lang.String name)
           
 void setProperties(java.util.Map properties)
           
 void setSecurityConstraints(java.util.Set securityConstraints)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PortalObjectMetaData

public PortalObjectMetaData()
Method Detail

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getListener

public java.lang.String getListener()

setListener

public void setListener(java.lang.String listener)

getProperties

public java.util.Map getProperties()

setProperties

public void setProperties(java.util.Map properties)

getChildren

public java.util.Map getChildren()

setChildren

public void setChildren(java.util.Map children)

getSecurityConstraints

public java.util.Set getSecurityConstraints()

setSecurityConstraints

public void setSecurityConstraints(java.util.Set securityConstraints)

create

public abstract PortalObject create(PortalObject parent,
                                    PortalObjectMetaData.BuildContext buildContext)
                             throws java.lang.Exception
Create an instance of the corresponding portal object.

Parameters:
parent - the parent object
buildContext - the context
Returns:
the corresponding portal object
Throws:
java.lang.Exception - any exception

getDefaultSecurityConstraints

protected java.util.Set getDefaultSecurityConstraints()
Override to propose a better default for each class.


configure

protected void configure(PortalObject object,
                         PortalObjectMetaData.BuildContext buildContext)
                  throws PortalPolicyConfigException
Throws:
PortalPolicyConfigException

configurePolicy

public static void configurePolicy(PortalPolicyConfig policyConfig,
                                   boolean overwrite,
                                   java.lang.String handle,
                                   java.util.Set secureMD)
                            throws PortalPolicyConfigException
Throws:
PortalPolicyConfigException

removePolicy

public static void removePolicy(PortalPolicyConfig policyConfig,
                                java.lang.String handle)
                         throws PortalPolicyConfigException
Throws:
PortalPolicyConfigException

buildPropertiesMetaData

public static void buildPropertiesMetaData(PortalObjectMetaData portalObjectMD,
                                           org.w3c.dom.Element propertiesElt)

buildListenerMetaData

public static void buildListenerMetaData(PortalObjectMetaData portalObjectMD,
                                         org.w3c.dom.Element listenerElt)

buildSecurityConstraintMetaData

public static java.util.Set buildSecurityConstraintMetaData(org.w3c.dom.Element portalObjectElt)