|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface VersionControlService
Provides client accessible server-side functionality for Mastered
(unchanging), Versioned (major change) and Iterated (minor
change) objects to implement version control. There is also a server-accessible-only
VersionControlSvrService.
VersionInfo, IterationInfoVersionControlHelper provides helper methodsStandardVersionControlService
has listenersVersionControlServiceEventVersionControlException
| Method Summary | |
|---|---|
QueryResult |
allIterationsFrom(Iterated iteration)
Finds all of the iterations to the very first one created from the given one. |
QueryResult |
allIterationsFrom(Iterated iteration,
boolean includeDerivedFroms)
Finds all of the iterations to the very first one created from the given one. |
QueryResult |
allIterationsFrom(Iterated iteration,
boolean includeDerivedFroms,
boolean filterTerminals)
Finds all of the iterations to the very first one created from the given one. |
QueryResult |
allIterationsOf(Mastered master)
Finds all of the iterations to the very first one created associated with the given master. |
QueryResult |
allIterationsOf(Mastered master,
boolean filterTerminals)
Finds all of the iterations to the very first one created associated with the given master. |
QueryResult |
allVersionsFrom(Versioned version)
Finds all of the versions to the very first one created from the given version. |
QueryResult |
allVersionsOf(Mastered master)
Finds all of the versions to the very first one created associated with the given master. |
QueryResult |
allVersionsOf(Versioned version)
Finds all of the versions to the very first one created associated [via its master] with the given version. |
QueryResult |
allVersionsOf(WTCollection masters,
Class versionClass)
Finds all of the versions to the very first one created associated with the given collection of masters. |
void |
deleteIterations(Iterated beginIteration,
Iterated endIteration)
Deletes all iterations between beginIteration and endIteration of same version. |
void |
deleteIterations(WTCollection iterations,
ConflictResolution[] resolvers)
This is for deletion of selective iterations. |
void |
deleteIterations(WTCollection iterations,
ConflictResolution[] resolvers,
boolean changeModifyStamp)
This is for deletion of selective iterations. |
String[] |
getAvailableVersionLabels(ObjectReference master,
String versionLabel,
ViewReference view,
boolean onlySuccessors,
int n)
Return versions that are available to create new versions. |
Iterated |
getLatestIteration(Iterated iteration,
boolean includeMarkedForDelete)
Get the "latest" iteration in the same branch as the given one. |
WTValuedMap |
getLatestIterations(WTCollection iterations,
boolean includeMarkedForDelete)
Get the "latest" iteration in the same branch as the ones passed in the collection. |
String[] |
getNextCommonLabels(WTCollection version,
int n)
Given a collection of Versioned objects return the next n version labels that are valid for all versions. |
String[] |
getNextVersionLabels(Versioned version,
int n)
Get the series for the input version and return the next n valid version labels. |
String[] |
getNextVersionLabels(Versioned version,
wt.lifecycle.LifeCycleTemplateReference lct,
int n)
Gets the next n version labels. |
boolean |
isFirstIteration(Iterated iteration)
Tests if the given iteration is the first one in the version branch. |
QueryResult |
iterationsOf(Iterated iteration)
Finds only the iterations directly associated with the given one. |
QueryResult |
iterationsOf(long branch,
Class iteratedClass)
Finds only the iterations directly associated with the given branch id. |
QueryResult |
iterationsOf(WTCollection iterations,
Class iteratedClass,
boolean includeLatest)
Finds only the iterations directly associated with the given colletion of iterated objects. |
Versioned |
merge(Versioned srcVersion,
Versioned destVersion,
String note)
Creates a new iteration of srcVersion and re-parents it as the latest iteration of destVersion. |
WTValuedMap |
merge(WTValuedMap sourceToDestinationsMap,
String note)
Multi-object form of merge operation. |
AdHocStringVersioned |
newAdHocStringVersion(AdHocStringVersioned version,
String adHocVersionId)
Creates a new in-line version with the given adHocVersionId assigned. |
Versioned |
newBranch(Versioned version)
Makes a new branched version from the given one using it as a branch point, which may or may not be the "latest" iteration. |
Iterated |
newIteration(Iterated iteration,
boolean copyAttributes)
Makes a new iteration/version as a copy from the given one, and does not increment its identifiier. |
OneOffVersioned |
newOneOffVersion(OneOffVersioned version)
Creates a new in-line version from the given version. |
Versioned |
newUncontrolledVersion(Versioned version)
Makes a new version from the given version. |
Versioned |
newVersion(Versioned version)
Makes a new in-lined version from the given version. |
Versioned |
newVersion(Versioned version,
VersionIdentifier version_id,
IterationIdentifier iteration_id)
Makes a new in-lined version from the given version. |
Versionable |
newVersionable(Versionable version)
API intended to be called internally by any API that intends to create a new version. |
WTList |
newVersionables(WTList versions)
API intended to be called internally by any API that intends to create a new version. |
WTValuedMap |
newVersions(WTCollection versions)
Makes a new in-lined version from the given version. |
WTValuedMap |
newVersions(WTKeyedMap versionMap)
Makes a new in-lined version from the given version. |
Iterated |
predecessorOf(Iterated iteration)
Finds the predecessor of the iteration. |
Iterated |
refresh(wt.vc.VersionForeignKey key)
Retrieves a Iterated object given its VersionForeignKey. |
Iterated |
rollback(Iterated iteration,
Iterated reversion)
Deletes all iterations starting at the latest iteration in a version back to, but not including, a specified iteration in the same version. |
Iterated |
rollup(Iterated iteration,
Iterated culmination)
Deletes all iterations starting at the first iteration in a version up to, but not including, a specified iteration in the same version. |
Iterated |
supersede(Iterated iteration,
Iterated replacement)
Supersedes the first iteration with the other iteration. |
WTValuedMap |
supersede(WTValuedMap iterationReplacementMap)
Supersedes each iteration passed as the key in the WTValuedMap with the corresponding iteration value in the WTValuedMap. |
| Method Detail |
|---|
Versioned newBranch(Versioned version)
throws WTException,
VersionControlException,
WTPropertyVetoException
version -
WTException
VersionControlException
WTPropertyVetoException
Versioned newVersion(Versioned version)
throws WTException,
VersionControlException,
WTPropertyVetoException
version -
WTException
VersionControlException
WTPropertyVetoException
Versioned newVersion(Versioned version,
VersionIdentifier version_id,
IterationIdentifier iteration_id)
throws WTException,
VersionControlException,
WTPropertyVetoException
version - version_id - iteration_id -
WTException
VersionControlException
WTPropertyVetoException
Versioned newUncontrolledVersion(Versioned version)
throws WTException,
VersionControlException,
WTPropertyVetoException
version -
WTException
VersionControlException
WTPropertyVetoException
AdHocStringVersioned newAdHocStringVersion(AdHocStringVersioned version,
String adHocVersionId)
throws WTException,
VersionControlException,
WTPropertyVetoException
version - adHocVersionId -
WTException
VersionControlException
WTPropertyVetoException
String[] getNextCommonLabels(WTCollection version,
int n)
throws VersionControlException,
WTException
version - n -
VersionControlException
WTException
OneOffVersioned newOneOffVersion(OneOffVersioned version)
throws WTException,
VersionControlException,
WTPropertyVetoException
version -
WTException
VersionControlException
WTPropertyVetoException
Versionable newVersionable(Versionable version)
throws WTException,
VersionControlException,
WTPropertyVetoException
version -
WTException
VersionControlException
WTPropertyVetoException
Iterated supersede(Iterated iteration,
Iterated replacement)
throws WTException,
VersionControlException,
WTPropertyVetoException
iteration - replacement -
WTException
VersionControlException
WTPropertyVetoException
Iterated rollback(Iterated iteration,
Iterated reversion)
throws WTException,
VersionControlException,
WTPropertyVetoException
Note: Since R3.0 rollback has changed its implementation from allowing a rollback between any two iterations, potentially from different versions, to the one described above.
It will throw conflict exception for branch point deletion if there
exist iterations on successor branches.
Supported API: true
iteration - reversion -
WTException
VersionControlException
WTPropertyVetoException
Iterated rollup(Iterated iteration,
Iterated culmination)
throws WTException,
VersionControlException,
WTPropertyVetoException
Note: Since R3.0 rollup has changed its implementation from allowing a rollup between any two iterations, potentially from different versions, to the one described above.
It will throw conflict exception for branch point deletion if there
exists iterations on successor branches.
Supported API: true
iteration - culmination -
WTException
VersionControlException
WTPropertyVetoException
Iterated predecessorOf(Iterated iteration)
throws WTException,
VersionControlException,
PersistenceException
iteration -
WTException
VersionControlException
PersistenceException
QueryResult iterationsOf(Iterated iteration)
throws WTException,
PersistenceException
iteration -
WTException
PersistenceException
QueryResult allIterationsOf(Mastered master)
throws WTException,
PersistenceException
master -
WTException
PersistenceException
QueryResult allIterationsFrom(Iterated iteration)
throws WTException,
PersistenceException
iteration -
WTException
PersistenceException
QueryResult allVersionsOf(Versioned version)
throws WTException,
PersistenceException
version -
WTException
PersistenceException
QueryResult allVersionsOf(Mastered master)
throws WTException,
PersistenceException
master -
WTException
PersistenceException
QueryResult allVersionsOf(WTCollection masters,
Class versionClass)
throws WTException,
PersistenceException
masters - versionClass -
WTException
PersistenceException
QueryResult allVersionsFrom(Versioned version)
throws WTException,
PersistenceException
version -
WTException
PersistenceException
boolean isFirstIteration(Iterated iteration)
throws WTException,
VersionControlException
iteration -
WTException
VersionControlException
QueryResult iterationsOf(long branch,
Class iteratedClass)
throws WTException,
PersistenceException
The branch id can uniquely identify a branch in a system based on its property of being unique since it's generated from the OID pool.
branch - iteratedClass -
WTException
PersistenceException
QueryResult iterationsOf(WTCollection iterations,
Class iteratedClass,
boolean includeLatest)
throws WTException,
PersistenceException
If the flag includeLatest is false then the latest iteration is not
included in the resulted list of iterations.
Supported API: true
iterations - iteratedClass - includeLatest -
WTException
PersistenceException
Versioned merge(Versioned srcVersion,
Versioned destVersion,
String note)
throws WTException,
WTPropertyVetoException
Note that this class provides a multi-object equivalent of this method
as well.
Supported API: true
srcVersion - the version to be merged fromdestVersion - the version to be merged tonote - the iteration note to be assigned to the new iteration
WTException
WTPropertyVetoException
WTValuedMap merge(WTValuedMap sourceToDestinationsMap,
String note)
throws WTException,
WTPropertyVetoException
Returns map from source objects to newly formed "merged" iterations.
See comments on single-object merge operation for more details.
Supported API: true
sourceToDestinationsMap - map from merge sources to merge destinationsnote - the iteration note to be assigned to the new iterations
WTException
WTPropertyVetoException
Iterated newIteration(Iterated iteration,
boolean copyAttributes)
throws WTException,
VersionControlException,
WTPropertyVetoException
iteration - copyAttributes -
WTException
VersionControlException
WTPropertyVetoException
Iterated getLatestIteration(Iterated iteration,
boolean includeMarkedForDelete)
throws WTException,
VersionControlException
iteration - includeMarkedForDelete -
WTException
VersionControlException
void deleteIterations(Iterated beginIteration,
Iterated endIteration)
throws WTException,
VersionControlException,
WTPropertyVetoException
beginIteration - endIteration -
WTException
VersionControlException
WTPropertyVetoException
void deleteIterations(WTCollection iterations,
ConflictResolution[] resolvers)
throws WTException,
VersionControlException,
WTPropertyVetoException
iterations - WTCollection of all iterations to be deleted.resolvers - Resolutions provided to resove oevrridable conflicts.
WTException
VersionControlException
WTPropertyVetoException
String[] getAvailableVersionLabels(ObjectReference master,
String versionLabel,
ViewReference view,
boolean onlySuccessors,
int n)
throws VersionControlException,
WTException
master - versionLabel - If not null will use this as a starting point for returning version labels. I.e., if n=3 and versionLabel="E" input then { F, G, H } will be returned if they are not already used.view - onlySuccessors - If true will only return labels that are successors to the input versionLabel value.n -
VersionControlException
WTException
WTValuedMap supersede(WTValuedMap iterationReplacementMap)
throws WTException,
VersionControlException,
WTPropertyVetoException
iterationReplacementMap -
WTException
VersionControlException
WTPropertyVetoException
WTValuedMap newVersions(WTCollection versions)
throws WTException,
VersionControlException,
WTPropertyVetoException
versions -
WTException
VersionControlException
WTPropertyVetoException
WTValuedMap newVersions(WTKeyedMap versionMap)
throws WTException,
VersionControlException,
WTPropertyVetoException
versionMap -
WTException
VersionControlException
WTPropertyVetoException
WTList newVersionables(WTList versions)
throws WTException,
VersionControlException,
WTPropertyVetoException
versions -
WTException
VersionControlException
WTPropertyVetoException
Iterated refresh(wt.vc.VersionForeignKey key)
throws WTException
key -
WTException
WTValuedMap getLatestIterations(WTCollection iterations,
boolean includeMarkedForDelete)
throws WTException,
VersionControlException
iterations - includeMarkedForDelete -
WTException
VersionControlException
void deleteIterations(WTCollection iterations,
ConflictResolution[] resolvers,
boolean changeModifyStamp)
throws VersionControlException,
WTException,
WTPropertyVetoException
iterations - WTCollection of all iterations to be deleted.resolvers - Resolutions provided to resove oevrridable conflicts.changeModifyStamp - If true update modifyStamp when re-chaining iterations.
VersionControlException
WTException
WTPropertyVetoException
String[] getNextVersionLabels(Versioned version,
wt.lifecycle.LifeCycleTemplateReference lct,
int n)
throws VersionControlException,
WTException
version - If a container is set will look up series for that container. If no container set will return zero length array.lct - Assumes that the series to be defined will be the one defined for the first State in the LifeCycleTemplate. If null returns zero length array.n -
VersionControlException
WTException
String[] getNextVersionLabels(Versioned version,
int n)
throws VersionControlException,
WTException
version - n - number of labels to return
VersionControlException
WTException
QueryResult allIterationsFrom(Iterated iteration,
boolean includeDerivedFroms)
throws VersionControlException,
WTException
iteration - includeDerivedFroms - If true then return a QueryResult where each element is a two-element array where
element[0] = the previous iteration's predecessor
element[1] = the previous iteration's derivedFrom if it is different than previous iteration's predecessor. If they are the same element[1] = null.
If false then return a QueryResult containing the iterations ordered by predecessors.
VersionControlException
WTException
QueryResult allIterationsFrom(Iterated iteration,
boolean includeDerivedFroms,
boolean filterTerminals)
throws VersionControlException,
WTException
iteration - includeDerivedFroms - If true then return a QueryResult where each element is a two-element array where
element[0] = the previous iteration's predecessor
element[1] = the previous iteration's derivedFrom if it is different than previous iteration's predecessor. If they are the same element[1] = null.
If false then return a QueryResult containing the iterations ordered by predecessors.filterTerminals -
VersionControlException
WTException
QueryResult allIterationsOf(Mastered master,
boolean filterTerminals)
throws WTException,
PersistenceException
master - filterTerminals -
WTException
PersistenceException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||