com.sapportals.wcm.repository.service.statemanagement
Interface IResourceTransition
[contained in: com.sap.km.cm.repository.service.base.par - km.shared.repository.service.statemanagement_api.jar]
- public interface IResourceTransition
A IResourceTransition handles everything needed for a document to go from one state to another. It
defines the state that is reached from another specific state and it defines whether the transition is allowed. One
instance of an IResourceTransition handles one transition per resource.
|
Method Summary |
boolean |
execute()
Changes the state of the current resource to the target state of
the transition.
|
java.lang.String |
getDescription()
Gets a meaningful lable for the presentation of the transition
in the UI.
|
java.lang.String |
getExecMessage()
Gets a message after method execute() has been called.
|
java.lang.String |
getID()
Gets the ID of the transition.
|
boolean |
isAllowed()
Checks whether the transition is allowed for the current resource.
|
isAllowed
public boolean isAllowed()
throws WcmException
- Checks whether the transition is allowed for the current resource.
A transition is only allowed if the source state of the
transition is the same as the current state of the resource.
In addition, other conditions may forbid a transition.
This method is used by the statemanagement in the user interface
to provide the user with permitted transitions only.
- Returns:
- true, if the transition can be performed
- Throws:
WcmException - exception raised in failure situation
execute
public boolean execute()
throws WcmException
- Changes the state of the current resource to the target state of
the transition.
If the transition is allowed, it is executed now. This
means that the state of the current resource changes to the target state
specified in this transition. A transition can also perform certain other
actions associated with this transition, such as sending a mail or an event.
- Returns:
- true, if the transition was executed successfully
- Throws:
WcmException - exception raised in failure situation
getExecMessage
public java.lang.String getExecMessage()
throws WcmException
- Gets a message after method
execute() has been called.
This method is used by the UI to provide a message for the user after
a transition has been executed.
Returns null if execute() has not yet been called.
- Returns:
- the ExecMessage value
getID
public java.lang.String getID()
- Gets the ID of the transition.
The ID is a unique identifier for a transition.
- Returns:
- the ID value
getDescription
public java.lang.String getDescription()
- Gets a meaningful lable for the presentation of the transition
in the UI.
The description is a verb or a phrase that describes the
action to be performed by the user to execute this transition.
- Returns:
- a label to be used in the user interface
Copyright © 2004 by
SAP AG. All Rights Reserved.
SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein
as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other
countries all over the world. All other product and service names mentioned are the trademarks of their respective companies.
Data contained in this document serves informational purposes only. National product specifications may vary.
These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies
("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be
liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are
those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein
should be construed as constituting an additional warranty.