Package de.espirit.firstspirit.access.store.templatestore.gom

Class GomStoreFolder

java.lang.Object
de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomElement
de.espirit.firstspirit.access.store.templatestore.gom.GomStoreFolder
All Implemented Interfaces:
GomCheckable, GomElement, GomUidProviding, GomUidTypeProviding, Serializable
Direct Known Subclasses:
GomSiteOrMediaStoreFolder
@NonExtendable public class GomStoreFolder extends AbstractGomElement implements GomCheckable, GomUidTypeProviding, GomUidProviding
Folder element for store-based folder restrictions
Since:
4.2.9
See Also:

  • Field Details

  • Constructor Details

    • GomStoreFolder

      public GomStoreFolder(String store, String name)
      Creates a new instance with the given store name and folder name
      Parameters:
      store - the name of the store
      name - the name of the folder
      Since:
      4.2.9

  • Method Details

    • getStore

      public String getStore()
      The store name
      Since:
      4.2.9

    • getUid

      public String getUid()
      Description copied from interface: GomUidProviding
      The UID this element holds as a reference.
      Specified by:
      getUid in interface GomUidProviding
      Returns:
      The UID or null.

    • getUidType

      @Nullable public IDProvider.UidType getUidType()
      Description copied from interface: GomUidTypeProviding
      The IDProvider.UidType of the references contained.
      Specified by:
      getUidType in interface GomUidTypeProviding
      Returns:
      The associated uid type.

    • setStore

      public void setStore(String storeName)
      Sets the store name
      Since:
      4.2.9

    • getName

      public String getName()
      The allowed upload folder to set for the defined store name
      Since:
      4.2.9

    • setName

      public void setName(String name)
      Sets the allowed upload folder to set for the defined store name
      Parameters:
      name - the upload folder name
      Since:
      4.2.9

    • getDefaultTag

      protected String getDefaultTag()
      Description copied from class: AbstractGomElement
      Return the default tag for a gom element.
      Specified by:
      getDefaultTag in class AbstractGomElement
      Returns:
      The elements default tag.

    • verify

      public void verify() throws IllegalStateException
      Description copied from interface: GomCheckable
      Verify the element to be fulfill its syntactic constraints.
      Specified by:
      verify in interface GomCheckable
      Throws:
      IllegalStateException - If the element is not correctly set up.

    • validate

      public void validate(GomCheckable.Context context) throws GomValidationError
      Description copied from interface: GomCheckable
      Validate the element against the given context.
      Specified by:
      validate in interface GomCheckable
      Parameters:
      context - The context to validate for, must not be null.
      Throws:
      GomValidationError - If the element is not plausible wrt. its context.

    • getStoreType

      public static Store.Type getStoreType(String store)
      Converts a store name into a Store.Type
      Parameters:
      store - the name of the store
      Returns:
      the matching store type
      Since:
      4.2.9
      See Also:

    • isValidStoreType

      public boolean isValidStoreType()
      Checks if the specified store name is valid.
      Returns:
      true if the store name is valid, false otherwise.
      Since:
      5.2