Package org.opencms.ade.publish.shared

Class CmsWorkflowActionParams

java.lang.Object

org.opencms.ade.publish.shared.CmsWorkflowActionParams

All Implemented Interfaces:

com.google.gwt.user.client.rpc.IsSerializable

public class CmsWorkflowActionParams
extends Object
implements com.google.gwt.user.client.rpc.IsSerializable

Contains the data on which a workflow action should act (usually, a list of resources).

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CmsWorkflowActionParams()	Default constructor for serialization.
	CmsWorkflowActionParams(List<CmsUUID> publishIds, List<CmsUUID> removeIds)	Creates a new instance based on lists of resources.
	CmsWorkflowActionParams(CmsPublishListToken token)	Creates a new instance based on a publish list token.

Method Summary

Modifier and Type	Method	Description
List<CmsUUID>	getPublishIds()	Returns the publishIds.
List<CmsUUID>	getRemoveIds()	Returns the removeIds.
CmsPublishListToken	getToken()	Gets the publish list token, if it is set, else returns null.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CmsWorkflowActionParams

public CmsWorkflowActionParams(CmsPublishListToken token)

Creates a new instance based on a publish list token.

Parameters:

token - the publish list token

CmsWorkflowActionParams

public CmsWorkflowActionParams(List<CmsUUID> publishIds,
 List<CmsUUID> removeIds)

Creates a new instance based on lists of resources.

Parameters:

publishIds - the list of structure ids of resources to publish

removeIds - the list of structure ids of resources to remove

CmsWorkflowActionParams

protected CmsWorkflowActionParams()

Default constructor for serialization.

Method Details

getPublishIds

public List<CmsUUID> getPublishIds()

Returns the publishIds.

Returns:

the publishIds

getRemoveIds

public List<CmsUUID> getRemoveIds()

Returns the removeIds.

Returns:

the removeIds

getToken

public CmsPublishListToken getToken()

Gets the publish list token, if it is set, else returns null.

The publish list token is a bean which can be used to reconstruct a publish list on the server side. It is used instead of sending the list of resources when that list is deemed to long to be displayed.

Returns:

the publish list token