|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.xiruss.snapcm.api.NullRepositoryObject org.xiruss.snapcm.api.NullSnapshot
public class NullSnapshot
Constructor Summary | |
---|---|
NullSnapshot()
|
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. |
int |
getType()
|
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. |
void |
initialize(Repository rep,
java.lang.String objId,
java.lang.String name)
Initialize the object with the specified object ID and name. |
boolean |
isFixed()
If true, indicates that the snapshot is fixed and committed to the repository. |
boolean |
resourceIsVisible(Resource res)
|
void |
setId(java.lang.String id)
Sets the ID on a newly-created repository object. |
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 class org.xiruss.snapcm.api.NullRepositoryObject |
---|
accept, compareTo, getId, getName, getProperties, getProperty, getPropertyNames, getRepository, hasProperty, isNull, setName, setProperty |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.xiruss.snapcm.api.RepositoryObject |
---|
accept, compareTo, getId, getName, getProperties, getProperty, getPropertyNames, getRepository, hasProperty, isNull, setName, setProperty, toString |
Constructor Detail |
---|
public NullSnapshot()
Method Detail |
---|
public Snapshot setNext(Snapshot nextSnapshot)
setNext
in interface Snapshot
public Snapshot getPrevious()
Snapshot
getPrevious
in interface Snapshot
public Version getVersion(Resource res)
Snapshot
getVersion
in interface Snapshot
public void checkIsNotFixed() throws ObjectMutationException
Snapshot
checkIsNotFixed
in interface Snapshot
ObjectMutationException
public VersionMap getVersionsByPropertyValue(java.lang.String propertyName, java.lang.Object testValue)
Snapshot
getVersionsByPropertyValue
in interface Snapshot
propertyName
- The name of the property to check.testValue
- The property value to check for.
public VersionByResourceMap getVisibleVersions()
Snapshot
getVisibleVersions
in interface Snapshot
public boolean isFixed()
Snapshot
isFixed
in interface Snapshot
public Version getVersionById(java.lang.String verKey)
getVersionById
in interface Snapshot
verKey
- String key for a version
public Branch getBranch()
getBranch
in interface Snapshot
public Snapshot getNext()
Snapshot
getNext
in interface Snapshot
public VersionByResourceMap getCreatedVersions()
getCreatedVersions
in interface Snapshot
public VersionByResourceMap getEffectiveVersions()
Snapshot
getEffectiveVersions
in interface Snapshot
public VersionByResourceMap getExcludedVersions()
Snapshot
getExcludedVersions
in interface Snapshot
public boolean versionIsVisible(java.lang.String versionId)
Snapshot
versionIsVisible
in interface Snapshot
versionId
- ID of the version to check for
public boolean versionIsVisible(Version ver)
Snapshot
versionIsVisible
in interface Snapshot
ver
- The version to check for
public boolean resourceIsVisible(Resource res)
resourceIsVisible
in interface Snapshot
public long getVisibleVersionCount()
Snapshot
getVisibleVersionCount
in interface Snapshot
public VersionByResourceMap getVersionsByResource()
getVersionsByResource
in interface Snapshot
public void initialize(Repository rep, java.lang.String objId, java.lang.String name) throws ObjectMutationException
RepositoryObject
initialize
in interface RepositoryObject
initialize
in class NullRepositoryObject
ObjectMutationException
- If object already has an assigned ID, indicating
that is has already been constructed.public void setId(java.lang.String id) throws ObjectMutationException
RepositoryObject
setId
in interface RepositoryObject
setId
in class NullRepositoryObject
id
- Object ID (assigned by the owning repository)
ObjectMutationException
- If object already has an assigned ID, indicating
that is has already been constructed.public int getType()
getType
in interface RepositoryObject
getType
in class NullRepositoryObject
public void initialize(MutableSnapshot baseSnapshot, java.lang.String objId, java.util.Date commitTime) throws ObjectMutationException
Snapshot
initialize
in interface Snapshot
baseSnapshot
- Snapshot to use as the initialization source.objId
- Object ID of the newly-created snapshot.
ObjectMutationException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |