PortalObject - 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.model.portal
Interface PortalObject

All Known Subinterfaces:: Context, Page, PageContainer, Portal, Window

All Known Implementing Classes:: ContextImpl, PageImpl, PortalImpl, PortalObjectImpl, WindowImpl

public interface PortalObject

The base interface for all portal objects.

Version:: $Revision: 5448 $
Author:: Julien Viet

Field Summary

static java.lang.String DEFAULT_OBJECT_NAME
          The default portal name.

static java.lang.String PORTAL_PROP_DEFAULT_OBJECT_NAME
          Portal property name that indicates the name of the default portal to lookup.

static int TYPE_CONTEXT


static int TYPE_PAGE


static int TYPE_PORTAL


static int TYPE_WINDOW


Method Summary

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.lang.String getId()
          Return the id in the scope of its container.

java.lang.String getListener()
          Return the listener id.

java.lang.String getName()
          Return the name.

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.

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 setListener(java.lang.String listener)
          Set a listener id.

Field Detail

PORTAL_PROP_DEFAULT_OBJECT_NAME

public static final java.lang.String PORTAL_PROP_DEFAULT_OBJECT_NAME

Portal property name that indicates the name of the default portal to lookup.

See Also:: Constant Field Values

DEFAULT_OBJECT_NAME

public static final java.lang.String DEFAULT_OBJECT_NAME

The default portal name.

See Also:: Constant Field Values

TYPE_CONTEXT

public static final int TYPE_CONTEXT

See Also:: Constant Field Values

TYPE_PORTAL

public static final int TYPE_PORTAL

See Also:: Constant Field Values

TYPE_PAGE

public static final int TYPE_PAGE

See Also:: Constant Field Values

TYPE_WINDOW

public static final int TYPE_WINDOW

See Also:: Constant Field Values

Method Detail

getId

public java.lang.String getId()

Return the id in the scope of its container.

getContainer

public PortalObjectContainer getContainer()

Return the container of this object.

getType

public int getType()

A numerical type that discriminates the object.

Returns:: the object type.

getName

public java.lang.String getName()

Return the name.

Returns:: the name

getListener

public java.lang.String getListener()

Return the listener id.

Returns:: the listener

setListener

public void setListener(java.lang.String listener)

Set a listener id.

getChildren

public java.util.Collection getChildren()

Return all the children of this object.

Returns:: the children

getParent

public PortalObject getParent()

Return the parent object.

Returns:: the parent object.

getChild

public PortalObject getChild(java.lang.String name)

Return a specific child object or null if it does not exist.

Returns:: a child object.

destroyChild

public void destroyChild(java.lang.String name)
                  throws NoSuchPortalObjectException,
                         java.lang.IllegalArgumentException

Destroy an existing child.

Parameters:: name -
Throws:: NoSuchPortalObjectException - if the child does not exist; java.lang.IllegalArgumentException

getProperty

public java.lang.String getProperty(java.lang.String name)

Return a property of that object.

getProperties

public java.util.Map getProperties()

Returns a read only map that contains the object properties.

getDeclaredProperties

public java.util.Map getDeclaredProperties()

Return a map that contains the object declared properties.

getDeclaredProperty

public java.lang.String getDeclaredProperty(java.lang.String name)

Return a property declared on that object.

setDeclaredProperty

public void setDeclaredProperty(java.lang.String name,
                                java.lang.String value)

Update a property declared on that object.