Package org.opencms.ade.publish.shared

Class CmsPublishGroupList

java.lang.Object

org.opencms.ade.publish.shared.CmsPublishGroupList

All Implemented Interfaces:

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

public class CmsPublishGroupList
extends java.lang.Object
implements com.google.gwt.user.client.rpc.IsSerializable

A class which represents a list of publish groups to display to the user for selection.

It may be the case that there are too many resources to display. In this case, the instance will not contain the publish groups, but instead a publish list token which can be used later to reconstruct the publish list.

Constructor Summary

Constructors

Constructor	Description
CmsPublishGroupList()	Default constructor.
CmsPublishGroupList(CmsPublishListToken token)	Constructs a new instance with a publish list token and an empty group list.

Method Summary

Modifier and Type	Method	Description
java.util.List<CmsPublishGroup>	getGroups()	Gets the list of publish groups.
java.lang.String	getOverrideWorkflowId()	Gets the override workflow id.
CmsPublishListToken	getToken()	Returns the token.
java.lang.String	getTooManyResourcesMessage()	Gets the message which should be displayed if the token is being used instead of the list of publish groups.
void	setGroups(java.util.List<CmsPublishGroup> groups)	Sets the publish groups.
void	setOverrideWorkflowId(java.lang.String id)	Sets the Override workflow.
void	setTooManyResourcesMessage(java.lang.String tooManyResourcesMessage)	Sets the tooManyResourcesMessage.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsPublishGroupList

public CmsPublishGroupList()

Default constructor.

CmsPublishGroupList

public CmsPublishGroupList(CmsPublishListToken token)

Constructs a new instance with a publish list token and an empty group list.

Parameters:

token - the publish list token to use

Method Detail

getGroups

public java.util.List<CmsPublishGroup> getGroups()

Gets the list of publish groups.

Returns:

the publish groups

getOverrideWorkflowId

public java.lang.String getOverrideWorkflowId()

Gets the override workflow id.

If this is not null, this indicates that the publish groups were fetched for a different workflow than that selected by default in the publish dialog, and that the publish dialog should change its selected workflow accordingly.

Returns:

the override workflow id

getToken

public CmsPublishListToken getToken()

Returns the token.

Returns:

the token

getTooManyResourcesMessage

public java.lang.String getTooManyResourcesMessage()

Gets the message which should be displayed if the token is being used instead of the list of publish groups.

Returns:

the message

setGroups

public void setGroups(java.util.List<CmsPublishGroup> groups)

Sets the publish groups.

Parameters:

groups - the list of publish groups

setOverrideWorkflowId

public void setOverrideWorkflowId(java.lang.String id)

Sets the Override workflow.

Parameters:

id - the id of the override workflow

setTooManyResourcesMessage

public void setTooManyResourcesMessage(java.lang.String tooManyResourcesMessage)

Sets the tooManyResourcesMessage.

Parameters:

tooManyResourcesMessage - the tooManyResourcesMessage to set