atg.versionmanager

Interface DevelopmentLine

All Superinterfaces:

ManagedElement

All Known Subinterfaces:

Branch, Snapshot, Workspace

public interface DevelopmentLine
extends ManagedElement

A DevelopmentLine is a set of versions, with one from each included asset. Usually called a "Line of Development" or "codeline" in other version management systems. A Line is one of:

• Branch, a shared line of development
• Workspace, working set of versions and revisions
• Snapshot, archive of a consistent set of versions

The current version selected from each asset is known as the head version.

There is a main branch which is not derived from any previous branch. All subsequent branches are ultimately derived from the main branch. Snapshots can include asset versions from different development lines. All workspaces must be derived from a branch or another workspace.

DevelopmentLines are created and managed by the version manager. A line has an identifier that is unique across all development lines in the version manager.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
java.util.Set	getAllAssetVersions() Find the complete set of asset versions for this development line.
java.util.Set	getAllAssetVersions(int whichOnes)
java.util.Set	getAllAssetVersions(int whichOnes, atg.versionmanager.impl.VersionContainerIncludeChecker containerIncludeChecker, boolean preLoadStatus)
java.util.Set	getAllAssetVersions(atg.versionmanager.impl.VersionContainerIncludeChecker containerIncludeChecker)
int	getAllAssetVersionsCount()
Asset	getAsset(VersionManagerURI id) Look-up a asset by id, but only if it exists in this development line.
java.util.Set	getAssets() The set of assets that this development line contains.
java.util.Set	getAssets(int whichOnes)
AssetVersion	getAssetVersion(Asset asset) Gets the version of the given asset that is the head for this development line.
java.util.Collection	getChildLines() A development line can have derived (child) lines.
int	getCountOfChildLines() The number of development lines derived from this one.
java.util.Set	getCurrentAssetVersions() Find the complete set of current versions for this development line.
java.util.Set	getCurrentAssetVersions(int whichOnes)
java.util.Set	getCurrentAssetVersions(int whichOnes, atg.versionmanager.impl.VersionContainerIncludeChecker containerIncludeChecker)
java.util.Set	getCurrentAssetVersions(atg.versionmanager.impl.VersionContainerIncludeChecker containerIncludeChecker)
int	getCurrentAssetVersionsCount() The count of current versions in this layer.
long	getDateCreated() Date that the development line was created.
java.util.Set	getDeletedAssetVersions() Get all the deleted versions for this layer.
java.util.Set	getDeletedAssetVersions(int whichOnes)
java.util.Set	getDeletedAssetVersions(int whichOnes, atg.versionmanager.impl.VersionContainerIncludeChecker containerIncludeChecker)
java.util.Set	getDeletedAssetVersions(atg.versionmanager.impl.VersionContainerIncludeChecker containerIncludeChecker)
int	getDeletedAssetVersionsCount()
java.lang.String	getID() Returns the unique ID of this development line.
Branch	getParentBranch() Returns the branch that was used as the parent when creating this development line.
DevelopmentLine	getParentLine() Returns the development that was used as the parent when creating this development line.

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

getID

java.lang.String getID()

Returns the unique ID of this development line. This is guaranteed to be unique for all development lines of any type.

Returns:

getDateCreated

long getDateCreated()

Date that the development line was created.

Returns:

the date created.

getParentBranch

Branch getParentBranch()
                throws VersionException

Returns the branch that was used as the parent when creating this development line. The parent branch will be null for the main branch.

Returns:

the parent branch, or null for "main"

Throws:

VersionException

getParentLine

DevelopmentLine getParentLine()
                       throws VersionException

Returns the development that was used as the parent when creating this development line. The parent line will be null for the main branch. This can be snapshot for a branch. If you wish to see the parent branch use getParentBranch. Most applications won't need this method.

Returns:

the parent DevelopmentLine or null for "main"

Throws:

VersionException

getChildLines

java.util.Collection getChildLines()

A development line can have derived (child) lines. These are the immediate child lines of this line. Workspaces have no children.

Returns:

Collection of DevelopmentLines. Empty if a workspace.

getCountOfChildLines

