public interface CcView extends CcDirectory, Workspace
A proxy for a ClearCase view. ClearCase "view" and WVCM "workspace" are equivalent terms for the same type of resource.
As of the ClearCase 8.0.1.6 release, CM API supports web, dynamic and snapshot views.
Modifier and Type | Interface and Description |
---|---|
static class |
CcView.FindmergeFlag
Flags for the doFindMergeCandidates methods
|
static class |
CcView.SynchronizeFileAreaDbFlag
Flags for the
doSynchronizeFileAreaDb method |
static class |
CcView.TextMode
Values for view text mode
|
CcFile.ApplyLabelFlag, CcFile.ApplyRolemapFlag, CcFile.AttributeOpFlag, CcFile.CcCheckinFlag, CcFile.CcCheckoutFlag, CcFile.CcVersionControlFlag, CcFile.LoadState, CcFile.RefreshFlag, CcFile.RemoveLabelFlag, CcFile.UncheckoutFlag, CcFile.UnhijackFlag
StpResource.UnsupportedProperty
Resource.CopyFlag
Workspace.MergeFlag, Workspace.MergePreviewReport
ControllableResource.CheckinFlag, ControllableResource.CheckoutFlag
Folder.BindFlag, Folder.RebindFlag
Modifier and Type | Field and Description |
---|---|
static PropertyNameList.PropertyName<Boolean> |
ARE_PERMISSIONS_VALID
Are this view's permissions valid?
|
static PropertyNameList.PropertyName<Boolean> |
COLOCATED_STORAGE
Colocate view's storage directory under snapshot view directory,
not supported for other view types.
|
static PropertyNameList.PropertyName<ResourceList<CcDirectory>> |
COMPONENT_ROOT_DIRECTORY_LIST
For a UCM view, the list of root directories for all components
included in that view's stream.
|
static PropertyNameList.PropertyName<CcConfigSpec> |
CONFIG_SPEC
This view's config spec.
|
static PropertyNameList.PropertyName<Boolean> |
FILE_AREA_NEEDS_UPGRADE
Is this web view's local file area schema version older than the version
supported by the running CM API file management code?
|
static PropertyNameList.PropertyName<File> |
FILE_AREA_ROOT_DIRECTORY
This view's file area root directory on the local machine.
|
static PropertyNameList.PropertyName<Boolean> |
IS_EXPRESS
Does this view have non-shareable derived objects?
|
static PropertyNameList.PropertyName<Boolean> |
IS_READ_ONLY
Is this view read-only?
|
static PropertyNameList.PropertyName<Boolean> |
IS_UCM_VIEW
Is this view associated with a UCM stream?.
|
static PropertyNameList.PropertyName<Map<String,Resource>> |
LOADED_CHILD_MAP
Whereas a CcView resource's
Folder.CHILD_MAP property
returns the root directories of all VOBs, LOADED_CHILD_MAP only
returns the root directories of VOBs that are partially or fully loaded
in this view (if this is a web view or snapshot view) or mounted (if
this is a dynamic view or automatic view). |
static PropertyNameList.PropertyName<ResourceList<CcVobTag>> |
MOUNTED_VOB_TAG_LIST
List of VOB tags representing VOBs which are currently mounted
in this view.
|
static PropertyNameList.PropertyName<CcPermissions> |
PERMISSIONS
The permissions applied to this resource.
|
static PropertyNameList.PropertyName<Boolean> |
PRESERVE_VOB_MODIFIED_TIME
Indicates whether this view will preserve
the VOB modification time for files when copying them into
the view.
|
static PropertyNameList.PropertyName<CcRegistryRegion> |
REGION
Network region in which the dynamic view is registered.
|
static PropertyNameList.PropertyName<String> |
SERVER_URL
If this is a local web or automatic view, the URL of the CCRC WAN server where this
view's view database resides.
|
static PropertyNameList.PropertyName<Boolean> |
SHARE_DERIVED_OBJECTS
Should derived objects created in this view be shared and made
available for winkin by other views?
|
static PropertyNameList.PropertyName<String> |
SHARED_CLEARTEXT_STORAGE_PATH
Path to directory in which shared cleartext for an automatic view
is stored.
|
static PropertyNameList.PropertyName<CcView.TextMode> |
TEXT_MODE
The text mode of the view.
|
static PropertyNameList.PropertyName<CcViewAccessInfo> |
VIEW_ACCESS_INFO
CcViewAccessInfo object contains the supported view access properties.
|
static PropertyNameList.PropertyName<CcStorageLocation> |
VIEW_STORAGE_LOCATION
The storage location for a dynamic or snapshot view,
not supported for other view types.
|
static PropertyNameList.PropertyName<String> |
VIEW_STORAGE_PATH
The storage path for a dynamic or automatic or snapshot view,
not supported for other view types.
|
static PropertyNameList.PropertyName<CcViewTag> |
VIEW_TAG
This view's view tag as a
CcViewTag resource. |
static PropertyNameList.PropertyName<String> |
VIEW_TAG_STRING
This view's view tag as a string.
|
static PropertyNameList.PropertyName<CcViewTag.ViewType> |
VIEW_TYPE
Kind of view to which this tag refers
|
static PropertyNameList.PropertyName<String> |
VIEW_UUID_STRING
This view's uuid as a string.
|
AGGREGATED_CHECKOUT_LIST, AGGREGATED_HIJACK_LIST, AGGREGATED_VIEW_PRIVATE_LIST, ECLIPSED_LIST, HAS_DESCENDANT_CHECKOUTS, HAS_DESCENDANT_HIJACKS, IS_VOB_ROOT
CLIENT_PATH, ELEMENT, ELEMENT_TYPE, FROM_FILE, IS_DB_FILE, IS_ECLIPSING, IS_HIJACKED, IS_SYMLINK, LATEST_VERSION_ON_BRANCH, LOAD_STATE, PARENT, SELECTION_RULE, SKEWED_PROPERTY_LIST, SYMLINK_TARGET_PATH, VERSION, VERSION_OID, VIEW_RELATIVE_PATH, VOB_TAG
ALL_PROPERTIES, AUTHENTICATION_REALM, CREATOR_GROUP_NAME, CREATOR_LOGIN_NAME, EFFICIENT_LOCATION, INVALID_PROPERTIES, REPOSITORY, STABLE_LOCATION, USER_FRIENDLY_LOCATION
ALL_CUSTOM_PROPERTIES, COMMENT, CONTENT_CHARACTER_SET, CONTENT_IDENTIFIER, CONTENT_LANGUAGE, CONTENT_LENGTH, CONTENT_TYPE, CREATION_DATE, CREATOR_DISPLAY_NAME, DISPLAY_NAME, IS_EXECUTABLE, LAST_MODIFIED, PARENT_LIST, PATHNAME_LOCATION, PROVIDER_LIST, RESOURCE_IDENTIFIER, WORKSPACE_FOLDER_LIST
ACTIVITY_FOLDER_LIST, BASELINE_CONTROLLED_FOLDER_LIST, CONFIGURATION_ROOT_FOLDER_HOME, CONTROLLABLE_RESOURCE_HOME, CURRENT_ACTIVITY, ISOLATED_TARGET, SOURCE_LIST, STREAM, TARGET, VERSION_HISTORY_FOLDER_LIST, WORKSPACE_CHECKOUT_LIST
IS_BASELINE_CONTROLLABLE, IS_BASELINE_CONTROLLED, ROOT_FOLDER_OF
ACTIVITY, AUTO_MERGE_LIST, CHECKED_IN, CHECKED_OUT, CONFIGURATION, IS_CHECKED_OUT, IS_VERSION_CONTROLLABLE, IS_VERSION_CONTROLLED, MERGE_LIST, PREDECESSOR_LIST, RESERVED, VERSION_HISTORY, WORKSPACE
CHILD_LIST, CHILD_MAP
Modifier and Type | Method and Description |
---|---|
boolean |
breakFileAreaLock(CcFileAreaLockedCallback.CcFileAreaLockInfo lockInfo)
Break a file area lock on this web view with the given lock info.
|
StpActivity |
doBindActivity(StpActivity act,
Feedback feedback)
Binds a CcActivity proxy to a CqRecord proxy without making the
activity the current one for this view.
|
CcView |
doCancelDeliver(CcView integrationView,
CcListener integrationListener,
CcMergeElement[] mergeElements,
Feedback feedback)
Halt a deliver operation in progress, returning the source and
destination streams to their states before the deliver operation began.
|
CcView |
doCancelRebase(CcListener integrationListener,
CcListener updateListener,
Feedback feedback)
Cancels a rebase operation and restores the stream's previous
configuration.
|
CcView |
doCcRestore(CcFile.RefreshFlag[] flags,
Vector<String> paths,
Feedback feedback)
Restore entire view or select paths in the view - for automatic views only
|
CcView |
doCompleteDeliver(CcView integrationView,
CcListener integrationListener,
CcMergeElement[] mergeElements,
Feedback feedback)
Complete in-progress deliver operation taking the following actions:
Verify that all versions in the integration view have been
successfully merged and that merge conflicts have been resolved.
|
CcView |
doCompleteRebase(CcListener integrationListener,
CcListener updateListener,
Feedback feedback)
Completes a rebase operation taking the following actions:
Resumes the rebase operation
Verifies that needed merges were made
Checks in any versions that are checked out
Records changes in the change set for the rebase activity
|
CcView |
doCreateCcAutomaticView(Feedback feedback)
Create a new ClearCase automatic view based on this CcView proxy.
|
CcView |
doCreateCcDynamicView(Feedback feedback)
Create a new ClearCase dynamic view based on this CcView proxy.
|
CcView |
doCreateCcSnapshotView(Feedback feedback)
Create a new ClearCase snapshot view based on this CcView proxy.
|
CcView |
doCreateCcWebView(Feedback feedback)
Create a new ClearCase web view based on this CcView proxy.
|
CcView |
doFindMergeCandidates(CcFindmergeListener listener,
CcView.FindmergeFlag[] flags,
CcViewTag fromViewTag,
List<CcFile> elements,
Feedback feedback)
Runs findmerge command in this view.
|
CcView |
doFindMergeCandidates(CcFindmergeListener listener,
CcView.FindmergeFlag[] flags,
CcVobResource fromVobResource,
List<CcFile> elements,
Feedback feedback)
Runs findmerge command in this view.
|
CcView |
doFindMergeCandidatesFromChangeSets(CcFindmergeListener listener,
CcView.FindmergeFlag[] flags,
List<CcActivity> activities,
Feedback feedback)
Runs findmerge command in this view.
|
StpActivity |
doFinishActivity(StpActivity act,
Feedback feedback)
Transitions the specified activity to the default completed state.
|
CcView |
doResetDeliver(CcView integrationView,
CcListener integrationListener,
Feedback feedback)
Resets a deliver operation in progress to use the new integration view
|
CcView |
doResumeDeliver(CcView integrationView,
CcListener integrationListener,
Feedback feedback)
Resumes a deliver operation from the point at which it was suspended.
|
CcView |
doResumeRebase(boolean doAutoMerge,
CcListener integrationListener,
CcListener updateListener,
Feedback feedback)
Restarts a rebase operation from the point at which it has been
suspended.
|
CcView |
doStartDeliver(CcView integrationView,
boolean doAutoMerge,
CcListener integrationListener,
Feedback feedback)
The deliver command lets you deliver work from a source stream to a
target stream in the same or a different project.
|
CcView |
doStartDeliverActivities(CcView integrationView,
ResourceList<CcActivity> activityList,
boolean doAutoMerge,
CcListener integrationListener,
Feedback feedback)
Deliver the specified activities from the source stream associated with
this view to the target stream associated with the specified integration
view.
|
CcView |
doStartDeliverBaselines(CcView integrationView,
ResourceList<CcBaseline> baselineList,
boolean doAutoMerge,
CcListener integrationListener,
Feedback feedback)
Deliver the specified baselines from the source stream associated with
this view to the target stream associated with the specified integration
view.
|
CcView |
doStartPostDeliver(Stream targetStream,
CcListener integrationListener,
Feedback feedback)
In a MultiSite configuration where a team of developers works at a
remote site, the project's integration stream may be mastered at a
different replica than the developers' development streams.
|
CcView |
doStartPostDeliverActivities(Stream targetStream,
ResourceList<CcActivity> activityList,
CcListener integrationListener,
Feedback feedback)
Post deliver the specified activities from the source stream associated
with this view to the target stream associated with the specified
integration view.
|
CcView |
doStartPostDeliverBaselines(Stream targetStream,
ResourceList<CcBaseline> baselineList,
CcListener integrationListener,
Feedback feedback)
Post deliver the specified baselines from the source stream associated
with this view to the target stream.
|
CcView |
doStartRebase(List<CcBaseline> baselineList,
boolean doAutoMerge,
CcListener integrationListener,
CcListener updateListener,
Feedback feedback)
The rebase command reconfigures a stream by adding, dropping, or
replacing one or more of the stream's foundation baselines.
|
CcView |
doSynchronizeFileAreaDb(CcView.SynchronizeFileAreaDbFlag[] flags,
Feedback feedback)
Synchronize this web view file area's local databases to accurately reflect the
current state of the file area.
|
CcView |
doUpgradeFileArea(Feedback feedback)
Upgrade this web view's file area.
|
CcView |
doWorkOnActivity(StpActivity act,
Feedback feedback)
Work on the specified activity in this CC view.
|
Boolean |
getArePermissionsValid()
Returns the value of this proxy's
ARE_PERMISSIONS_VALID property. |
ResourceList<CcDirectory> |
getComponentRootDirectoryList()
Returns the value of the
COMPONENT_ROOT_DIRECTORY_LIST property. |
CcConfigSpec |
getConfigSpec()
Get the value of this view's
CONFIG_SPEC property. |
boolean |
getFileAreaNeedsUpgrade()
Get the value of this view's
FILE_AREA_NEEDS_UPGRADE property. |
File |
getFileAreaRootDirectory()
Returns the value of the
FILE_AREA_ROOT_DIRECTORY property. |
Boolean |
getIsExpress()
Returns the value of this proxy's
IS_EXPRESS property. |
Boolean |
getIsReadOnly()
Returns the value of this proxy's
IS_READ_ONLY property. |
boolean |
getIsUcmView()
Get the value of this view's
IS_UCM_VIEW property. |
Map<String,Resource> |
getLoadedChildMap()
Get the value of this proxy's
LOADED_CHILD_MAP property. |
ResourceList<CcVobTag> |
getMountedVobTagList()
Returns the value of this proxy's
MOUNTED_VOB_TAG_LIST property. |
CcPermissions |
getPermissions()
Returns the value of this proxy's
PERMISSIONS property. |
Boolean |
getPreserveVobModifiedTime()
Get the value of this view's
PRESERVE_VOB_MODIFIED_TIME property. |
String |
getServerUrl()
Get the value of this proxy's
SERVER_URL property. |
String |
getSharedCleartextStoragePath()
Get the value of this view's
SHARED_CLEARTEXT_STORAGE_PATH
property. |
Boolean |
getShareDerivedObjects()
Get the value of this view's
SHARE_DERIVED_OBJECTS property. |
CcView.TextMode |
getTextMode()
Get the value of this view's
TEXT_MODE property. |
CcViewAccessInfo |
getViewAccessInfo()
Returns the value of this proxy's
VIEW_ACCESS_INFO property. |
String |
getViewStoragePath()
Returns the value of this proxy's
VIEW_STORAGE_PATH property. |
CcViewTag |
getViewTag()
Get the value of this proxy's
VIEW_TAG property. |
String |
getViewTagString()
Get the value of this proxy's
VIEW_TAG_STRING property. |
CcViewTag.ViewType |
getViewType()
Returns the value of this proxy's
VIEW_TYPE property. |
String |
getViewUuidString()
Get the value of this proxy's
VIEW_UUID_STRING property. |
boolean |
isRefreshInProgress()
If this view type supports asynchronous refresh (currently only Automatic Views
do this), check to see if a refresh is currently in progress for this view.
|
void |
registerFileArea()
Register this local web view's file area in the local file area registry.
|
void |
setColocatedStorage(Boolean colocatedStorage)
Set the
COLOCATED_STORAGE property. |
void |
setConfigSpec(CcConfigSpec configSpec)
Set the value of this view's
CONFIG_SPEC property. |
void |
setPreserveVobModifiedTime(Boolean preserveVobModifiedTime)
Set the
PRESERVE_VOB_MODIFIED_TIME property. |
void |
setRegion(CcRegistryRegion region)
Set the value of this view's
REGION property. |
void |
setSharedCleartextStoragePath(String path)
Set the value of this view's
SHARED_CLEARTEXT_STORAGE_PATH
property. |
void |
setShareDerivedObjects(Boolean shareDerivedObjects)
Set the value of this view's
SHARE_DERIVED_OBJECTS property. |
void |
setStream(Stream stream)
Set the
Workspace.STREAM property. |
void |
setTextMode(CcView.TextMode textMode)
Set the value of this view's
TEXT_MODE property. |
void |
setViewStorageLocation(CcStorageLocation viewStorageLocation)
Set the value of this view's
VIEW_STORAGE_LOCATION property. |
void |
setViewStoragePath(String viewStoragePath)
Set the value of this view's
VIEW_STORAGE_PATH property. |
void |
setViewTagString(String viewTag)
Set the value of this view's
VIEW_TAG_STRING property. |
void |
setViewType(CcViewTag.ViewType viewType)
Set the value of this view's
VIEW_TYPE property. |
void |
unregisterFileArea()
Remove this local web view's file area from the local file area registry.
|
void |
updateServerUrl(String updatedUrl)
Change the URL used to connect to the CCRC WAN server on which this view resides.
|
createCcDirectory, getAggregatedCheckoutList, getAggregatedHijackList, getAggregatedViewPrivateList, getEclipsedList, getHasDescendantCheckouts, getHasDescendantHijacks, getIsVobRoot
clientResourceFile, createCcFile, doApplyAttribute, doApplyLabel, doApplyLabel, doApplyRolemap, doCcCheckin, doCcCheckout, doCcRefresh, doCcVersionControl, doCheckin, doLoad, doMerge, doRefresh, doRemoveAttribute, doRemoveLabel, doRestore, doUncheckout, doUnhijack, doVersionControl, getClientPath, getElement, getElementType, getIsDbFile, getIsEclipsing, getIsHijacked, getIsSymlink, getLatestVersionOnBranch, getLoadState, getParent, getSelectionRule, getSkewedPropertyList, getSymlinkTargetPath, getVersion, getVersionOid, getViewRelativePath, getVobTag, hijack, readContent, readProperties, resolve, setElementType, setFromFile
ccProvider, doReadContent, doResolve, doWriteProperties, hasSupportedProperties, isResolved, readProperties, writeProperties, writeProperties
doReadProperties, equals, getAllProperties, getAuthenticationRealm, getCreatorGroupName, getCreatorLoginName, getCustomProperties, getEfficientLocation, getInvalidProperties, getMetaProperties, getPropertyException, getRepository, getResourceError, getResourceIdentifier, getStableLocation, getUserFriendlyLocation, hashCode, hasProperties, initMetaProperty, proxyType, setPropertyClean, stpLocation, stpProvider
doCopy, doFind, doFindAll, doGetPropertyNameList, doGetPropertyNameList, doReadContent, doReadProperties, doUnbindAll, doWriteContent, doWriteProperties, forgetProperty, getComment, getContentCharacterSet, getContentIdentifier, getContentLanguage, getContentLength, getContentType, getCreationDate, getCreatorDisplayName, getDisplayName, getIsExecutable, getLastModified, getParentList, getPathnameLocation, getProperty, getProviderList, getWorkspaceFolderList, initProperty, location, lookupProperty, modifyLocation, propertyNameList, provider, removeProperty, setComment, setContentCharacterSet, setContentLanguage, setContentType, setCreatorDisplayName, setDisplayName, setIsExecutable, setProperty, setProperty, updatedPropertyNameList
doCheckin, doCheckinAll, doCreateGeneratedResource, doMerge, doMergePreviewReport, doUpdate, doVersionControl, getActivityFolderList, getBaselineControlledFolderList, getConfigurationRootFolderHome, getControllableResourceHome, getCurrentActivity, getIsolatedTarget, getSourceList, getStream, getTarget, getVersionHistoryFolderList, getWorkspaceCheckoutList, setCurrentActivity, setIsolatedTarget, setSourceList, setTarget
doBaselineControl, doCreateBaselineControlledFolder, getIsBaselineControllable, getIsBaselineControlled, getRootFolderOf
doAddLabel, doCheckout, doCreateResource, doCreateVersionControlledResource, doReadLabelledVersionProperties, doRemoveLabel, doSetLabel, doUncheckout, getActivity, getAutoMergeList, getCheckedIn, getCheckedOut, getConfiguration, getIsCheckedOut, getIsVersionControllable, getIsVersionControlled, getMergeList, getPredecessorList, getReserved, getVersionHistory, getWorkspace, setActivity, setAutoMergeList, setMergeList, setPredecessorList, setReserved, workspaceProvider
doBindChild, doReadMemberList, doRebindAll, doRebindChild, doUnbindChild, getChildList, getChildMap
static final PropertyNameList.PropertyName<Boolean> ARE_PERMISSIONS_VALID
static final PropertyNameList.PropertyName<Boolean> COLOCATED_STORAGE
static final PropertyNameList.PropertyName<ResourceList<CcDirectory>> COMPONENT_ROOT_DIRECTORY_LIST
static final PropertyNameList.PropertyName<CcConfigSpec> CONFIG_SPEC
static final PropertyNameList.PropertyName<Boolean> FILE_AREA_NEEDS_UPGRADE
doUpgradeFileArea(Feedback)
static final PropertyNameList.PropertyName<File> FILE_AREA_ROOT_DIRECTORY
static final PropertyNameList.PropertyName<Boolean> IS_EXPRESS
static final PropertyNameList.PropertyName<Boolean> IS_READ_ONLY
static final PropertyNameList.PropertyName<Boolean> IS_UCM_VIEW
static final PropertyNameList.PropertyName<Map<String,Resource>> LOADED_CHILD_MAP
Folder.CHILD_MAP
property
returns the root directories of all VOBs, LOADED_CHILD_MAP only
returns the root directories of VOBs that are partially or fully loaded
in this view (if this is a web view or snapshot view) or mounted (if
this is a dynamic view or automatic view). In an automatic view, only
the mount state of a VOB is relevant, load state is ignored.static final PropertyNameList.PropertyName<ResourceList<CcVobTag>> MOUNTED_VOB_TAG_LIST
static final PropertyNameList.PropertyName<CcPermissions> PERMISSIONS
The permissions applied to this resource.
static final PropertyNameList.PropertyName<Boolean> PRESERVE_VOB_MODIFIED_TIME
true
, time is preserved, if false
the current
time is used. If unspecified, the default is false
.
This property can only be set at creation time, and only for
automatic and snapshot views.For automatic views, this setting persists for the lifetime of the view.
For snapshot views, it is an initial setting that may be changed depending on the flag for subsequent update operations.
static final PropertyNameList.PropertyName<CcRegistryRegion> REGION
static final PropertyNameList.PropertyName<String> SERVER_URL
static final PropertyNameList.PropertyName<Boolean> SHARE_DERIVED_OBJECTS
static final PropertyNameList.PropertyName<String> SHARED_CLEARTEXT_STORAGE_PATH
static final PropertyNameList.PropertyName<CcView.TextMode> TEXT_MODE
CcView.TextMode.TRANSPARENT
.static final PropertyNameList.PropertyName<CcViewAccessInfo> VIEW_ACCESS_INFO
static final PropertyNameList.PropertyName<CcStorageLocation> VIEW_STORAGE_LOCATION
static final PropertyNameList.PropertyName<String> VIEW_STORAGE_PATH
static final PropertyNameList.PropertyName<CcViewTag> VIEW_TAG
CcViewTag
resource.static final PropertyNameList.PropertyName<String> VIEW_TAG_STRING
static final PropertyNameList.PropertyName<CcViewTag.ViewType> VIEW_TYPE
static final PropertyNameList.PropertyName<String> VIEW_UUID_STRING
boolean breakFileAreaLock(CcFileAreaLockedCallback.CcFileAreaLockInfo lockInfo) throws WvcmException
lockInfo
- information about the lockWvcmException
- if a problem occurred breaking the lockStpActivity doBindActivity(StpActivity act, Feedback feedback) throws WvcmException
Binds a CcActivity proxy to a CqRecord proxy without making the activity the current one for this view.
NOTE: Unlike most API methods, the optional property request will be executed on the returned StpActivity, not the CcView proxy on which the method was invoked.
act
can either be a CcActivity proxy or a CqRecord proxy.
If act
is a CcActivity proxy and the associated project is
not CQ enabled, this operation simply executes the provided property
request -- if any. If the project is CQ enabled, it additionally validates
that the bound CQ record is in an active state.
If act
is a CqRecord proxy, this operation is more
involved. First, act
is automatically transitioned to an
active state. If this transition involves required fields, the caller
may be prompted to provide values for those fields. Next a CcActivity
resource is created in this view's stream and is bound to
act
.
act
- the activity to work on - either a CqRecord or CcActivityfeedback
- optional property requestWvcmException
Workspace.CURRENT_ACTIVITY
,
StpActivity.BOUND_CC_ACTIVITY
,
StpActivity.BOUND_CQ_RECORD
CcView doCancelDeliver(CcView integrationView, CcListener integrationListener, CcMergeElement[] mergeElements, Feedback feedback) throws WvcmException
Halt a deliver operation in progress, returning the source and destination streams to their states before the deliver operation began. Note: This method cannot cancel a deliver operation after the completion phase has begun. See ClearCase cleartool deliver man page for details.
integrationView
- the target view to deliver tointegrationListener
- optional listener to get feedback on operationmergeElements
- optional list of client maintained
CcMergeElement
s to allow the operation to cancel any
checkoutsfeedback
- optional property requestWvcmException
- if there is an error cancelling the deliver
operationCcView doCancelRebase(CcListener integrationListener, CcListener updateListener, Feedback feedback) throws WvcmException
Cancels a rebase operation and restores the stream's previous configuration. Deletes the integration activity and any versions created by the rebase operation that are not yet checked in.
Preconditions:
integrationListener
- optional listener to get feedback on operationupdateListener
- optional listener to get feedback on view update
changesfeedback
- optional property requestWvcmException
- if there is an error canceling the
rebase operationCcView doCcRestore(CcFile.RefreshFlag[] flags, Vector<String> paths, Feedback feedback) throws WvcmException
WvcmException
CcView doCompleteDeliver(CcView integrationView, CcListener integrationListener, CcMergeElement[] mergeElements, Feedback feedback) throws WvcmException
Complete in-progress deliver operation taking the following actions:
If unresolved merge conflicts exist, the deliver operation is suspended.
integrationView
- the target view to deliver tointegrationListener
- optional listener to get feedback on operationmergeElements
- optional list of client maintained
CcMergeElement
s to allow the operation to cancel any
checkoutsfeedback
- optional property requestWvcmException
- if there is an error completing the deliver
operationCcView doCompleteRebase(CcListener integrationListener, CcListener updateListener, Feedback feedback) throws WvcmException
Completes a rebase operation taking the following actions:
integrationListener
- optional listener to get feedback on operationupdateListener
- optional listener to get feedback on view update
changesfeedback
- optional property requestWvcmException
- if there is an error completing the
rebase operationCcView doCreateCcAutomaticView(Feedback feedback) throws WvcmException
Create a new ClearCase automatic view based on this CcView proxy.
Preconditions:
Postconditions:
WvcmException
- if the preconditions are not met, or if there is an
error creating the view.CcView doCreateCcDynamicView(Feedback feedback) throws WvcmException
Create a new ClearCase dynamic view based on this CcView proxy.
Preconditions:
Postconditions:
WvcmException
- if the preconditions are not met, or if there is an
error creating the view.CcView doCreateCcSnapshotView(Feedback feedback) throws WvcmException
Create a new ClearCase snapshot view based on this CcView proxy.
Preconditions:
Postconditions:
WvcmException
- if the preconditions are not met, or if there is an
error creating the view.CcView doCreateCcWebView(Feedback feedback) throws WvcmException
Create a new ClearCase web view based on this CcView proxy.
Preconditions:
Postconditions:
WvcmException
- if the preconditions are not met, or if there is an
error creating the view.CcView doFindMergeCandidates(CcFindmergeListener listener, CcView.FindmergeFlag[] flags, CcViewTag fromViewTag, List<CcFile> elements, Feedback feedback) throws WvcmException
Runs findmerge command in this view. Searches the specified elements for merge candidates using the specified View resource as a search criteria. Flags further define the search criteria. Found merge candidates are returned through the listener.
listener
- optional listener to get feedback on operation.
Note: although a listener is not required, that is the only way for a consumer of this method
to receive the results of the findmerge operation.flags
- array of flags which specify the behavior of the operationfromViewTag
- View tag to use as a search criteria;feedback
- optional property requestWvcmException
- if there is an error completing the findmerge operationWvcmException
CcView doFindMergeCandidates(CcFindmergeListener listener, CcView.FindmergeFlag[] flags, CcVobResource fromVobResource, List<CcFile> elements, Feedback feedback) throws WvcmException
Runs findmerge command in this view. Searches the specified elements for merge candidates using the specified VOB resource as a search criteria. The VOB resource can be either a branch type, or a label type, or a version. Flags further define the search criteria. Found merge candidates are returned through the listener.
listener
- optional listener to get feedback on operation.
Note: although a listener is not required, that is the only way for a consumer of this method
to receive the results of the findmerge operation.flags
- array of flags which specify the behavior of the operationfromVobResource
- VOB resource to use as a search criteria; Legal argument types include
CcBranchType, CcLabelType and CcVersionfeedback
- optional property requestWvcmException
- if there is an error completing the findmerge operationWvcmException
CcView doFindMergeCandidatesFromChangeSets(CcFindmergeListener listener, CcView.FindmergeFlag[] flags, List<CcActivity> activities, Feedback feedback) throws WvcmException
Runs findmerge command in this view. The specified activities are used as the search criteria. Flags further define the search criteria. Found merge candidates are returned through the listener.
listener
- optional listener to get feedback on operation.
Note: although a listener is not required, that is the only way for a consumer of this method
to receive the results of the findmerge operation.flags
- array of flags which specify the behavior of the operationactivities
- list of activities whose change sets to search for merge candidatesfeedback
- optional property requestWvcmException
- if there is an error completing the findmerge operationStpActivity doFinishActivity(StpActivity act, Feedback feedback) throws WvcmException
Transitions the specified activity to the default completed state.
act
can either be a CcActivity proxy or a CqRecord proxy.
NOTE: Unlike most API methods, the optional property request will be executed on the returned StpActivity, not the CcView proxy on which the method was invoked.
Preconditions:
act
is a bound CqRecord/CcActivity pair in a CQ-enabled
context.Postconditions:
act
's CcActivity has checkouts, the operation is
cancelled and there is no change to the activity.act
's CqRecord to the default completed state.
If this transition involves required fields, the caller may be prompted
to provide values for those fields.act
's CcActivity from all views'
Workspace.CURRENT_ACTIVITY
property.act
- the activity to finishfeedback
- optional property request for the activityWvcmException
- if the preconditions are not met.CcView doResetDeliver(CcView integrationView, CcListener integrationListener, Feedback feedback) throws WvcmException
Resets a deliver operation in progress to use the new integration view
integrationView
- the new integration viewintegrationListener
- optional listener to get feedback on operationfeedback
- optional property requestWvcmException
- if there is an error resuming the deliver operationCcView doResumeDeliver(CcView integrationView, CcListener integrationListener, Feedback feedback) throws WvcmException
Resumes a deliver operation from the point at which it was suspended.
integrationView
- the target view to deliver tointegrationListener
- optional listener to get feedback on operationfeedback
- optional property requestWvcmException
- if there is an error resuming the deliver operationCcView doResumeRebase(boolean doAutoMerge, CcListener integrationListener, CcListener updateListener, Feedback feedback) throws WvcmException
Restarts a rebase operation from the point at which it has been
suspended. A rebase operation can be interrupted or when it encounters an
external error or condition that requires more information. However, you
cannot resume a rebase operation that has been successfully halted with
the CcView.doCancelRebase()
operation.
doAutoMerge
- tells the rebase operation to attempt auto mergesintegrationListener
- optional listener to get feedback on operationupdateListener
- optional listener to get feedback on view update
changesfeedback
- optional property requestWvcmException
- if there is an error resuming the rebase operationCcView doStartDeliver(CcView integrationView, boolean doAutoMerge, CcListener integrationListener, Feedback feedback) throws WvcmException
The deliver command lets you deliver work from a source stream to a
target stream in the same or a different project. This method delivers
all activities in the stream that have changed since the last deliver
operation from the stream. The target stream is determined by the
CcView
integration view passed to this method.
Preconditions:
Postconditions:
integrationView
- the target view to deliver todoAutoMerge
- tells the deliver operation to attempt auto mergesintegrationListener
- optional listener to get feedback on operationfeedback
- optional property requestWvcmException
- if there is an error starting the deliver operationCcView doStartDeliverActivities(CcView integrationView, ResourceList<CcActivity> activityList, boolean doAutoMerge, CcListener integrationListener, Feedback feedback) throws WvcmException
Deliver the specified activities from the source stream associated with this view to the target stream associated with the specified integration view. The list of activities must be self-consistent: the activities specified must not depend on the inclusion of any unspecified activities. Refer to the ClearCase cleartool deliver man page for more details.
Preconditions:
Postconditions:
integrationView
- the target view to deliver toactivityList
- optional list of activities to deliverdoAutoMerge
- tells the deliver operation to attempt auto mergesintegrationListener
- optional listener to get feedback on operationfeedback
- optional property requestWvcmException
- if there is an error starting the deliver operationCcView doStartDeliverBaselines(CcView integrationView, ResourceList<CcBaseline> baselineList, boolean doAutoMerge, CcListener integrationListener, Feedback feedback) throws WvcmException
Deliver the specified baselines from the source stream associated with this view to the target stream associated with the specified integration view. A development stream can deliver activities or baselines, but an integration stream can deliver only baselines. Refer to the ClearCase cleartool deliver man page for more details.
Preconditions:
Postconditions:
integrationView
- the target view to deliver tobaselineList
- list of baselines to deliverdoAutoMerge
- tells the deliver operation to attempt auto mergesintegrationListener
- optional listener to get feedback on operationfeedback
- optional property requestWvcmException
- if there is an error starting the deliver operationCcView doStartPostDeliver(Stream targetStream, CcListener integrationListener, Feedback feedback) throws WvcmException
In a MultiSite configuration where a team of developers works at a
remote site, the project's integration stream may be mastered at a
different replica than the developers' development streams. In this
situation, the developers cannot complete deliver operations to the
integration stream. When such a stream mastership situation is
detected, the deliver operation starts but no versions are merged.
Instead, the deliver operation is left in a posted state. You must
periodically find and complete posted deliver operations. The post
deliver command lets you do such the delivery work from a source
stream to a target stream in the same or a different project. This
method delivers all activities in the stream that have changed since
the last deliver operation from the stream. The target stream is
determined by the Stream
targetStream passed to this
method.
Preconditions:
Postconditions:
targetStream
- the target stream to deliver tointegrationListener
- optional listener to get feedback on operationfeedback
- optional property requestWvcmException
- if there is an error starting the deliver operationCcView doStartPostDeliverActivities(Stream targetStream, ResourceList<CcActivity> activityList, CcListener integrationListener, Feedback feedback) throws WvcmException
Post deliver the specified activities from the source stream associated with this view to the target stream associated with the specified integration view. The list of activities must be self-consistent: the activities specified must not depend on the inclusion of any unspecified activities. Refer to the ClearCase cleartool deliver man page for more details.
Preconditions:
Postconditions:
targetStream
- the target stream to deliver toactivityList
- optional list of activities to deliverintegrationListener
- optional listener to get feedback on operationfeedback
- optional property requestWvcmException
- if there is an error starting the deliver operationCcView doStartPostDeliverBaselines(Stream targetStream, ResourceList<CcBaseline> baselineList, CcListener integrationListener, Feedback feedback) throws WvcmException
Post deliver the specified baselines from the source stream associated with this view to the target stream. A development stream can deliver activities or baselines, but an integration stream can deliver only baselines. Refer to the ClearCase cleartool deliver man page for more details.
Preconditions:
Postconditions:
targetStream
- the target stream to deliver tobaselineList
- list of baselines to deliverintegrationListener
- optional listener to get feedback on operationfeedback
- optional property requestWvcmException
- if there is an error starting the deliver operationCcView doStartRebase(List<CcBaseline> baselineList, boolean doAutoMerge, CcListener integrationListener, CcListener updateListener, Feedback feedback) throws WvcmException
The rebase command reconfigures a stream by adding, dropping, or replacing one or more of the stream's foundation baselines. The file and directory versions selected by those new baselines (and thus their associated activities) then become visible in the stream's views.
Preconditions:
Postconditions:
baselineList
is specified and those baselines meet
the preconditions above, the rebase will be started to those baselines.baselineList
is not specified, the rebase will be
started to the source stream's recommended baselines.doAutoMerge
is true, elements needing merge will
attempt to automatically merge on the server.baselineList
- optional list of baselines to includedoAutoMerge
- tells the rebase operation to attempt auto mergesintegrationListener
- optional listener to get feedback on operationupdateListener
- optional listener to get feedback on view update
changesfeedback
- optional property requestWvcmException
- if there is an error starting the rebase operationCcView doSynchronizeFileAreaDb(CcView.SynchronizeFileAreaDbFlag[] flags, Feedback feedback) throws WvcmException
Synchronize this web view file area's local databases to accurately reflect the current state of the file area. The databases available to synchronize are:
flags
- array of flags which specify the databases to synchronize.feedback
- optional property request for the viewWvcmException
CcView doUpgradeFileArea(Feedback feedback) throws WvcmException
Upgrade this web view's file area.
Preconditions:
Postconditions:
This operation has no effect on non-web views, and on web views that are already compatible.
WvcmException
- if the preconditions are not met, or if there is an
error upgrading the file area.CcView doWorkOnActivity(StpActivity act, Feedback feedback) throws WvcmException
act
can either be a CcActivity proxy or a CqRecord proxy.
If act
is a CcActivity proxy and the associated project is
not CQ enabled, this operation simply makes it the current activity
in this view. If the project is CQ enabled, it additionally validates
that the bound CQ record is in an active state.
If act
is a CqRecord proxy, this operation is more
involved. First, act
is automatically transitioned to an
active state. If this transition involves required fields, the caller
may be prompted to provide values for those fields. Next a CcActivity
resource is created in this view's stream and is bound to
act
. Finally, it makes the new CC activity resource the
current activity in this view.
act
- the activity to work on - either a CqRecord or CcActivityfeedback
- optional property requestWvcmException
Workspace.CURRENT_ACTIVITY
,
StpActivity.BOUND_CC_ACTIVITY
,
StpActivity.BOUND_CQ_RECORD
Boolean getArePermissionsValid() throws WvcmException
ARE_PERMISSIONS_VALID
property.WvcmException
- if this proxy doesn't define a value for this property.ResourceList<CcDirectory> getComponentRootDirectoryList() throws WvcmException
COMPONENT_ROOT_DIRECTORY_LIST
property.WvcmException
- if this property is not defined by this proxy.CcConfigSpec getConfigSpec() throws WvcmException
CONFIG_SPEC
property.WvcmException
boolean getFileAreaNeedsUpgrade() throws WvcmException
FILE_AREA_NEEDS_UPGRADE
property.WvcmException
- if this property is not defined by this proxy.File getFileAreaRootDirectory() throws WvcmException
FILE_AREA_ROOT_DIRECTORY
property.WvcmException
- if this property is not defined by this proxy.Boolean getIsExpress() throws WvcmException
IS_EXPRESS
property.WvcmException
- if this proxy doesn't define a value for this property.Boolean getIsReadOnly() throws WvcmException
IS_READ_ONLY
property.WvcmException
- if this proxy doesn't define a value for this property.boolean getIsUcmView() throws WvcmException
IS_UCM_VIEW
property.WvcmException
- if this property is not defined by this proxy.Map<String,Resource> getLoadedChildMap() throws WvcmException
LOADED_CHILD_MAP
property.WvcmException
- if this proxy doesn't define a value for this property.ResourceList<CcVobTag> getMountedVobTagList() throws WvcmException
MOUNTED_VOB_TAG_LIST
property.WvcmException
- if this proxy doesn't define a value for this property.CcPermissions getPermissions() throws WvcmException
PERMISSIONS
property.WvcmException
- if this proxy doesn't define a value for this property.Boolean getPreserveVobModifiedTime() throws WvcmException
PRESERVE_VOB_MODIFIED_TIME
property.true
if file time stamps copied into the view
will preserve the VOB modification time, false
otherwiseWvcmException
String getServerUrl() throws WvcmException
SERVER_URL
property.WvcmException
- if this proxy doesn't define a value for this property.String getSharedCleartextStoragePath() throws WvcmException
SHARED_CLEARTEXT_STORAGE_PATH
property.
Only supported for automatic viewsWvcmException
Boolean getShareDerivedObjects() throws WvcmException
SHARE_DERIVED_OBJECTS
property.WvcmException
CcView.TextMode getTextMode() throws WvcmException
TEXT_MODE
property.WvcmException
- if this proxy doesn't define a value for this property.CcViewAccessInfo getViewAccessInfo() throws WvcmException
VIEW_ACCESS_INFO
property.WvcmException
- if this proxy doesn't define a value for this property.String getViewStoragePath() throws WvcmException
VIEW_STORAGE_PATH
property.WvcmException
- if this proxy doesn't define a value for this property.CcViewTag getViewTag() throws WvcmException
VIEW_TAG
property.WvcmException
- if this proxy doesn't define a value for this property.String getViewTagString() throws WvcmException
VIEW_TAG_STRING
property.WvcmException
- if this proxy doesn't define a value for this property.CcViewTag.ViewType getViewType() throws WvcmException
VIEW_TYPE
property.WvcmException
- if this proxy doesn't define a value for this property.String getViewUuidString() throws WvcmException
VIEW_UUID_STRING
property.WvcmException
- if this proxy doesn't define a value for this property.boolean isRefreshInProgress() throws WvcmException
true
if a refresh is in progress for this view, false
if one
is not or the view does not support asynchronous refresh.WvcmException
void registerFileArea() throws WvcmException
WvcmException
void setColocatedStorage(Boolean colocatedStorage)
COLOCATED_STORAGE
property.
This property may only be set at view creation time and only for
snapshot views.
It is a write-only property.colocatedStorage
- true to create view's storage directory
as a subdirectory of the snapshot view directory, false otherwise.
The value will default to false if not set at view creation.void setConfigSpec(CcConfigSpec configSpec)
CONFIG_SPEC
property.configSpec
- the new config spec for this viewvoid setPreserveVobModifiedTime(Boolean preserveVobModifiedTime)
PRESERVE_VOB_MODIFIED_TIME
property.
This property may only be set at view creation time and only for
automatic and snapshot views.
If unspecified, VOB modification time will not be used
when copying files to the view.For automatic views, this setting persists for the lifetime of the view.
For snapshot views, it is an initial setting that may be changed depending on the flag for subsequent update operations.
preserveVobModifiedTime
- true
to preserve the VOB modified
time when copying files to the view, false
to use current time.void setRegion(CcRegistryRegion region)
REGION
property. This
property may only be set at view creation time.
This is a write only property.
If unspecified, the local host's network region will be used.region
- network region in which to register the viewvoid setSharedCleartextStoragePath(String path)
SHARED_CLEARTEXT_STORAGE_PATH
property. This property may only be set at view creation time and
only for automatic views.
If unspecified, the product default directory is used.void setShareDerivedObjects(Boolean shareDerivedObjects)
SHARE_DERIVED_OBJECTS
property. This
property may only be set at view creation time.
If unspecified, site-wide default is used.
If unspecified and no site-wide default, derived objects will be shared.shareDerivedObjects
- true to make derived objects available for winkin
by other views, otherwise falsevoid setStream(Stream stream)
Workspace.STREAM
property.stream
- the Stream
object that
identifies the Workspace.STREAM
for this Workspace.Workspace.getStream()
void setTextMode(CcView.TextMode textMode)
TEXT_MODE
property. This
property may only be set at view creation time.textMode
- the text mode of the view.void setViewStorageLocation(CcStorageLocation viewStorageLocation)
VIEW_STORAGE_LOCATION
property.
This property may only be set at view creation time.
It is a write-only property.viewStorageLocation
- the storage location for the new viewvoid setViewStoragePath(String viewStoragePath)
VIEW_STORAGE_PATH
property.
This property may only be set at view creation time.viewStoragePath
- the storage path for the new viewvoid setViewTagString(String viewTag)
VIEW_TAG_STRING
property.
This property may only be set at view creation time.viewTag
- the view tag for the new viewvoid setViewType(CcViewTag.ViewType viewType)
VIEW_TYPE
property.
This property may only be set at view creation time and
is used by ControllableResource.doCreateResource(Feedback)
to specify
the type of view to be created. If not view type has been set,
ControllableResource.doCreateResource(Feedback)
will create a web
view by default.viewType
- the type of view to be createdvoid unregisterFileArea() throws WvcmException
void updateServerUrl(String updatedUrl) throws WvcmException
This may be necessary if, for example:
updatedUrl
- the updated URL of this view's CCRC WAN serverWvcmException
Copyright © IBM 2017. All rights reserved.