Class GomMediaStoreRemoteProjectEntry
java.lang.Object
de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomElement
de.espirit.firstspirit.access.store.templatestore.gom.GomMediaStoreRemoteProjectEntry
- All Implemented Interfaces:
GomCheckable
,GomElement
,GomProjectEntry
,GomRemoteProjectProviding
,GomSingleProjectEntry
,Serializable
@NonExtendable
public class GomMediaStoreRemoteProjectEntry
extends AbstractGomElement
implements GomSingleProjectEntry, GomCheckable, GomRemoteProjectProviding
Entry defining a remote project restricted to mediastore use
- Since:
- 4.2.5
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface de.espirit.firstspirit.access.store.templatestore.gom.GomCheckable
GomCheckable.Context
-
Field Summary
FieldsFields inherited from interface de.espirit.firstspirit.access.store.templatestore.gom.GomSingleProjectEntry
LOCAL_NAME
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGet a constraint representation of this entry.boolean
Convenience API forgetAutoReleaseAfterUpload()
returning a boolean valueboolean
Indicates if uploaded media is released automaticallyprotected String
Return the default tag for a gom element.getName()
The name of this entry.@Nullable String
The name of a remote project configuration the uid references points to.Restrict access to specific folders (including sub-folders)Get the upload folder to be used for this project.int
hashCode()
boolean
isLocal()
Indicates the local project.static @NotNull GomMediaStoreRemoteProjectEntry
Creates a new instance with the specified remote namevoid
setAutoReleaseAfterUpload
(YesNo autoRelease) Sets if uploaded media is released automaticallyvoid
Sets the symbolic name of the remote projectvoid
setUploadFolder
(String uploadFolder) Set the upload folder for this project.void
validate
(GomCheckable.Context context) Validate the element against the given context.void
verify()
Verify the element to be fulfill its syntactic constraints.Methods inherited from class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomElement
getGomElementTag, getIncludeConfiguration, hasRepresentation, setGomElementTag, setIncludeConfiguration
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface de.espirit.firstspirit.access.store.templatestore.gom.GomElement
getGomElementTag, getIncludeConfiguration, hasRepresentation, setGomElementTag, setIncludeConfiguration
-
Field Details
-
TAG
The tag of this component- Since:
- 4.2.5
- See Also:
-
-
Constructor Details
-
GomMediaStoreRemoteProjectEntry
public GomMediaStoreRemoteProjectEntry()
-
-
Method Details
-
on
Creates a new instance with the specified remote name- Parameters:
remote
- the remote project name- Returns:
- a new instance, never
null
- Since:
- 4.2.5
-
getDefaultTag
Description copied from class:AbstractGomElement
Return the default tag for a gom element.- Specified by:
getDefaultTag
in classAbstractGomElement
- Returns:
- The elements default tag.
-
getName
Description copied from interface:GomSingleProjectEntry
The name of this entry.- Specified by:
getName
in interfaceGomSingleProjectEntry
- Returns:
- The name of the project.
-
setName
Sets the symbolic name of the remote project- Since:
- 4.2.5
-
getRemoteProjectName
Description copied from interface:GomRemoteProjectProviding
The name of a remote project configuration the uid references points to.- Specified by:
getRemoteProjectName
in interfaceGomRemoteProjectProviding
- Returns:
- The associated remote project configuration name, or
null
for the local project.
-
getUploadFolder
Description copied from interface:GomSingleProjectEntry
Get the upload folder to be used for this project.- Specified by:
getUploadFolder
in interfaceGomSingleProjectEntry
- Returns:
- The name of the upload folder.
-
setUploadFolder
Description copied from interface:GomSingleProjectEntry
Set the upload folder for this project.- Specified by:
setUploadFolder
in interfaceGomSingleProjectEntry
- Parameters:
uploadFolder
- The name of the upload folder.
-
getAutoReleaseAfterUpload
Indicates if uploaded media is released automatically- Since:
- 4.2.9
-
setAutoReleaseAfterUpload
Sets if uploaded media is released automatically- Since:
- 4.2.9
-
getSources
Restrict access to specific folders (including sub-folders)- Since:
- 4.2.9
-
asConstraint
Description copied from interface:GomProjectEntry
Get a constraint representation of this entry.- Specified by:
asConstraint
in interfaceGomProjectEntry
- Returns:
- The entry's constraint representation.
-
equals
-
hashCode
public int hashCode() -
isLocal
public boolean isLocal()Description copied from interface:GomSingleProjectEntry
Indicates the local project.- Specified by:
isLocal
in interfaceGomSingleProjectEntry
- Returns:
true
iff this entry represents the local project.
-
autoReleaseAfterUpload
public boolean autoReleaseAfterUpload()Convenience API forgetAutoReleaseAfterUpload()
returning a boolean value- Since:
- 4.2.9
-
verify
Description copied from interface:GomCheckable
Verify the element to be fulfill its syntactic constraints.- Specified by:
verify
in interfaceGomCheckable
- Throws:
IllegalStateException
- If the element is not correctly set up.
-
validate
Description copied from interface:GomCheckable
Validate the element against the given context.- Specified by:
validate
in interfaceGomCheckable
- Parameters:
context
- The context to validate for, must not benull
.- Throws:
GomValidationError
- If the element is not plausible wrt. its context.
-