com.ibm.portal.pcm.dialog.model
Interface TransitionLocator<E extends java.lang.Object & Transition>

Type Parameters:
E -
All Superinterfaces:
Locator<E>, MetaDataLocator<java.lang.String,E>

public interface TransitionLocator<E extends java.lang.Object & Transition>
extends Locator<E>, MetaDataLocator<java.lang.String,E>

A locator for finding Transitions in a transition model. This locator interface is optionally implemented by TransitionModel implementations.

Since:
8.0.0
See Also:
Transition

Method Summary
 IterableListModel<E> findBySource(Identifiable aSourceEndpoint)
          Finds the transitions that originate from the given source endpoint
 IterableListModel<E> findBySourceAndEvent(Identifiable aSourceEndpoint, javax.xml.namespace.QName aSourceEvent)
          Finds the transitions that originate from the given source endpoint and that are triggered via the given source event.
 IterableListModel<E> findByTarget(Identifiable aTargetEndpoint)
          Find the transitions targeting the given target endpoint.
 IterableListModel<E> findByTargetAndEvent(Identifiable aTargetEndpoint, javax.xml.namespace.QName aTargetEvent)
          Find the transitions targeting the given target endpoint with the given target event.
 IterableListModel<E> findStartTransitionsByEntryPointAndSourceEvent(Identifiable entryPoint, javax.xml.namespace.QName sourceEvent)
          Finds start transitions that are the best match for the given source event, no matter what kind of source transition endpoint is specified.
 IterableListModel<E> findStartTransitionsBySourceAndEvent(Identifiable aSourceEndpoint, javax.xml.namespace.QName aSourceEvent)
          Finds start transitions that are the best match for given source endpoint and event.
 
Methods inherited from interface com.ibm.portal.MetaDataLocator
findByMetaData, findSingleByMetaData
 
Methods inherited from interface com.ibm.portal.Locator
findByID, findByUniqueName
 

Method Detail

findBySource

IterableListModel<E> findBySource(Identifiable aSourceEndpoint)
Finds the transitions that originate from the given source endpoint

Parameters:
aSourceEndpoint - The ObjectID the returned transitions originate from.
Returns:
List model containing the Transitions originating from the given source transition endpoint.

findBySourceAndEvent

IterableListModel<E> findBySourceAndEvent(Identifiable aSourceEndpoint,
                                          javax.xml.namespace.QName aSourceEvent)
Finds the transitions that originate from the given source endpoint and that are triggered via the given source event.

Parameters:
aSourceEndpoint - The ObjectID the returned transitions originate from.
aSourceEvent - the QName of the source event that triggers this transition.
Returns:
List model containing the Transitions originating from the given source transition endpoint that are triggered by the given source event.

findStartTransitionsByEntryPointAndSourceEvent

IterableListModel<E> findStartTransitionsByEntryPointAndSourceEvent(Identifiable entryPoint,
                                                                    javax.xml.namespace.QName sourceEvent)
Finds start transitions that are the best match for the given source event, no matter what kind of source transition endpoint is specified.

Parameters:
entryPoint - Source transition endpoint to be looked for, or null if all start transitions should be checked.
sourceEvent - The QName of the source event that triggers this transition.
Returns:
IterableListModel containing the Start-Transitions originating from any source transition endpoint that are triggered by the given source event.

findStartTransitionsBySourceAndEvent

IterableListModel<E> findStartTransitionsBySourceAndEvent(Identifiable aSourceEndpoint,
                                                          javax.xml.namespace.QName aSourceEvent)
Finds start transitions that are the best match for given source endpoint and event.

This might return a transition for the source endpoint ANY, but only if no transition is found that is a exact match.

Parameters:
aSourceEndpoint - The ObjectID of the source transition endpoint of the transition to search for.
aSourceEvent - The QName of the source event that triggers this transition.
Returns:
List model containing the Start-Transitions originating from the given source transition endpoint that are triggered by the given source event.

findByTarget

IterableListModel<E> findByTarget(Identifiable aTargetEndpoint)
Find the transitions targeting the given target endpoint.

Parameters:
aTargetEndpoint - The ObjectID the returned transitions to target.
Returns:
List model containing the Transitions targeting the given target transition endpoint.

findByTargetAndEvent

IterableListModel<E> findByTargetAndEvent(Identifiable aTargetEndpoint,
                                          javax.xml.namespace.QName aTargetEvent)
Find the transitions targeting the given target endpoint with the given target event.

Parameters:
aTargetEndpoint - The ObjectID the returned transitions to target.
aTargetEvent - The QName of the target event triggered by this transition.
Returns:
List model containing the Transitions targeting the given target transition endpoint that do trigger the given target event.