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

[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 IResourceTransition instead.

public interface ITransition

A transition handles everything needed for a document to go from one state to another. It defines which state is reached from another specific state and it defines whether the transition is permitted for a specific resource or for a list of resources.

Method Summary

boolean	execute(IResource aResource) Deprecated. Executes the transition
java.lang.String	getDescription(java.util.Locale aLocale) Deprecated. Gets a description for the transition
java.lang.String	getID() Deprecated. Gets the ID of the transition
java.lang.String	getSuccessMessage(java.util.Locale aLocale) Deprecated. Gets a sucess message for the transition
boolean	isAllowed(IResource aResource) Deprecated. Check whether the transition is allowed for a resource
boolean	isAllowed(IResourceList aResourceList) Deprecated. Checks that the transition is allowed for a list of resources

Method Detail

getID

public java.lang.String getID()

Deprecated.

Gets the ID of the transition

Returns:

the ID value

execute

public boolean execute(IResource aResource)
                throws WcmException

Deprecated.

Executes the transition

Parameters:

aResource - the resource for which the transition is to be executed

Returns:

true if execution was successful

Throws:

WcmException - exception raised in failure situation

getDescription

public java.lang.String getDescription(java.util.Locale aLocale)

Deprecated.

Gets a description for the transition

Parameters:

aLocale - the locale to use

Returns:

the description value

getSuccessMessage

public java.lang.String getSuccessMessage(java.util.Locale aLocale)

Deprecated.

Gets a sucess message for the transition

Parameters:

aLocale - the locale to use

Returns:

the SuccessMessage value

isAllowed

public boolean isAllowed(IResource aResource)
                  throws WcmException

Deprecated.

Check whether the transition is allowed for a resource

Parameters:

aResource - resource to check

Returns:

true if transition is allowed

Throws:

WcmException -

isAllowed

public boolean isAllowed(IResourceList aResourceList)
                  throws WcmException

Deprecated.

Checks that the transition is allowed for a list of resources

Parameters:

aResourceList - resourcelist to check

Returns:

true if transition is permitted for all resources in the list

Throws:

WcmException -