javax.wvcm
Interface Workspace

All Superinterfaces:

ControllableFolder, ControllableResource, Folder, Resource

public interface Workspace

extends ControllableFolder

Represents workspace resource. See section 6 of RFC 3253.

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

List	doLocateByHistoryReport(List versionHistoryList, PropertyNameList wantedPropertyList) Return a list of ControllableResource objects that identify the controllable resources that are members of this Workspace and whose versionHistory property identifies a member of the versionHistoryList parameter.
Iterator	doMerge(List sourceList, boolean checkinActivity, boolean noAutoMerge, boolean noCheckout, boolean forkOK, boolean unreserved, List activityList, boolean newActivity, PropertyNameList wantedPropertyList) Merge the versions specified in the sourceList into this ControllableResource.
Iterator	doMergePreviewReport(List sourceList) Return an iterator of MergePreviewReport objects, indicating what resources would be modified by a doMerge.
List	getActivityFolderList() Return a list of Folder objects that identify folders that can contain activities for this Workspace.
List	getBaselineControlledFolderList() Return a list of ControllableFolder objects that identify the folders that are the roots of the baseline-controlled configurations in that workspace.
List	getCurrentActivityList() Return a list of Activity objects that identify the activities that will initialize the ActivityList property of a version-controlled member of this Workspace when that member is checked out and no explicit ActivityList is specified in the checkout request.
List	getVersionHistoryFolderList() Return a list of Folder objects that identify folders that can contain version histories for this Workspace.
List	getWorkspaceCheckoutList() Return a list of ControllableResource objects that identify the members of this Workspace that are checked-out version-controlled resources.
void	setCurrentActivityList(List activityList) Set the CurrentActivityList property.
void	setServerState(Workspace workspace) When this Workspace is located on the client, this routine is used to specify the Workspace on the server that maintains the server state for this Workspace This property must be set before creating a workspace that is located on the client.

Methods inherited from interface ControllableFolder

doBaselineControl, doBaselineControl, getBaselineControllable, getEclipsedList, readMemberList

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

setServerState

public void setServerState(Workspace workspace)

When this Workspace is located on the client, this routine is used to specify the Workspace on the server that maintains the server state for this Workspace This property must be set before creating a workspace that is located on the client.

See Also:

ControllableResource.getServerState()

getActivityFolderList

public List getActivityFolderList()
                                     throws WvcmException

Return a list of Folder objects that identify folders that can contain activities for this Workspace. This list is empty if this Workspace does not provide activity support.

Throws:

WvcmException - if this Workspace was not created with ACTIVITY_FOLDER_LIST as a wanted property.

getVersionHistoryFolderList

public List getVersionHistoryFolderList()
                                           throws WvcmException

Return a list of Folder objects that identify folders that can contain version histories for this Workspace. This list is empty if this Workspace does not provide versioning support.

Throws:

WvcmException - if this Workspace was not created with VERSION_HISTORY_FOLDER_LIST as a wanted property.

getBaselineControlledFolderList

public List getBaselineControlledFolderList()
                                               throws WvcmException

Return a list of ControllableFolder objects that identify the folders that are the roots of the baseline-controlled configurations in that workspace.

Throws:

WvcmException - if this Workspace was not created with BASELINE_CONTROLLED_FOLDER_LIST as a wanted property.

getCurrentActivityList

public List getCurrentActivityList()
                                      throws WvcmException

Return a list of Activity objects that identify the activities that will initialize the ActivityList property of a version-controlled member of this Workspace when that member is checked out and no explicit ActivityList is specified in the checkout request. This allows an activity-unaware client to update a workspace in which activity tracking is required. The CurrentActivityList MAY be restricted to identify at most one activity.

Throws:

WvcmException - if this Workspace was not created with CURRENT_ACTIVITY_LIST as a wanted property.

setCurrentActivityList

public void setCurrentActivityList(List activityList)

Set the CurrentActivityList property.

Parameters:

activityList - The list of Activity objects that identify the new CurrentActivityList for this Workspace.

getWorkspaceCheckoutList

public List getWorkspaceCheckoutList()
                                        throws WvcmException

Return a list of ControllableResource objects that identify the members of this Workspace that are checked-out version-controlled resources.

Throws:

WvcmException - if this Workspace was not created with WORKSPACE_CHECKOUT_LIST as a wanted property.

doLocateByHistoryReport

public List doLocateByHistoryReport(List versionHistoryList,
                                    PropertyNameList wantedPropertyList)
                                       throws WvcmException

Return a list of ControllableResource objects that identify the controllable resources that are members of this Workspace and whose versionHistory property identifies a member of the versionHistoryList parameter.

Parameters:

versionHistoryList - A list of VersionHistory objects that are being located.

wantedPropertyList - The properties to be retrieved for the returned version-controlled resources.

WvcmException

doMerge

public Iterator doMerge(List sourceList,
                        boolean checkinActivity,
                        boolean noAutoMerge,
                        boolean noCheckout,
                        boolean forkOK,
                        boolean unreserved,
                        List activityList,
                        boolean newActivity,
                        PropertyNameList wantedPropertyList)
                           throws WvcmException

Merge the versions specified in the sourceList into this ControllableResource. The "target" of a particular source version is the version-controlled member of the workspace identified by this Workspace that is associated with the version history for that version.

Parameters:

sourceList - A list of Resource objects that identifies the versions to be merged. If a member of sourceList is an activity, each version in the ActivityVersionList is a source version. If a member of sourceList is a version-controlled resource, the checked-in version of the member is a source version. If a member of sourceList is a folder, all members of the configuration rooted at that folder are considered members of the sourceList.

checkinActivity - If a member of the sourceList is an activity, apply doCheckin to that activity before performing the merge.

noAutoMerge - See ControllableResource#doMerge.

noCheckout - See ControllableResource#doMerge.

forkOK - See ControllableResource#doMerge.

unreserved - See ControllableResource#doMerge.

activityList - See ControllableResource#doMerge.

newActivity - See ControllableResource#doMerge.

wantedPropertyList - See ControllableResource#doMerge.

Returns:

An iterator of ControllableResource objects that identifies the resources modified by the merge.

Throws:

WvcmException - Preconditions:
(cannot-merge-checked-out-resource): The sourceList argument member MUST NOT identify a checked-out resource. If the sourceList argument member identifies a folder, the folder MUST NOT have a member that is a checked-out resource.

WvcmException - Postconditions:
(merge-baseline): If the merge target is a version-controlled configuration whose CheckedOut baseline is not a descendant of the merge baseline, then the merge baseline MUST have been added to the AutoMergeList of a version-controlled configuration. The CheckedIn version of each member of the BaselineFolder of that baseline MUST have been merged into the RootFolder of that version-controlled configuration.
(merge-sub-baselines): If the merge target is a version-controlled configuration whose RootFolder contains a baseline-controlled member for one of the sub-baselines of the merge baseline, then that sub-baseline MUST have been merged into the version-controlled configuration of that baseline-controlled member. If the merge target is a version-controlled configuration whose RootFolder is a member of a workspace that contains a baseline-controlled member for one of the sub-baselines of the merge baseline, then that sub-baseline MUST have been merged into the version-controlled configuration of that baseline-controlled member.
(set-baseline-controlled-folder-members): Same semantics as doUpdate.

doMergePreviewReport

public Iterator doMergePreviewReport(List sourceList)
                                        throws WvcmException

Return an iterator of MergePreviewReport objects, indicating what resources would be modified by a doMerge.

Parameters:

sourceList - A list of Resource objects that identify the versions to be merged.

WvcmException