javax.wvcm
Interface Baseline

All Superinterfaces:
Resource, Version

public interface Baseline
extends Version

Represents a baseline resource. See section 12 of RFC 3253.


Nested Class Summary
static interface Baseline.AddedVersion
          A version that is referenced by the second baseline but no version from the version history of that version is referenced by the first baseline.
static interface Baseline.ChangedVersion
          A pair of different versions referenced by two baseline from the same version history.
static interface Baseline.CompareBaselineReport
          A description of how the selection of a version from a version history differs between two baselines.
static interface Baseline.DeletedVersion
          A version that is referenced by the first baseline but no version from the version history of that version is referenced by the second baseline.
 
Nested classes inherited from class Version
Version.Fork
 
Method Summary
 Iterator doCompareBaselineReport(Baseline baseline)
          Return an iterator of AddedVersion, DeletedVersion, and ChangedVersion objects, that enumerate the differences between the versions selected by this Baseline and the baseline argument.
 ControllableFolder getBaselineFolder()
          Return a folder containing a read-only copy of the version-controlled state of the baseline-controlled folder at the time the baseline identified by this Baseline was created.
 List getSubbaselineList()
          Return a list of Baseline objects that identify the subbaselines of the baseline identified by this Baseline.
 
Methods inherited from interface Version
getActivityList, getCheckinFork, getCheckoutFork, getCheckoutList, getLabelNameList, getPredecessorList, getSuccessorList, getVersionHistory, getVersionName, setActivityList, setCheckinFork, setCheckoutFork
 
Methods inherited from interface Resource
doBind, doCopy, doReadContent, doReadProperties, doRebind, doUnbind, doWriteContent, doWriteProperties, getAttribute, getComment, getContentCharacterSet, getContentIdentifier, getContentLanguage, getContentLength, getContentType, getCreationDate, getCreatorDisplayName, getDisplayName, getLastModified, getParentBindingList, getPropertyNameList, getProviderList, getResourceIdentifier, getUpdatedPropertyList, getWorkspaceFolderList, location, removeAttribute, setAttribute, setComment, setContentCharacterSet, setContentLanguage, setContentType, setCreatorDisplayName, setDisplayName
 

Method Detail

doCompareBaselineReport

public Iterator doCompareBaselineReport(Baseline baseline)
                                           throws WvcmException
Return an iterator of AddedVersion, DeletedVersion, and ChangedVersion objects, that enumerate the differences between the versions selected by this Baseline and the baseline argument.

Parameters:
baseline - The baseline being compared to this Baseline.
Throws:
WvcmException - Preconditions:
(baselines-from-same-history): A server MAY require that the baselines being compared be from the same baseline history.

getBaselineFolder

public ControllableFolder getBaselineFolder()
                                     throws WvcmException
Return a folder containing a read-only copy of the version-controlled state of the baseline-controlled folder at the time the baseline identified by this Baseline was created.

Throws:
WvcmException - if this Baseline was not created with BASELINE_FOLDER as a wanted property.

getSubbaselineList

public List getSubbaselineList()
                                  throws WvcmException
Return a list of Baseline objects that identify the subbaselines of the baseline identified by this Baseline. created when this Configuration

Throws:
WvcmException - if this Baseline was not created with SUBBASELINE_LIST as a wanted property.