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

Class GomStorableRemoteProjectEntry

java.lang.Object
de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomElement
de.espirit.firstspirit.access.store.templatestore.gom.GomStorableRemoteProjectEntry
All Implemented Interfaces:
GomCheckable, GomElement, GomProjectEntry, GomRemoteProjectProviding, GomSingleProjectEntry, Serializable
@NonExtendable public class GomStorableRemoteProjectEntry extends AbstractGomElement implements GomSingleProjectEntry, GomCheckable, GomRemoteProjectProviding
GOM representation of a storable location for a remote project
Since:
4.2.20
See Also:

  • Field Details

  • Constructor Details

    • GomStorableRemoteProjectEntry

      public GomStorableRemoteProjectEntry()

  • Method Details

    • on

      @NotNull public static @NotNull GomStorableRemoteProjectEntry on(String remote)
      Creates a new instance with the specified remote name
      Parameters:
      remote - the remote project name
      Returns:
      the new instance, never null
      Since:
      4.2.20

    • 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.

    • getName

      public String getName()
      Description copied from interface: GomSingleProjectEntry
      The name of this entry.
      Specified by:
      getName in interface GomSingleProjectEntry
      Returns:
      The name of the project.

    • setName

      public void setName(String text)
      The symbolic name of the remote project
      Since:
      4.2.20

    • getRemoteProjectName

      @Nullable public @Nullable String getRemoteProjectName()
      Description copied from interface: GomRemoteProjectProviding
      The name of a remote project configuration the uid references points to.
      Specified by:
      getRemoteProjectName in interface GomRemoteProjectProviding
      Returns:
      The associated remote project configuration name, or null for the local project.

    • getUploadFolder

      public String getUploadFolder()
      Description copied from interface: GomSingleProjectEntry
      Get the upload folder to be used for this project.
      Specified by:
      getUploadFolder in interface GomSingleProjectEntry
      Returns:
      The name of the upload folder.

    • setUploadFolder

      public void setUploadFolder(String uploadFolder)
      Description copied from interface: GomSingleProjectEntry
      Set the upload folder for this project.
      Specified by:
      setUploadFolder in interface GomSingleProjectEntry
      Parameters:
      uploadFolder - The name of the upload folder.

    • getAutoReleaseAfterUpload

      public YesNo getAutoReleaseAfterUpload()
      Indicates if uploaded media is released automatically
      Since:
      4.2.20

    • setAutoReleaseAfterUpload

      public void setAutoReleaseAfterUpload(YesNo autoRelease)
      Sets if uploaded media is released automatically
      Since:
      4.2.20

    • getSources

      public GomStoreFolderList getSources()
      Restrict access to specific folders (including sub-folders and store roots)
      Since:
      4.2.20

    • asConstraint

      public ProjectConstraint asConstraint()
      Description copied from interface: GomProjectEntry
      Get a constraint representation of this entry.
      Specified by:
      asConstraint in interface GomProjectEntry
      Returns:
      The entry's constraint representation.

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • isLocal

      public boolean isLocal()
      Description copied from interface: GomSingleProjectEntry
      Indicates the local project.
      Specified by:
      isLocal in interface GomSingleProjectEntry
      Returns:
      true iff this entry represents the local project.

    • autoReleaseAfterUpload

      public boolean autoReleaseAfterUpload()
      Convenience API for getAutoReleaseAfterUpload() returning a boolean value
      Since:
      4.2.20

    • 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.