Package org.opencms.ade.configuration

Class CmsContentFolderOption

java.lang.Object
org.opencms.ade.configuration.CmsContentFolderOption
public class CmsContentFolderOption extends Object
Simple immutable class for storing a custom content folder configuration.

There are two possibilities: Either a custom content folder should be used (then the corresponding instance of this class stores the folder id), or the default content folder should be used (in which case the folder id is null).

  • Constructor Details

    • CmsContentFolderOption

      public CmsContentFolderOption(CmsUUID contentFolderId)
      Creates a new instance.
      Parameters:
      contentFolderId - the content folder id

  • Method Details

    • getFolderId

      public CmsUUID getFolderId()
      Gets the content folder id.

      The result may be null.

      Returns:
      the content folder id

    • isDefault

      public boolean isDefault()
      Returns true if this represents the option to use the standard content folder.

      This is currently implemented as the folder id being null.

      Returns:
      true if the default content folder should be used