com.sapportals.wcm.repository.service.statemanagement
Interface IStatemanagement

[contained in: com.sap.km.cm.repository.service.base.par - km.shared.repository.service.statemanagement_api.jar] Deprecated. as of EP5 SP4, all state management related classes will become resource-dependent. Please use IStatemanagementResource to handle states and transitions for a single resource.

public interface IStatemanagement

This interface handles everything to do with the states and transitions between states of a resource.

Method Summary

java.lang.String	executeTransition(ITransition aTransition, IResource aResource) Deprecated. Executes the specified transition for the resource
void	executeTransition(ITransition aTransition, IResourceList aResourceList, IResourceContext aContext) Deprecated. Executes the specified transition for a list of resources
ITransition	getTransition(java.lang.String impID) Deprecated. Returns the ITransition with the specified ID
ITransitionList	getTransitions(IResource aResource) Deprecated. Returns all transitions defined in the workflow process for a resource
ITransitionList	getTransitions(IResourceList aResourceList, IResourceContext aContext) Deprecated. Returns all transitions defined in the workflow process for a resource list
void	setInitialState(IResource aResource) Deprecated. Sets the initial state for a resource (i.e. in progress)
void	setInitialState(IResourceList aResourceList, IResourceContext aContext) Deprecated. Sets the initial state for a list of resources (i.e. in progress)

Method Detail

getTransition

public ITransition getTransition(java.lang.String impID)
                          throws WcmException

Deprecated.

Returns the ITransition with the specified ID

Parameters:

impID - ID of a transition

Returns:

transition with specified key or null if not found

Throws:

WcmException -

getTransitions

public ITransitionList getTransitions(IResource aResource)
                               throws WcmException

Deprecated.

Returns all transitions defined in the workflow process for a resource

Parameters:

aResource - a resource

Returns:

a complete list of all transitions defined for the workflow of the resource

Throws:

WcmException - exception raised in failure situation

getTransitions

public ITransitionList getTransitions(IResourceList aResourceList,
                                      IResourceContext aContext)
                               throws WcmException

Deprecated.

Returns all transitions defined in the workflow process for a resource list

Parameters:

aResourceList - list of resources

aContext - resource context to be used for this, because each resource in the resource list can have a different context. The context determines the actual user.

Returns:

a complete transition list for the workflow of the resource

Throws:

WcmException - exception raised in failure situation

executeTransition

public java.lang.String executeTransition(ITransition aTransition,
                                          IResource aResource)
                                   throws WcmException

Deprecated.

Executes the specified transition for the resource

Parameters:

aTransition - transition to execute

aResource - resource that is subjected to the transition

Returns:

language-dependent message for the user interface if transition is successful

Throws:

WcmException -

executeTransition

public void executeTransition(ITransition aTransition,
                              IResourceList aResourceList,
                              IResourceContext aContext)
                       throws WcmException

Deprecated.

Executes the specified transition for a list of resources

Parameters:

aTransition - transition to execute

aResourceList - list of resources

aContext - context to be used for all resources

Throws:

WcmException -

setInitialState

public void setInitialState(IResource aResource)
                     throws WcmException

Deprecated.

Sets the initial state for a resource (i.e. in progress)

Parameters:

aResource - a resource

Throws:

WcmException -

setInitialState

public void setInitialState(IResourceList aResourceList,
                            IResourceContext aContext)
                     throws WcmException

Deprecated.

Sets the initial state for a list of resources (i.e. in progress)

Parameters:

aResourceList - list of resources

aContext - resource context to be used for this, because each resource in the resource list can have a different context. The context determines the actual user.

Throws:

WcmException -