com.ibm.portal.pcm.dialog.model
Interface ReferencedResource

public interface ReferencedResource

A referenced resource references a portal resource either by specifying its unique name or a metadata key assigned to that resource. In the latter case the metadata key serves as a marker for the resource.

Since:

8.5

Nested Class Summary

static class

ReferencedResource.ResourceType

Method Summary

java.lang.String	getMetaDataKey() Returns the metadata key of the referenced portal resource.
java.lang.String	getParentResourceUniqueName() Returns the parent unique name of the referenced portal resource.
ObjectID	getResourceObjectID() Returns the ObjectID of the referenced portal resource.
java.lang.String	getResourceUniqueName() Returns the unique name of the referenced portal resource.
ReferencedResource.ResourceType	getType() Returns the ResourceType of the referenced portal resource.

Method Detail

getResourceObjectID

ObjectID getResourceObjectID()

Returns the ObjectID of the referenced portal resource.

Returns:

The ObjectID of the referenced portal resource; null in case the resource is referenced via a metadata key.

getResourceUniqueName

java.lang.String getResourceUniqueName()

Returns the unique name of the referenced portal resource.

Returns:

The unique name of the referenced portal resource; null in case the resource is referenced via a metadata key.

getMetaDataKey

java.lang.String getMetaDataKey()

Returns the metadata key of the referenced portal resource.

Returns:

The metadata key of the referenced portal resource; null in case the resource is referenced via a unique name.

getParentResourceUniqueName

java.lang.String getParentResourceUniqueName()

Returns the parent unique name of the referenced portal resource. This property is used in case a dynamic portal is supposed to be added to a dynamic page. In that case the unique name references the portlet (window) to be added to the dynamic page and the parent unique name the base page from which the dynamic page is supposed to be created.

Returns:

The parent unique name of the referenced portal resource; null in case the resource is referenced via a metadata key or transition endpoint is volatile.

getType

ReferencedResource.ResourceType getType()

Returns the ResourceType of the referenced portal resource. Valid values include NODE and HIERARCHY. NODE indicates that exactly one single portal resource (usually a page) is referenced, HIERARCHY indicates that a hierarchy of portal resources (usually a page and its child pages) are referenced.

Returns:

The ResourceType of the referenced portal resource; null in case the resource is referenced via a metadata key.