javax.wvcm
Interface Configuration

All Superinterfaces:

ControllableResource, Resource

public interface Configuration

extends ControllableResource

A configuration is a resource that is associated with a folder (called the "root folder") and that represents all members of the root folder that are not in another configuration.

A version-controlled configuration is associated with a baseline-controlled folder, and is used to create and access baselines of that folder.

When a folder is both version-controlled and baseline-controlled, a client can create a new version of the folder by checking out and checking in that folder, and it can create a new baseline of that folder by checking out and checking in the version-controlled configuration of that folder.

Nested Class Summary

Nested classes inherited from class ControllableResource

ControllableResource.Conflict, ControllableResource.Ignore, ControllableResource.MergePreviewReport, ControllableResource.Update

Method Summary

ControllableFolder	getRootFolder() Return the root folder of the configuration.
List	getSubbaselineList() If this Configuration is checked-out, return a list of Baseline objects that identify the baselines that will be the subbaselines of the baseline created when this Configuration is checked in; otherwise return null.
void	setSubbaselineList(List baselineList) Set the SubbaselineList property of this Configuration.

Methods inherited from interface ControllableResource

doAddLabel, doCheckin, doCheckin, doCheckout, doCheckout, doControl, doCreateResource, doCreateVersionControlledResource, doMerge, doMergePreviewReport, doReadLabelledVersionProperties, doRefresh, doRemoveLabel, doSetLabel, doUncheckout, doUpdate, getActivityList, getAutoMergeList, getCheckedIn, getCheckedOut, getControlledConfiguration, getDirtyPropertyList, getIsCheckedOut, getIsDirtyContent, getIsStaleContent, getMergeList, getPredecessorList, getServerState, getStalePropertyList, getUnreserved, getVersionControllable, getVersionHistory, getWorkspace, readContent, readProperties, setActivityList, setAutoMergeList, setMergeList, setPredecessorList, setUnreserved

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

getRootFolder

public ControllableFolder getRootFolder()
                                 throws WvcmException

Return the root folder of the configuration. The ControlledConfiguration property of the root folder of a version-controlled configuration MUST identify that version-controlled configuration.

Throws:

WvcmException - if this Configuration was not created with ROOT_FOLDER as a wanted property.

getSubbaselineList

public List getSubbaselineList()
                                  throws WvcmException

If this Configuration is checked-out, return a list of Baseline objects that identify the baselines that will be the subbaselines of the baseline created when this Configuration is checked in; otherwise return null.

Throws:

WvcmException - if this Configuration was not created with SUBBASELINE_LIST as a wanted property.

setSubbaselineList

public void setSubbaselineList(List baselineList)
                        throws WvcmException

Set the SubbaselineList property of this Configuration.

Parameters:

baselineList - A list of Baseline objects that will be the SubbaselineList property of the baseline created when this Configuration is checked in.

WvcmException