int getCountOfChildLines()

The number of development lines derived from this one.

Returns:

the number of child development lines

getAsset

Asset getAsset(VersionManagerURI id)
        throws VersionException

Look-up a asset by id, but only if it exists in this development line. If the head version is deleted, and the current version is null, the return value for this method will also be null.

Parameters:

id - history identifier

Returns:

Asset, or null if it does not exist for this development line

Throws:

VersionException

getAssets

java.util.Set getAssets()
                 throws VersionException

The set of assets that this development line contains. Assets will not be included if they have been deleted from this development line.

Returns:

iterator of VersionHistory

Throws:

VersionException

getAssets

java.util.Set getAssets(int whichOnes)
                 throws VersionException

Throws:

VersionException

getCurrentAssetVersions

java.util.Set getCurrentAssetVersions()
                               throws VersionException

Find the complete set of current versions for this development line. Development lines have a set of current versions, no more than one for each asset. Current versions do not include deleted versions. If you want current and deleted versions,

Returns:

immutable Set of AssetVersions

Throws:

VersionException

See Also:

getAllAssetVersions(), getDeletedAssetVersions()

getCurrentAssetVersions

java.util.Set getCurrentAssetVersions(int whichOnes)
                               throws VersionException

Throws:

VersionException

getCurrentAssetVersions

java.util.Set getCurrentAssetVersions(atg.versionmanager.impl.VersionContainerIncludeChecker containerIncludeChecker)
                               throws VersionException

Throws:

VersionException

getCurrentAssetVersions

java.util.Set getCurrentAssetVersions(int whichOnes,
                                      atg.versionmanager.impl.VersionContainerIncludeChecker containerIncludeChecker)
                               throws VersionException

Throws:

VersionException

getCurrentAssetVersionsCount

int getCurrentAssetVersionsCount()

The count of current versions in this layer.

Returns:

number of versions in the container for this layer

getAllAssetVersions

java.util.Set getAllAssetVersions()
                           throws VersionException

Find the complete set of asset versions for this development line. This call will return both current and deleted versions.

Returns:

immutable Set of AssetVersions

Throws:

VersionException

See Also:

getCurrentAssetVersions(), getDeletedAssetVersions()

getAllAssetVersions

java.util.Set getAllAssetVersions(int whichOnes)
                           throws VersionException

Throws:

VersionException

getAllAssetVersions

java.util.Set getAllAssetVersions(atg.versionmanager.impl.VersionContainerIncludeChecker containerIncludeChecker)
                           throws VersionException

Throws:

VersionException

getAllAssetVersions

java.util.Set getAllAssetVersions(int whichOnes,
                                  atg.versionmanager.impl.VersionContainerIncludeChecker containerIncludeChecker,
                                  boolean preLoadStatus)
                           throws VersionException

Throws:

VersionException

getAllAssetVersionsCount

int getAllAssetVersionsCount()

getAssetVersion

AssetVersion getAssetVersion(Asset asset)
                      throws VersionException

Gets the version of the given asset that is the head for this development line.

Returns:

true if the version is live

Throws:

VersionException

getDeletedAssetVersions

java.util.Set getDeletedAssetVersions()
                               throws VersionException

Get all the deleted versions for this layer. If the layer is a workspace, this means all the checked-in versions, not the checked-out working versions.

Returns:

Iterator of Version

Throws:

VersionException

See Also:

getCurrentAssetVersions(), getAllAssetVersions()

getDeletedAssetVersions

java.util.Set getDeletedAssetVersions(int whichOnes)
                               throws VersionException

Throws:

VersionException

getDeletedAssetVersions

java.util.Set getDeletedAssetVersions(atg.versionmanager.impl.VersionContainerIncludeChecker containerIncludeChecker)
                               throws VersionException

Throws:

VersionException

getDeletedAssetVersions

java.util.Set getDeletedAssetVersions(int whichOnes,
                                      atg.versionmanager.impl.VersionContainerIncludeChecker containerIncludeChecker)
                               throws VersionException

Throws:

VersionException

getDeletedAssetVersionsCount

int getDeletedAssetVersionsCount()