Package org.opencms.ade.publish.shared

Class CmsPublishOptions

  • All Implemented Interfaces:
    java.io.Serializable
    public class CmsPublishOptions
extends java.lang.Object
implements java.io.Serializable
    Bean encapsulating all ADE publish options.

    Since:
    7.6
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String INCLUDE_CONTENTS_CHECKBOX_DISABLE
      Value to indicate that the 'resources in folders' checkbox should be disabled.
      static java.lang.String INCLUDE_CONTENTS_CHECKBOX_PLURAL
      Value to indicate that the 'resources in folders' checkbox should be enabled.
      static java.lang.String INCLUDE_CONTENTS_CHECKBOX_SINGULAR
      Value to indicate that the 'resources in folders' checkbox should be enabled, but labeled 'resources in folder' instead.
      static java.lang.String PARAM_COLLECTOR_INFO
      The collector information.
      static java.lang.String PARAM_COLLECTOR_ITEMS
      Parameter name for the collector items.
      static java.lang.String PARAM_CONTAINERPAGE
      Parameter name for the container page structure id.
      static java.lang.String PARAM_CONTENT
      Parameter name for the content structure id.
      static java.lang.String PARAM_DETAIL
      Parameter name for the detail content structure id.
      static java.lang.String PARAM_ENABLE_INCLUDE_CONTENTS
      Parameter for enabling the 'add contents' check box.
      static java.lang.String PARAM_FILES
      The name of the parameter used for passing in the list of resources.
      static java.lang.String PARAM_INCLUDE_CONTENTS
      The name of the parameter which controls whether to add sub-resources of folders.
      static java.lang.String PARAM_START_WITH_CURRENT_PAGE
      Parameter for indicating that the initial project should be the 'current page' virtual project.

    • Constructor Summary

      Constructors 
      Constructor Description
      CmsPublishOptions()
      Creates a new publish options bean.
      CmsPublishOptions​(boolean includeRelated, boolean includeSiblings, CmsUUID projectId)
      Creates a new publish options bean.
      CmsPublishOptions​(java.util.Map<java.lang.String,​java.lang.String> params)
      Creates a new instance.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Map<java.lang.String,​java.lang.String> getParameters()
      Gets the additional publish parameters.
      CmsUUID getProjectId()
      Returns the project id.
      boolean isIncludeRelated()
      Checks if to include related resources.
      boolean isIncludeSiblings()
      Checks if to include siblings.
      void setIncludeRelated​(boolean includeRelated)
      Sets the flag to include related resources.
      void setIncludeSiblings​(boolean includeSiblings)
      Sets the flag to include siblings.
      void setParameters​(java.util.Map<java.lang.String,​java.lang.String> params)
      Sets the additional publish parameters.
      void setProjectId​(CmsUUID projectId)
      Sets the id of the project to publish.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • CmsPublishOptions

        public CmsPublishOptions​(boolean includeRelated,
                         boolean includeSiblings,
                         CmsUUID projectId)
        Creates a new publish options bean.

        Parameters:
        includeRelated - Flag to include related resources
        includeSiblings - Flag to include siblings
        projectId - The id of the project to publish

      • CmsPublishOptions

        public CmsPublishOptions​(java.util.Map<java.lang.String,​java.lang.String> params)
        Creates a new instance.

        Parameters:
        params - the additional publish parameters

    • Method Detail

      • getParameters

        public java.util.Map<java.lang.String,​java.lang.String> getParameters()
        Gets the additional publish parameters.

        Returns:
        the additional publish parameters

      • isIncludeRelated

        public boolean isIncludeRelated()
        Checks if to include related resources.

        Returns:
        true if to include related resources

      • isIncludeSiblings

        public boolean isIncludeSiblings()
        Checks if to include siblings.

        Returns:
        true if to include siblings

      • setIncludeRelated

        public void setIncludeRelated​(boolean includeRelated)
        Sets the flag to include related resources.

        Parameters:
        includeRelated - the flag to set

      • setIncludeSiblings

        public void setIncludeSiblings​(boolean includeSiblings)
        Sets the flag to include siblings.

        Parameters:
        includeSiblings - the flag to set

      • setParameters

        public void setParameters​(java.util.Map<java.lang.String,​java.lang.String> params)
        Sets the additional publish parameters.

        Parameters:
        params - the additional parameters to set

      • setProjectId

        public void setProjectId​(CmsUUID projectId)
        Sets the id of the project to publish.

        Parameters:
        projectId - the id to set