public interface ConfigurationSetManager
ConfigurationSets
which includes retrieval, creation, updating and managing the states of
ConfigurationSets. Configuration sets are identified by their
name which is therefore system-wide unique.
If the provided entity (or its identifying attributes) of a method does not
exist, an UnknownEntityException will be thrown.
| Modifier and Type | Method and Description |
|---|---|
java.util.List<CSReference> |
getCSReferenceRevisions(SessionToken session,
java.lang.String csName)
Gets lightweight objects representing all revisions of the designated
configuration set, an empty list in case there are no revisions yet.
|
RemoteIterator<java.util.List<CSReference>> |
getCSReferenceRevisionsIterator(SessionToken session,
java.lang.String csName)
The same as
getCSReferenceRevisions(SessionToken, String) but with
partial retrieval of the references. |
java.util.Collection<CSReference> |
getCSReferencesRevision(SessionToken session,
long revision)
Gets lightweight objects representing all configuration sets of the
designated revision known by this manager.
|
RemoteIterator<java.util.List<CSReference>> |
getCSReferencesRevisionIterator(SessionToken session,
long revision)
The same as
getCSReferencesRevision(SessionToken, long) but with
partial retrieval of the references. |
ConfigurationSet |
getCSRevision(SessionToken session,
java.lang.String csName,
long revision)
Gets the (full-fledged object representing the) designated revision of the
designated configuration set.
|
ConfigurationSet |
getDevelopmentCS(SessionToken session,
java.lang.String csName,
long branch)
Gets the (full-fledged object representing the) development version of the
designated configuration set in the designated branch.
|
java.util.Collection<CSReference> |
getDevelopmentCSReferences(SessionToken session,
long branch)
Gets lightweight objects representing the development versions of all
configuration sets in the designated branch known by this manager.
|
RemoteIterator<java.util.List<CSReference>> |
getDevelopmentCSReferencesIterator(SessionToken session,
long branch)
The same as
getCSRevision(SessionToken, String, long) but with
partial retrieval of the references. |
ConfigurationSet |
getLatestCS(SessionToken session,
java.lang.String csName)
Gets the (full-fledged object representing the) latest revision of the
designated configuration set.
|
CSReference |
getLatestCSReference(SessionToken session,
java.lang.String csName)
Gets a lightweight object representing the latest revision of the
designated configuration set.
|
java.util.Collection<CSReference> |
getLatestCSReferences(SessionToken session,
boolean productionOnly)
Gets lightweight objects representing the latest revisions (
IN_PRODUCTION and/or OUTDATED) of all
configuration sets known by this manager. |
RemoteIterator<java.util.List<CSReference>> |
getLatestCSReferencesIterator(SessionToken session,
boolean productionOnly)
The same as
getLatestCSReferences(SessionToken, boolean) but with
partial retrieval of the references. |
void |
outdateCS(SessionToken session,
java.lang.String csName)
Outdates the latest revision of the designated configuration set explicitly
which prevents its usage afterwards.
|
void |
revertDevelopmentCS(SessionToken session,
java.lang.String csName,
long branch)
Reverts the designated development configuration set in the designated
branch that is all changes will be undone and the configuration set will
logically be the same as the base revision of the branch.
|
CheckReport |
simulateUpdateOfDevelopmentCS(SessionToken session,
java.lang.String csName,
long branch)
Simulates updating of the designated configuration set in the designated
branch, that is only the designated configuration set of the branch is
checked for whether it can be updated to the latest revision.
|
void |
storeDevelopmentCS(SessionToken session,
StorageConfigurationSet cs,
long branch)
Stores the designated (storage representation of the) configuration set in
the designated branch and sets it
IN_DEVELOPMENT if not done
yet. |
java.util.Collection<CSReference> getLatestCSReferences(SessionToken session, boolean productionOnly)
IN_PRODUCTION and/or OUTDATED) of all
configuration sets known by this manager.session - The session which is used to check for access rights on this
method.productionOnly - Whether only the revisions
IN_PRODUCTCION should be retrieved.IN_PRODUCTION and/or
OUTDATED known by this manager.RemoteIterator<java.util.List<CSReference>> getLatestCSReferencesIterator(SessionToken session, boolean productionOnly)
getLatestCSReferences(SessionToken, boolean) but with
partial retrieval of the references.session - The session which is used to check for access rights on this
method.productionOnly - Whether only the revisions
IN_PRODUCTCION should be retrieved.IN_PRODUCTION and/or
OUTDATED known by this manager as iterator.java.util.Collection<CSReference> getCSReferencesRevision(SessionToken session, long revision)
IN_PRODUCTION or OUTDATED depending on whether
they have been changed or set to outdated from the designated to the latest
revision.session - The session which is used to check for access rights on this
method.revision - The revision of which to retrieve all configuration sets
known by this manager.RemoteIterator<java.util.List<CSReference>> getCSReferencesRevisionIterator(SessionToken session, long revision)
getCSReferencesRevision(SessionToken, long) but with
partial retrieval of the references.session - The session which is used to check for access rights on this
method.revision - The revision of which to retrieve all configuration sets
known by this manager.CSReference getLatestCSReference(SessionToken session, java.lang.String csName)
session - The session which is used to check for access rights on this
method.csName - The name of the configuration set of which to retrieve a
lightweight representation.UnknownEntityException - If the
designated configuration set does not exist, an
UnknownEntityException will be thrown.java.util.List<CSReference> getCSReferenceRevisions(SessionToken session, java.lang.String csName)
session - The session which is used to check for access rights on this
method.csName - The name of the configuration set of which to retrieve all
revisions as lightweight representation.UnknownEntityException - If the
designated configuration set does not exist, an
UnknownEntityException will be thrown.RemoteIterator<java.util.List<CSReference>> getCSReferenceRevisionsIterator(SessionToken session, java.lang.String csName)
getCSReferenceRevisions(SessionToken, String) but with
partial retrieval of the references.session - The session which is used to check for access rights on this
method.csName - The name of the configuration set of which to retrieve all
revisions as lightweight representation.UnknownEntityException - If the
designated configuration set does not exist, an
UnknownEntityException will be thrown.ConfigurationSet getLatestCS(SessionToken session, java.lang.String csName)
session - The session which is used to check for access rights on this
method.csName - The name of the configuration set of which to retrieve the
latest revision.UnknownEntityException - If the
designated configuration set does not exist, an
UnknownEntityException will be thrown.ConfigurationSet getCSRevision(SessionToken session, java.lang.String csName, long revision)
session - The session which is used to check for access rights on this
method.csName - The name of the configuration set of which to retrieve a
specific revision.revision - The revision of the configuration set which to retrieve.UnknownEntityException - If the
designated configuration set or the revision does not exist, an
UnknownEntityException will be thrown.java.util.Collection<CSReference> getDevelopmentCSReferences(SessionToken session, long branch)
IN_DEVELOPMENT (changed entities),
IN_PRODUCTION (unchanged entities whereas the base revision is
the latest revision) or OUTDATED (unchanged entities).session - The session which is used to check for access rights on this
method.branch - The branch of which to retrieve lightweight objects for the
configuration sets.UnknownEntityException - If the
designated branch is currently unused, an
UnknownEntityException will be thrown.RemoteIterator<java.util.List<CSReference>> getDevelopmentCSReferencesIterator(SessionToken session, long branch)
getCSRevision(SessionToken, String, long) but with
partial retrieval of the references.session - The session which is used to check for access rights on this
method.branch - The branch of which to retrieve lightweight objects for the
configuration sets.UnknownEntityException - If the
designated branch is currently unused, an
UnknownEntityException will be thrown.ConfigurationSet getDevelopmentCS(SessionToken session, java.lang.String csName, long branch)
IN_DEVELOPMENT if it has already been changed with
respect to its base revision. Otherwise the entity will a copy of the base
revision of the branch and therefore IN_PRODUCTION (in case
the base revision is the latest revision) or OUTDATED (in case
the base revision is already outdated). This copy will be set
IN_DEVELOPMENT as soon as it is
stored
the first time.session - The session which is used to check for access rights on this
method.csName - The name of the configuration set of which to retrieve the
development version of the designated branch.branch - The branch of which to retrieve the corresponding
configuration set (or a new copy of the corresponding base
revision entity in case it has not been changed before in this
branch).UnknownEntityException - If the
designated configuration set does not exist or the designated
branch is currently unused, an
UnknownEntityException will be thrown.void storeDevelopmentCS(SessionToken session, StorageConfigurationSet cs, long branch)
IN_DEVELOPMENT if not done
yet. All changes are therefore persisted. The branch is usually the same as
specified when retrieving the configuration set for development. However, it can be
changed but the content of the target branch will be overwritten. This can
be used to copy changes between branches.
When storing a configuration set, the
IDs of all corresponding ActivityTemplateDefinitions will be
changed.
session - The session which is used to check for access rights on this
method and to identify the storing agent and the corresponding
organisational position.cs - The configuration set providing the new attributes to be set.
Configuration sets are identified by their name, therefore the
name will not be able to be changed if there is at least one
production revision.branch - The branch in which to store the corresponding configuration
set.UnknownEntityException - If the designated
branch is currently unused, an
UnknownEntityException will be thrown.void revertDevelopmentCS(SessionToken session, java.lang.String csName, long branch)
session - The session which is used to check for access rights on this
method.csName - The name of the configuration set of which to delete the
development version in the designated branch.branch - The branch in which to revert the designated configuration
set and therefore undoing made changes.UnknownEntityException - If the
designated configuration set does not exist in the designated
branch or does not exist at all or the designated branch is
currently unused, an UnknownEntityException will
be thrown.CheckReport simulateUpdateOfDevelopmentCS(SessionToken session, java.lang.String csName, long branch)
session - The session which is used to check for access rights on this
method.csName - The name of the configuration set which to check for
versioning conflicts due to updating to the latest revision.branch - The branch in which to check the designated configuration set
for versioning conflicts when updating.UnknownEntityException - If the
designated configuration set does not exist in the designated
branch or does not exist at all, an
UnknownEntityException will be thrown.void outdateCS(SessionToken session, java.lang.String csName)
OUTDATED configuration set will be ignored.session - The session which is used to check for access rights on this
method and to identify the outdating agent and the corresponding
organisational position.csName - The name of the configuration set of which to explicitly
outdate the latest revision.UnknownEntityException - If the
designated configuration set does not exist, an
UnknownEntityException will be thrown.