Class CmsPublishGroupList

  • All Implemented Interfaces:

    public class CmsPublishGroupList
    extends java.lang.Object
    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.

    • Method Detail

      • getGroups

        public java.util.List<CmsPublishGroupgetGroups()
        Gets the list of publish groups.

        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.

        the override workflow id
      • 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.

        the message
      • setGroups

        public void setGroups​(java.util.List<CmsPublishGroup> groups)
        Sets the publish groups.

        groups - the list of publish groups
      • setOverrideWorkflowId

        public void setOverrideWorkflowId​(java.lang.String id)
        Sets the Override workflow.

        id - the id of the override workflow
      • setTooManyResourcesMessage

        public void setTooManyResourcesMessage​(java.lang.String tooManyResourcesMessage)
        Sets the tooManyResourcesMessage.

        tooManyResourcesMessage - the tooManyResourcesMessage to set