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

All Superinterfaces:
Identifiable, Localized, MetaDataProvider<java.lang.String,java.util.Map.Entry<java.lang.String,java.lang.String>>, TimeStamped

public interface TransitionEndpoint
extends TimeStamped, Identifiable, Localized, MetaDataProvider<java.lang.String,java.util.Map.Entry<java.lang.String,java.lang.String>>

Provides access to a transition endpoint being part of a dialog in the scope of the UX Screen Flow Manager. A transition endpoint is referenced by Transitions which reference it as source or target.

Since:
8.0.0
See Also:
TransitionEndpointModel, Transition

Method Summary
 java.lang.String getName()
          Returns the name of this transition endpoint.
 ObjectID getPortalResourceObjectID()
          Deprecated. Use getReferencedResources() instead.
 java.util.List<ReferencedResource> getReferencedResources()
          Returns a list of references resources.
 
Methods inherited from interface com.ibm.portal.TimeStamped
getCreated, getLastModified
 
Methods inherited from interface com.ibm.portal.Identifiable
getObjectID
 
Methods inherited from interface com.ibm.portal.Localized
getDescription, getLocales, getTitle
 
Methods inherited from interface com.ibm.portal.MetaDataProvider
getMetaData
 

Method Detail

getName

java.lang.String getName()
Returns the name of this transition endpoint.

Returns:
The name of this transition endpoint, never null

getPortalResourceObjectID

ObjectID getPortalResourceObjectID()
                                   throws java.lang.IllegalStateException
Deprecated. Use getReferencedResources() instead.

Returns the ObjectID of the referenced portal resource.

Returns:
The ObjectID of the referenced portal resource, never null
Throws:
java.lang.IllegalStateException - In case more than one portal resource is referenced by this transition endpoint.

getReferencedResources

java.util.List<ReferencedResource> getReferencedResources()
                                                          throws ReferencedResourceException
Returns a list of references resources. 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.

Returns:
The list of ReferencedResources, never null
Throws:
ReferencedResourceException - In case of an internal error while looking up a referenced resources.