Package org.opencms.ade.publish.shared
Class CmsWorkflowResponse
- java.lang.Object
-
- org.opencms.ade.publish.shared.CmsWorkflowResponse
-
- All Implemented Interfaces:
com.google.gwt.user.client.rpc.IsSerializable
public class CmsWorkflowResponse extends java.lang.Object implements com.google.gwt.user.client.rpc.IsSerializable
The result of a workflow action.
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
CmsWorkflowResponse()
Constructor needed for serialization only.CmsWorkflowResponse(boolean isSuccess, java.lang.String message, java.util.List<CmsPublishResource> resources, java.util.List<CmsWorkflowAction> availableActions, CmsUUID workflowId)
Creates a new workflow response object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.List<CmsWorkflowAction>
getAvailableActions()
Returns the list of actions which are available next.java.lang.String
getMessage()
Gets the message which should be displayed to the user in case of failure.java.util.List<CmsPublishResource>
getResources()
Gets the list of resources which should be presented to the user in case of failure.CmsUUID
getWorkflowId()
Gets the internal workflow id.boolean
isSuccess()
Returns true if the action for which this object is the workflow response was successful or not.
-
-
-
Constructor Detail
-
CmsWorkflowResponse
public CmsWorkflowResponse(boolean isSuccess, java.lang.String message, java.util.List<CmsPublishResource> resources, java.util.List<CmsWorkflowAction> availableActions, CmsUUID workflowId)
Creates a new workflow response object.- Parameters:
isSuccess
- a flag indicating whether the workflow action was successfulmessage
- the message which should be displayed to the user in case of failureresources
- the resources which should be presented to the user in case of failureavailableActions
- the actions which should be possible for the user in case of failureworkflowId
- the internal workflow id
-
CmsWorkflowResponse
protected CmsWorkflowResponse()
Constructor needed for serialization only.
-
-
Method Detail
-
getAvailableActions
public java.util.List<CmsWorkflowAction> getAvailableActions()
Returns the list of actions which are available next.- Returns:
- a list of beans representing the next possible workflow actions
-
getMessage
public java.lang.String getMessage()
Gets the message which should be displayed to the user in case of failure.- Returns:
- the message which should be displayed to the user in case of failure
-
getResources
public java.util.List<CmsPublishResource> getResources()
Gets the list of resources which should be presented to the user in case of failure.- Returns:
- a list of resources
-
getWorkflowId
public CmsUUID getWorkflowId()
Gets the internal workflow id.- Returns:
- the internal workflow id
-
isSuccess
public boolean isSuccess()
Returns true if the action for which this object is the workflow response was successful or not.- Returns:
- true if the workflow action was successful
-
-