javax.wvcm
Interface ControllableFolder

All Superinterfaces:

ControllableResource, Folder, Resource

All Known Subinterfaces:

Workspace

public interface ControllableFolder

extends ControllableResource, Folder

A ControllableFolder is a folder that can be placed under control.

A "configuration" is the set of resources consisting of all members of a controllable folder (called the "root folder" for the configuration).

When a controllable folder is placed under version control, a version of that folder only captures the named mappings to version controlled members of that folder. In order to version control the entire configuration rooted at a folder, the folder must be placed under "baseline control".

Nested Class Summary

Nested classes inherited from class ControllableResource

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

Nested classes inherited from class Folder

Folder.Binding

Method Summary

void	doBaselineControl() Put this ControllableFolder under baseline control.
void	doBaselineControl(Baseline baseline) Put this ControllableFolder under baseline control and initialize it with the contents of the specified baseline.
boolean	getBaselineControllable() Return whether the folder can be put under baseline control.
List	getEclipsedList() Return a list of String objects that identify the names of version-controlled resources in this ControllableFolder that are eclipsed by non-version-controlled resources.
Iterator	readMemberList(PropertyNameList wantedPropertyList, boolean deep) Return an iterator of Resource objects that contain locally available properties of the resources that are locally known as members of this Folder.

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

Methods inherited from interface Folder

doReadMemberList, getBindingList

Method Detail

readMemberList

public Iterator readMemberList(PropertyNameList wantedPropertyList,
                               boolean deep)
                                  throws WvcmException

Return an iterator of Resource objects that contain locally available properties of the resources that are locally known as members of this Folder. Locally available information is information that is available on the client host without communicating with the server.

Parameters:

wantedPropertyList - The list of properties to be retrieved.

deep - Whether to retrieve properties for all members of this Folder.

WvcmException

See Also:

Folder.doReadMemberList(javax.wvcm.PropertyNameList, boolean)

doBaselineControl

public void doBaselineControl()
                       throws WvcmException

Put this ControllableFolder under baseline control.

A version-controlled configuration resource is associated with this ControllableFolder, which allows versions of the configuration rooted at this ControllableFolder to be created by checking out and checking in the version-controlled configuration resource.

A version of a configuration is called a "baseline".

Throws:

WvcmException - Preconditions:
(controlled-configuration-must-not-exist): The ControlledConfiguration property of the folder identified by this ControllableFolder MUST NOT exist.

WvcmException - Postconditions:
(create-controlled-configuration): A new version-controlled configuration is created, whose RootFolder property identifies the folder.
(reference-controlled-configuration): The ControlledConfiguration of the folder identifies the new version-controlled configuration.
(create-new-baseline): The request MUST have created a new baseline history at a server-defined location, and MUST have created a new baseline in that baseline history. The BaselineFolder of the new baseline MUST identify a folder whose members have the same relative name and CheckedIn version as the version-controlled members of the request folder. The CheckedIn property of the new version-controlled configuration MUST identify the new baseline.

doBaselineControl

public void doBaselineControl(Baseline baseline)
                       throws WvcmException

Put this ControllableFolder under baseline control and initialize it with the contents of the specified baseline.

Parameters:

baseline - The baseline used to initialize the folder.

Throws:

WvcmException - Preconditions:
(cannot-add-to-existing-history): This ControllableFolder MUST NOT identify an existing resource.
(one-baseline-controlled-folder-per-history-per-workspace): There MUST NOT be another folder in the workspace of this ControllableFolder whose ControlledConfiguration property identifies a version-controlled configuration for the baseline history of that baseline.

WvcmException - Postconditions:
(create-controlled-configuration): A new folder is created at the location of this ControllableFolder, and a new version-controlled configuration is created, whose RootFolder property identifies the new folder. The ControlledConfiguration property of the new folder identifies the new version-controlled configuration.
(select-existing-baseline): The CheckedIn property of the new version-controlled configuration MUST have been set to identify the specified baseline. A version-controlled member of the folder will be created for each version in the baseline, where the version-controlled member will have the content of that version, and will have the same name relative to the folder as the corresponding version-controlled resource had when the baseline was created. Any nested folders that are needed to provide the appropriate name for a version-controlled member will be created.

getEclipsedList

public List getEclipsedList()
                               throws WvcmException

Return a list of String objects that identify the names of version-controlled resources in this ControllableFolder that are eclipsed by non-version-controlled resources.

Throws:

WvcmException - if this ControllableFolder was not created with ECLIPSED_LIST as a wanted property.

getBaselineControllable

public boolean getBaselineControllable()
                                throws WvcmException

Return whether the folder can be put under baseline control.

Throws:

WvcmException - if this ControllableFolder was not created with BASELINE_CONTROLLABLE as a wanted property.

See Also:

doBaselineControl()