public interface Workspace extends DevelopmentLine
A workspace creates a new asset and an initial version of that asset when a resource is put under version control.
A new editable working version is created by checking out an existing version, either the current head version of the asset, or some other arbitrary version (e.g. a deleted version that is not normally accessible as the current version). A workspace can only have one checked-out working version for each asset. The rest of the editing cycle is usually invoked through the working version, but the workspace contains some batch utilities for reverting or checking-in all the outstanding working versions.
A workspace can be deleted, if it does not have any any outstanding checked-out working versions. When a workspace is deleted, any references to it become invalid and can no longer be used.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION |
static int |
CONFLICT_SORT_CODE |
static int |
DISPLAY_NAME_SORT_CODE |
static int |
ID_SORT_CODE |
static int |
STATUS_SORT_CODE |
static int |
TYPE_SORT_CODE |
Modifier and Type | Method and Description |
---|---|
void |
addNewAsset(int type,
atg.adapter.version.RepositoryWorkingVersionItem item,
java.lang.String repositoryName,
java.lang.String itemDescriptor,
java.lang.Integer version)
This method is not for use by client code.
|
void |
checkInAll(java.lang.String username,
java.lang.String comment)
Check-in all the checked-out working versions in the workspace.
|
WorkingVersion |
checkOut(Asset asset)
Check-out an asset into this workspace.
|
WorkingVersion |
checkOut(AssetVersion version)
Check-out a specific version into this workspace.
|
WorkingVersion |
checkOut(VersionManagerURI uri)
Check-out a specific version into this workspace.
|
void |
delete()
Delete a workspace.
|
java.util.Collection |
findWorkingReferencesToAsset(AssetVersion assetVersion)
Find working versions in this workspace that reference the given asset.
|
java.util.Set |
getAssetsChanged()
Returns the assets changed by this Workspace.
|
java.util.Set |
getAssetsChanged(int whichOnes) |
java.util.Set |
getAssetsChanged(atg.versionmanager.impl.VersionContainerIncludeChecker containerIncludeChecker) |
long |
getCheckInTime()
Workspaces have a check-in time
|
java.lang.String |
getComment()
Workspaces have a comment.
|
int |
getCountOfOutOfDateVersions()
Get the count of WorkingVersion which are out of date and need resolution.
|
java.util.List<WorkingVersion> |
getFilteredWorkingVersions(int pFilterCode)
Get the working versions for this workspace filtered by the specified
filter code.
|
java.util.Set |
getOutOfDateVersions()
Get the set of WorkingVersion which are out of date and need resolution.
|
java.util.Set |
getPreloadedAssetsChanged(int whichOnes,
boolean filterDeleted,
boolean preloadItems)
Returns the items checked in with this Workspace.
|
java.lang.String |
getUser()
Workspaces have a creator.
|
WorkingVersion |
getWorkingVersion(Asset asset)
Get the currently checked-out working version for an asset in this
workspace.
|
WorkingVersion |
getWorkingVersion(AssetVersion asset) |
WorkingVersion |
getWorkingVersion(VersionManagerURI assetURI) |
java.util.Set |
getWorkingVersions()
Get all the currently checked-out working versions for this workspace.
|
java.util.Set |
getWorkingVersions(java.util.Collection pReps,
java.util.Collection pVFSReps)
Get all the currently checked-out working versions for this workspace for the specified repositories.
|
java.util.List<WorkingVersion> |
getWorkingVersions(int pSortCode)
Get all the currently checked-out working versions for this workspace
sorted by the specified code.
|
boolean |
isCheckedIn()
Returns true if the workspace has had all of its contents checked in.
|
boolean |
isCheckedOut(Asset pAsset)
This method checks to see if the specified asset has been checked out in
the current workspace.
|
boolean |
isCheckedOut(Asset pAsset,
boolean pCheckCache)
This method checks to see if the specified asset has been checked out in
the current workspace.
|
boolean |
isCheckedOut(VersionManagerURI pURI)
This method checks to see if the asset specified by the VersionManagerURI
has been checked out in the current workspace.
|
boolean |
isCheckedOut(VersionManagerURI pURI,
boolean pCheckCache)
This method checks to see if the asset specified by the VersionManagerURI
has been checked out in the current workspace.
|
boolean |
isEditable()
Can assets in this workspace be checked out and those already checked out be modified.
|
boolean |
isLocked()
Are all assets in this workspace locked
|
boolean |
isUpToDate()
Check to see if a resolve() is needed before the versions
can be checked in.
|
boolean |
lockAllAssets()
Lock all assets in this workspace for deployment
|
void |
resetParentVersionForAll()
Reset all working versions' predecessor version to the current
head-of-branch version.
|
int |
resolveAllNonConflicting()
Resolve all out of date assets which are non-conflicting i.e.
|
void |
revert(java.util.Collection pWorkingVersions)
Revert given working versions
|
void |
revert(WorkingVersion version)
Revert changes to the asset that have been made in this workspace.
|
void |
revertAll()
Discard all the working versions in the workspace without saving any
changes.
|
void |
setComment(java.lang.String comment)
Set the comment describing what this workspace is changing.
|
void |
setEditable(boolean pEditable)
Sets a workspace editable or not editable.
|
void |
setEditable(boolean pEditable,
boolean pNewTransaction)
Sets a workspace editable or not editable.
|
void |
unlockAllAssets()
Unlock all assets in this workspace
|
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
getDisplayName, getName, getURI, getVersionManager
static final java.lang.String CLASS_VERSION
static final int TYPE_SORT_CODE
static final int STATUS_SORT_CODE
static final int ID_SORT_CODE
static final int CONFLICT_SORT_CODE
static final int DISPLAY_NAME_SORT_CODE
java.util.Set getWorkingVersions()
java.util.Set getWorkingVersions(java.util.Collection pReps, java.util.Collection pVFSReps)
java.util.List<WorkingVersion> getFilteredWorkingVersions(int pFilterCode)
pSortCode
- Filter code specifying the working versions to be
returned.java.util.List<WorkingVersion> getWorkingVersions(int pSortCode)
pSortCode
- Sort code specifying the order in which the working
versions are to be returned.WorkingVersion getWorkingVersion(Asset asset)
WorkingVersion getWorkingVersion(AssetVersion asset)
WorkingVersion getWorkingVersion(VersionManagerURI assetURI)
WorkingVersion checkOut(Asset asset) throws RepositoryException, VersionException
history
- to check-outRepositoryException
VersionException
WorkingVersion checkOut(AssetVersion version) throws RepositoryException, VersionException
asset
- to check-outRepositoryException
VersionException
WorkingVersion checkOut(VersionManagerURI uri) throws RepositoryException, VersionException
uri
- The uri of the asset to check-outRepositoryException
VersionException
void revertAll() throws VersionException
VersionException
void revert(java.util.Collection pWorkingVersions) throws VersionException
pWorkingVersions
- VersionException
void resetParentVersionForAll() throws VersionException
VersionException
int resolveAllNonConflicting() throws VersionException
VersionException
void checkInAll(java.lang.String username, java.lang.String comment) throws VersionException
comment
- applied to check-insVersionVetoException
- if a checkin is vetoedVersionException
void delete() throws VersionException
VersionException
boolean isCheckedIn()
java.lang.String getComment()
void setComment(java.lang.String comment)
comment
- java.lang.String getUser()
long getCheckInTime()
java.util.Set getAssetsChanged() throws VersionException
VersionException
java.util.Set getAssetsChanged(int whichOnes) throws VersionException
VersionException
java.util.Set getAssetsChanged(atg.versionmanager.impl.VersionContainerIncludeChecker containerIncludeChecker) throws VersionException
VersionException
java.util.Set getPreloadedAssetsChanged(int whichOnes, boolean filterDeleted, boolean preloadItems) throws VersionException
VersionException
void revert(WorkingVersion version) throws VersionException
version
- The asset version to revert.VersionException
boolean lockAllAssets() throws VersionException
VersionException
- thrown if problem creating locksvoid unlockAllAssets() throws VersionException
VersionException
- thrown if problem remove locksboolean isLocked() throws VersionException
VersionException
- thrown if problem determining lock statusboolean isEditable()
void setEditable(boolean pEditable) throws VersionException
VersionException
void setEditable(boolean pEditable, boolean pNewTransaction) throws VersionException
pEditable,
- set editable if true otherwise mark non-editablepNewTransaction
- use a nested new transaction is set to trueVersionException
boolean isUpToDate() throws VersionException
VersionException
int getCountOfOutOfDateVersions() throws VersionException
VersionException
java.util.Set getOutOfDateVersions() throws VersionException
VersionException
java.util.Collection findWorkingReferencesToAsset(AssetVersion assetVersion) throws VersionException
version
- finds references to this asset versionpLine
- VersionException
void addNewAsset(int type, atg.adapter.version.RepositoryWorkingVersionItem item, java.lang.String repositoryName, java.lang.String itemDescriptor, java.lang.Integer version) throws VersionException
type
- Is this a repository item or a fileversionItem
- working version of new assetrepositoryName
- repository adding this assetitemDescriptor
- asset's descriptorversion
- version of asset (should be 0)VersionException
- thrown if problem adding assetboolean isCheckedOut(Asset pAsset) throws VersionException
pAsset
- Asset to checkVersionException
boolean isCheckedOut(Asset pAsset, boolean pCheckCache) throws VersionException
pAsset
- Asset to checkpCheckCache
- Flag indicating whether the cache should be checked
first when determining this information.VersionException
boolean isCheckedOut(VersionManagerURI pURI) throws VersionException
pURI
- The VersionManagerURI of the asset to checkVersionException
boolean isCheckedOut(VersionManagerURI pURI, boolean pCheckCache) throws VersionException
pURI
- The VersionManagerURI of the asset to checkpCheckCache
- Flag indicating whether the cache should be checked
first when determining this information.VersionException