atg.versionmanager

Interface Asset

All Superinterfaces:

ManagedElement

public interface Asset
extends ManagedElement

Represents the items under control of the version management system.

Field Summary

Fields

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

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List	getAllVersions() Returns all versions for this asset.
AssetVersion	getInitialVersion() Returns the first version of the asset that was imported or checked in.
AssetVersion	getInitialVersion(Branch branch) Returns the first version of an asset on a given branch.
AssetVersion	getMainVersion() Convenience method to get current version on main.
AssetVersion	getVersion(DevelopmentLine line) Gets the latest version of this asset in the given development line.
AssetVersion	getVersion(java.lang.String id) Look-up a version by local revision id.
int	getVersionCount() Get the number of versions in the history.
WorkingVersion	getWorkingVersion(VersionManagerURI workspaceURI) Get the checked-out working version for the given workspace.
WorkingVersion	getWorkingVersion(Workspace workspace) Get the checked-out working version for the given workspace.
boolean	isDeleted(DevelopmentLine codeline) Has this asset has been deleted in the given code line?
boolean	isLive(DevelopmentLine codeline) Returns true for everything except WorkingVersions since this type of version does not automatically change when other users check in new head revisions.
boolean	isLocked() Has this asset has been locked for deployment?
Workspace	lockedBy() Get the workspace that has this asset locked.

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

getVersion

AssetVersion getVersion(DevelopmentLine line)
                        throws VersionException

Gets the latest version of this asset in the given development line. Returns null if the asset is unversioned.

Returns:

Version

Throws:

VersionException

getMainVersion

AssetVersion getMainVersion()
                            throws VersionException

Convenience method to get current version on main.

Returns:

AssetVersion current version on main

Throws:

VersionException

getWorkingVersion

WorkingVersion getWorkingVersion(Workspace workspace)
                                 throws VersionException

Get the checked-out working version for the given workspace. Returns null if this asset has not previously been checked out into this workspace.

Parameters:

workspace - to be searched for check-out

Returns:

working version for this asset, or null if it is not checked-out

Throws:

VersionException

getWorkingVersion

WorkingVersion getWorkingVersion(VersionManagerURI workspaceURI)
                                 throws VersionException

Get the checked-out working version for the given workspace. Returns null if this asset has not previously been checked out into this workspace.

Parameters:

workspaceURI -

Returns:

Throws:

VersionException

getAllVersions

java.util.List getAllVersions()
                              throws VersionException

Returns all versions for this asset. Gets an unmodifiable list containing references to all of the different versions of this asset that the version manager contains.

Returns:

List of AssetVersion

Throws:

VersionException

getVersionCount

int getVersionCount()

Get the number of versions in the history.

Returns:

the number of versions

getVersion

AssetVersion getVersion(java.lang.String id)
                        throws VersionException

Look-up a version by local revision id.

Parameters:

id - local version identifier

Returns:

version with that id, or null

Throws:

VersionException

getInitialVersion

AssetVersion getInitialVersion()
                               throws VersionException

Returns the first version of the asset that was imported or checked in.

Returns:

the initial version, never null

Throws:

VersionException

getInitialVersion

AssetVersion getInitialVersion(Branch branch)
                               throws VersionException

Returns the first version of an asset on a given branch.

Parameters:

branch -

Returns:

Throws:

VersionException

isLive

boolean isLive(DevelopmentLine codeline)
               throws VersionException

Returns true for everything except WorkingVersions since this type of version does not automatically change when other users check in new head revisions.

Returns:

true if the version is live

Throws:

VersionException

isDeleted

boolean isDeleted(DevelopmentLine codeline)
                  throws VersionException

Has this asset has been deleted in the given code line?

Returns:

true if the version is deleted

Throws:

VersionException

isLocked

boolean isLocked()
                 throws VersionException

Has this asset has been locked for deployment?

Returns:

true if the version is locked

Throws:

VersionException

lockedBy

Workspace lockedBy()
                   throws VersionException

Get the workspace that has this asset locked.

Returns:

Workspace that has locked this asset or null if not locked.

Throws:

VersionException