atg.versionmanager

Interface Snapshot

All Superinterfaces:

DevelopmentLine, ManagedElement

public interface Snapshot
extends DevelopmentLine

A development line holding a fixed set of versions. Also commonly called a "Configuration" in other CM systems. Typically used as a permanent record of the state of a set of version controlled resources, at a particular time.

Snapshots are development lines. A snapshot may be created from another snapshot. A snapshot cannot be created from a workspace since the assets in the workspace may still be changed.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION

Method Summary

Methods

Modifier and Type	Method and Description
SnapshotDiff	createSnapshotDiff(Snapshot otherSnapshot) Compare the two Snapshots and return the differences
SnapshotDiff	createSnapshotDiff(Snapshot baseline2, atg.versionmanager.impl.VersionContainerIncludeChecker containerIncludeChecker) Create a diff using the supplied VersionContainerIncludeChecker to exclude certain containers from the diff.
AssetVersion	getVersionRenamed(AssetVersion pVersion) Check a version of a file asset has a different name then the version of the asset in this snapshot.

Methods inherited from interface atg.versionmanager.DevelopmentLine

getAllAssetVersions, getAllAssetVersions, getAllAssetVersions, getAllAssetVersions, getAllAssetVersionsCount, getAsset, getAssets, getAssets, getAssetVersion, getChildLines, getCountOfChildLines, getCurrentAssetVersions, getCurrentAssetVersions, getCurrentAssetVersions, getCurrentAssetVersions, getCurrentAssetVersionsCount, getDateCreated, getDeletedAssetVersions, getDeletedAssetVersions, getDeletedAssetVersions, getDeletedAssetVersions, getDeletedAssetVersionsCount, getID, getParentBranch, getParentLine

Methods inherited from interface atg.versionmanager.ManagedElement

getDisplayName, getName, getURI, getVersionManager

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

See Also:

Constant Field Values

Method Detail

createSnapshotDiff

SnapshotDiff createSnapshotDiff(Snapshot otherSnapshot)
                                throws VersionException

Compare the two Snapshots and return the differences

Parameters:

otherBaseline - the baseline to diff this one against.

Returns:

SnapshotDiff

Throws:

VersionException

See Also:

SnapshotDiff

createSnapshotDiff

SnapshotDiff createSnapshotDiff(Snapshot baseline2,
                              atg.versionmanager.impl.VersionContainerIncludeChecker containerIncludeChecker)
                                throws VersionException

Create a diff using the supplied VersionContainerIncludeChecker to exclude certain containers from the diff.

Parameters:

baseline2 -

containerIncludeChecker -

Returns:

Throws:

VersionException

getVersionRenamed

AssetVersion getVersionRenamed(AssetVersion pVersion)
                               throws VersionException

Check a version of a file asset has a different name then the version of the asset in this snapshot. The name is considered different if the name or the parent folder has changed.

Parameters:

pVersion - AssetVersion representing the later version of the asset.

Returns:

AssetVersion representing this snapshot's version if the asset has been renamed, null otherwise.

Throws:

VersionException - thrown if (1) this snapshot doesn't contain a version of the asset or (3) this is not a file asset.