|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Snapshot
Method Summary | |
---|---|
void |
checkIsNotFixed()
Throws an exception is the snapshot is fixed. |
Branch |
getBranch()
|
VersionByResourceMap |
getCreatedVersions()
|
VersionByResourceMap |
getEffectiveVersions()
Returns a copy of the effective versions map. |
VersionByResourceMap |
getExcludedVersions()
Returns a copy of the excluded versions map. |
Snapshot |
getNext()
Returns the snapshot that follows this one on the branch, if any. |
Snapshot |
getPrevious()
Returns the previous snapshot on the snapshot's branch, if any. |
Version |
getVersion(Resource res)
Given a resource, returns the version of that resource that has been created on or is effective on the snapshot. |
Version |
getVersionById(java.lang.String verKey)
|
VersionMap |
getVersionsByPropertyValue(java.lang.String propertyName,
java.lang.Object testValue)
Returns the set of versions that exhibit the specified value for the specified property. |
VersionByResourceMap |
getVersionsByResource()
|
long |
getVisibleVersionCount()
Returns the number of versions that are visible on the snapshot. |
VersionByResourceMap |
getVisibleVersions()
Returns a map of the versions visible on this snapshot. |
void |
initialize(MutableSnapshot baseSnapshot,
java.lang.String objId,
java.util.Date commitTime)
Initialize a mutable or immutable snapshot using an existing snapshot as the base. |
boolean |
isFixed()
If true, indicates that the snapshot is fixed and committed to the repository. |
boolean |
resourceIsVisible(Resource res)
|
Snapshot |
setNext(Snapshot nextSnapshot)
|
boolean |
versionIsVisible(java.lang.String versionId)
Returns true if the specified version is visible on the snapshot, meaning that it is a created or effective version. |
boolean |
versionIsVisible(Version ver)
Returns true if the specified version is visible on the snapshot, meaning that it is a created or effective version. |
Methods inherited from interface org.xiruss.snapcm.api.RepositoryObject |
---|
accept, compareTo, getId, getName, getProperties, getProperty, getPropertyNames, getRepository, getType, hasProperty, initialize, isNull, setId, setName, setProperty, toString |
Method Detail |
---|
void initialize(MutableSnapshot baseSnapshot, java.lang.String objId, java.util.Date commitTime) throws ObjectMutationException
baseSnapshot
- Snapshot to use as the initialization source.objId
- Object ID of the newly-created snapshot.commitTime
-
ObjectMutationException
Snapshot getPrevious()
Version getVersion(Resource res)
cd1Res
-
void checkIsNotFixed() throws ObjectMutationException
ObjectMutationException
VersionMap getVersionsByPropertyValue(java.lang.String propertyName, java.lang.Object testValue)
propertyName
- The name of the property to check.testValue
- The property value to check for.
VersionByResourceMap getVisibleVersions()
boolean isFixed()
Version getVersionById(java.lang.String verKey)
verKey
- String key for a version
Branch getBranch()
Snapshot getNext()
Snapshot setNext(Snapshot nextSnapshot)
VersionByResourceMap getCreatedVersions()
VersionByResourceMap getEffectiveVersions()
VersionByResourceMap getExcludedVersions()
boolean versionIsVisible(java.lang.String versionId)
versionId
- ID of the version to check for
boolean versionIsVisible(Version ver)
ver
- The version to check for
boolean resourceIsVisible(Resource res)
long getVisibleVersionCount()
VersionByResourceMap getVersionsByResource()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |