Project: stp

com.ibm.rational.wvcm.stp.cc
Interface CcView

All Superinterfaces:
CcDirectory, CcFile, CcResource, ControllableFolder, ControllableResource, Folder, Resource, StpResource, Workspace

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 release, CM API supports web views and dynamic views. ClearCase snapshot views are not currently supported.


Nested Class Summary
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
 
Nested classes/interfaces inherited from interface CcFile
CcFile.ApplyLabelFlag, CcFile.AttributeOpFlag, CcFile.CcCheckoutFlag, CcFile.CcVersionControlFlag, CcFile.LoadState, CcFile.RefreshFlag, CcFile.RemoveLabelFlag, CcFile.UncheckoutFlag, CcFile.UnhijackFlag
 
Nested classes/interfaces inherited from interface com.ibm.rational.wvcm.stp.StpResource
StpResource.UnsupportedProperty
 
Nested classes/interfaces inherited from interface javax.wvcm.Resource
Resource.CopyFlag
 
Nested classes/interfaces inherited from interface javax.wvcm.Workspace
Workspace.MergeFlag, Workspace.MergePreviewReport
 
Nested classes/interfaces inherited from interface javax.wvcm.ControllableResource
ControllableResource.CheckinFlag, ControllableResource.CheckoutFlag
 
Nested classes/interfaces inherited from interface javax.wvcm.Folder
Folder.BindFlag, Folder.RebindFlag
 
Field Summary
static PropertyNameList.PropertyName<Boolean> ARE_PERMISSIONS_VALID
          Are this view's permissions valid?
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 web 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 mounted (if this is a dynamic view).
static PropertyNameList.PropertyName<CcPermissions> PERMISSIONS
           The permissions applied to this resource.
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 view, the URL of the CCRC WAN server where this web 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<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 view, not supported for other view types.
static PropertyNameList.PropertyName<String> VIEW_STORAGE_PATH
          The storage path for a dynamic 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.
 
Fields inherited from interface CcDirectory
AGGREGATED_CHECKOUT_LIST, AGGREGATED_HIJACK_LIST, ECLIPSED_LIST, HAS_DESCENDANT_CHECKOUTS, HAS_DESCENDANT_HIJACKS, IS_VOB_ROOT
 
Fields inherited from interface CcFile
CLIENT_PATH, ELEMENT, ELEMENT_TYPE, IS_DB_FILE, 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
 
Fields inherited from interface com.ibm.rational.wvcm.stp.StpResource
ALL_PROPERTIES, AUTHENTICATION_REALM, CREATOR_GROUP_NAME, CREATOR_LOGIN_NAME, EFFICIENT_LOCATION, INVALID_PROPERTIES, REPOSITORY, STABLE_LOCATION, USER_FRIENDLY_LOCATION
 
Fields inherited from interface javax.wvcm.Resource
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
 
Fields inherited from interface javax.wvcm.Workspace
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
 
Fields inherited from interface javax.wvcm.ControllableFolder
IS_BASELINE_CONTROLLABLE, IS_BASELINE_CONTROLLED, ROOT_FOLDER_OF
 
Fields inherited from interface javax.wvcm.ControllableResource
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
 
Fields inherited from interface javax.wvcm.Folder
CHILD_LIST, CHILD_MAP
 
Method Summary
 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 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 doCreateCcDynamicView(Feedback feedback)
          Create a new ClearCase dynamic 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.
 CcPermissions getPermissions()
          Returns the value of this proxy's PERMISSIONS property.
 String getServerUrl()
          Get the value of this proxy's SERVER_URL 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.
 void registerFileArea()
          Register this local web view's file area in the local file area registry.
 void setConfigSpec(CcConfigSpec configSpec)
          Set the value of this view's CONFIG_SPEC property.
 void setRegion(CcRegistryRegion region)
          Set the value of this view's REGION 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 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 web view resides.
 
Methods inherited from interface CcDirectory
createCcDirectory, getAggregatedCheckoutList, getAggregatedHijackList, getEclipsedList, getHasDescendantCheckouts, getHasDescendantHijacks, getIsVobRoot
 
Methods inherited from interface CcFile
clientResourceFile, createCcFile, doApplyAttribute, doApplyLabel, doApplyLabel, doCcCheckout, doCcRefresh, doCcVersionControl, doCheckin, doLoad, doMerge, doRefresh, doRemoveAttribute, doRemoveLabel, doRestore, doUncheckout, doUnhijack, doVersionControl, getClientPath, getElement, getElementType, getIsDbFile, getIsHijacked, getIsSymlink, getLatestVersionOnBranch, getLoadState, getParent, getSelectionRule, getSkewedPropertyList, getSymlinkTargetPath, getVersion, getVersionOid, getViewRelativePath, getVobTag, hijack, readContent, readProperties, resolve, setElementType
 
Methods inherited from interface CcResource
ccProvider, doResolve, hasSupportedProperties, isResolved
 
Methods inherited from interface com.ibm.rational.wvcm.stp.StpResource
doReadProperties, equals, getAllProperties, getAuthenticationRealm, getCreatorGroupName, getCreatorLoginName, getCustomProperties, getEfficientLocation, getInvalidProperties, getMetaProperties, getPropertyException, getRepository, getResourceError, getResourceIdentifier, getStableLocation, getUserFriendlyLocation, hashCode, hasProperties, initMetaProperty, proxyType, setPropertyClean, stpLocation, stpProvider
 
Methods inherited from interface javax.wvcm.Resource
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
 
Methods inherited from interface javax.wvcm.Workspace
doCheckin, doCheckinAll, doCreateGeneratedResource, doMerge, doMergePreviewReport, doUpdate, doVersionControl, getActivityFolderList, getBaselineControlledFolderList, getConfigurationRootFolderHome, getControllableResourceHome, getCurrentActivity, getIsolatedTarget, getSourceList, getStream, getTarget, getVersionHistoryFolderList, getWorkspaceCheckoutList, setCurrentActivity, setIsolatedTarget, setSourceList, setTarget
 
Methods inherited from interface javax.wvcm.ControllableFolder
doBaselineControl, doCreateBaselineControlledFolder, getIsBaselineControllable, getIsBaselineControlled, getRootFolderOf
 
Methods inherited from interface javax.wvcm.ControllableResource
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
 
Methods inherited from interface javax.wvcm.Folder
doBindChild, doReadMemberList, doRebindAll, doRebindChild, doUnbindChild, getChildList, getChildMap
 

Field Detail

ARE_PERMISSIONS_VALID

static final PropertyNameList.PropertyName<Boolean> ARE_PERMISSIONS_VALID
Are this view's permissions valid?


COMPONENT_ROOT_DIRECTORY_LIST

static final 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. Always an empty list for non-UCM views.


CONFIG_SPEC

static final PropertyNameList.PropertyName<CcConfigSpec> CONFIG_SPEC
This view's config spec.


FILE_AREA_NEEDS_UPGRADE

static final 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? If so, the file area needs to be upgraded before it can be used.

See Also:
doUpgradeFileArea(Feedback)

FILE_AREA_ROOT_DIRECTORY

static final PropertyNameList.PropertyName<File> FILE_AREA_ROOT_DIRECTORY
This web view's file area root directory on the local machine. The value of this property will be null if it does not have a file area on the local machine. Only supported for web views.


IS_EXPRESS

static final PropertyNameList.PropertyName<Boolean> IS_EXPRESS
Does this view have non-shareable derived objects? This property is supported for dynamic views only.


IS_READ_ONLY

static final PropertyNameList.PropertyName<Boolean> IS_READ_ONLY
Is this view read-only?


IS_UCM_VIEW

static final PropertyNameList.PropertyName<Boolean> IS_UCM_VIEW
Is this view associated with a UCM stream?.


LOADED_CHILD_MAP

static final 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 mounted (if this is a dynamic view).


PERMISSIONS

static final PropertyNameList.PropertyName<CcPermissions> PERMISSIONS

The permissions applied to this resource.


REGION

static final PropertyNameList.PropertyName<CcRegistryRegion> REGION
Network region in which the dynamic view is registered. Not supported for other view types. This is a write only property; to determine the region for an existing view, use the CcViewTag.REGISTRY_REGION property.


SERVER_URL

static final PropertyNameList.PropertyName<String> SERVER_URL
If this is a local web view, the URL of the CCRC WAN server where this web view's view database resides.


SHARE_DERIVED_OBJECTS

static final PropertyNameList.PropertyName<Boolean> SHARE_DERIVED_OBJECTS
Should derived objects created in this view be shared and made available for winkin by other views? (Dynamic views only, not supported for other view types.)


TEXT_MODE

static final PropertyNameList.PropertyName<CcView.TextMode> TEXT_MODE
The text mode of the view. The text mode specifies the line terminator sequence for text files in the view. If no value is set upon view creation, defaults to CcView.TextMode.TRANSPARENT.


VIEW_ACCESS_INFO

static final PropertyNameList.PropertyName<CcViewAccessInfo> VIEW_ACCESS_INFO
CcViewAccessInfo object contains the supported view access properties.


VIEW_STORAGE_LOCATION

static final PropertyNameList.PropertyName<CcStorageLocation> VIEW_STORAGE_LOCATION
The storage location for a dynamic view, not supported for other view types.


VIEW_STORAGE_PATH

static final PropertyNameList.PropertyName<String> VIEW_STORAGE_PATH
The storage path for a dynamic view, not supported for other view types.


VIEW_TAG

static final PropertyNameList.PropertyName<CcViewTag> VIEW_TAG
This view's view tag as a CcViewTag resource.


VIEW_TAG_STRING

static final PropertyNameList.PropertyName<String> VIEW_TAG_STRING
This view's view tag as a string.


VIEW_TYPE

static final PropertyNameList.PropertyName<CcViewTag.ViewType> VIEW_TYPE
Kind of view to which this tag refers


VIEW_UUID_STRING

static final PropertyNameList.PropertyName<String> VIEW_UUID_STRING
This view's uuid as a string.

Method Detail

breakFileAreaLock

boolean breakFileAreaLock(CcFileAreaLockedCallback.CcFileAreaLockInfo lockInfo)
                          throws WvcmException
Break a file area lock on this web view with the given lock info.

Parameters:
lockInfo - information about the lock
Returns:
true if the lock was broken; false otherwise
Throws:
WvcmException - if a problem occurred breaking the lock

doBindActivity

StpActivity 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.

Parameters:
act - the activity to work on - either a CqRecord or CcActivity
feedback - optional property request
Returns:
new proxy for the StpActivity, with requested properties
Throws:
WvcmException
See Also:
Workspace.CURRENT_ACTIVITY, StpActivity.BOUND_CC_ACTIVITY, StpActivity.BOUND_CQ_RECORD

doCancelDeliver

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.

Parameters:
integrationView - the target view to deliver to
integrationListener - optional listener to get feedback on operation
mergeElements - optional list of client maintained CcMergeElements to allow the operation to cancel any checkouts
feedback - optional property request
Returns:
new proxy to the view with requested properties
Throws:
WvcmException - if there is an error cancelling the deliver operation

doCancelRebase

CcView 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:

Parameters:
integrationListener - optional listener to get feedback on operation
updateListener - optional listener to get feedback on view update changes
feedback - optional property request
Returns:
new proxy to the view with requested properties
Throws:
WvcmException - if there is an error canceling the rebase operation

doCompleteDeliver

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.

Parameters:
integrationView - the target view to deliver to
integrationListener - optional listener to get feedback on operation
mergeElements - optional list of client maintained CcMergeElements to allow the operation to cancel any checkouts
feedback - optional property request
Returns:
new proxy to the view with requested properties
Throws:
WvcmException - if there is an error completing the deliver operation

doCompleteRebase

CcView doCompleteRebase(CcListener integrationListener,
                        CcListener updateListener,
                        Feedback feedback)
                        throws WvcmException

Completes a rebase operation taking the following actions:

Parameters:
integrationListener - optional listener to get feedback on operation
updateListener - optional listener to get feedback on view update changes
feedback - optional property request
Returns:
new proxy to the view with requested properties
Throws:
WvcmException - if there is an error completing the rebase operation

doCreateCcDynamicView

CcView doCreateCcDynamicView(Feedback feedback)
                             throws WvcmException

Create a new ClearCase dynamic view based on this CcView proxy.

Preconditions:

Postconditions:

Throws:
WvcmException - if the preconditions are not met, or if there is an error creating the view.

doCreateCcWebView

CcView doCreateCcWebView(Feedback feedback)
                         throws WvcmException

Create a new ClearCase web view based on this CcView proxy.

Preconditions:

Postconditions:

Throws:
WvcmException - if the preconditions are not met, or if there is an error creating the view.

doFindMergeCandidates

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.

Parameters:
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 operation
fromViewTag - View tag to use as a search criteria;
feedback - optional property request
Returns:
new proxy to the view with requested properties
Throws:
WvcmException - if there is an error completing the findmerge operation
WvcmException

doFindMergeCandidates

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.

Parameters:
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 operation
fromVobResource - VOB resource to use as a search criteria; Legal argument types include CcBranchType, CcLabelType and CcVersion
feedback - optional property request
Returns:
new proxy to the view with requested properties
Throws:
WvcmException - if there is an error completing the findmerge operation
WvcmException

doFindMergeCandidatesFromChangeSets

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.

Parameters:
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 operation
activities - list of activities whose change sets to search for merge candidates
feedback - optional property request
Returns:
new proxy to the view with requested properties
Throws:
WvcmException - if there is an error completing the findmerge operation

doFinishActivity

StpActivity 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:

Postconditions:

Parameters:
act - the activity to finish
feedback - optional property request for the activity
Returns:
new proxy for the activity, with requested properties
Throws:
WvcmException - if the preconditions are not met.

doResetDeliver

CcView doResetDeliver(CcView integrationView,
                      CcListener integrationListener,
                      Feedback feedback)
                      throws WvcmException

Resets a deliver operation in progress to use the new integration view

Parameters:
integrationView - the new integration view
integrationListener - optional listener to get feedback on operation
feedback - optional property request
Returns:
new proxy to the view with requested properties
Throws:
WvcmException - if there is an error resuming the deliver operation

doResumeDeliver

CcView doResumeDeliver(CcView integrationView,
                       CcListener integrationListener,
                       Feedback feedback)
                       throws WvcmException

Resumes a deliver operation from the point at which it was suspended.

Parameters:
integrationView - the target view to deliver to
integrationListener - optional listener to get feedback on operation
feedback - optional property request
Returns:
new proxy to the view with requested properties
Throws:
WvcmException - if there is an error resuming the deliver operation

doResumeRebase

CcView 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.

Parameters:
doAutoMerge - tells the rebase operation to attempt auto merges
integrationListener - optional listener to get feedback on operation
updateListener - optional listener to get feedback on view update changes
feedback - optional property request
Returns:
new proxy to the view with requested properties
Throws:
WvcmException - if there is an error resuming the rebase operation

doStartDeliver

CcView 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:

Parameters:
integrationView - the target view to deliver to
doAutoMerge - tells the deliver operation to attempt auto merges
integrationListener - optional listener to get feedback on operation
feedback - optional property request
Returns:
new proxy to the view with requested properties
Throws:
WvcmException - if there is an error starting the deliver operation

doStartDeliverActivities

CcView 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:

Parameters:
integrationView - the target view to deliver to
activityList - optional list of activities to deliver
doAutoMerge - tells the deliver operation to attempt auto merges
integrationListener - optional listener to get feedback on operation
feedback - optional property request
Returns:
new proxy to the view with requested properties
Throws:
WvcmException - if there is an error starting the deliver operation

doStartDeliverBaselines

CcView 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:

Parameters:
integrationView - the target view to deliver to
baselineList - list of baselines to deliver
doAutoMerge - tells the deliver operation to attempt auto merges
integrationListener - optional listener to get feedback on operation
feedback - optional property request
Returns:
new proxy to the view with requested properties
Throws:
WvcmException - if there is an error starting the deliver operation

doStartPostDeliver

CcView 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:

Parameters:
targetStream - the target stream to deliver to
integrationListener - optional listener to get feedback on operation
feedback - optional property request
Returns:
new proxy to the view with requested properties
Throws:
WvcmException - if there is an error starting the deliver operation

doStartPostDeliverActivities

CcView 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:

Parameters:
targetStream - the target stream to deliver to
activityList - optional list of activities to deliver
integrationListener - optional listener to get feedback on operation
feedback - optional property request
Returns:
new proxy to the view with requested properties
Throws:
WvcmException - if there is an error starting the deliver operation

doStartPostDeliverBaselines

CcView 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:

Parameters:
targetStream - the target stream to deliver to
baselineList - list of baselines to deliver
integrationListener - optional listener to get feedback on operation
feedback - optional property request
Returns:
new proxy to the view with requested properties
Throws:
WvcmException - if there is an error starting the deliver operation

doStartRebase

CcView 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:

Additional rules apply to integration streams and development streams in selecting a baseline:

Postconditions:

Parameters:
baselineList - optional list of baselines to include
doAutoMerge - tells the rebase operation to attempt auto merges
integrationListener - optional listener to get feedback on operation
updateListener - optional listener to get feedback on view update changes
feedback - optional property request
Returns:
new proxy to the view with requested properties
Throws:
WvcmException - if there is an error starting the rebase operation

doSynchronizeFileAreaDb

CcView 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:

Parameters:
flags - array of flags which specify the databases to synchronize.
feedback - optional property request for the view
Returns:
A new proxy for this resource, whose properties are specified by feedback.
Throws:
WvcmException

doUpgradeFileArea

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.

Throws:
WvcmException - if the preconditions are not met, or if there is an error upgrading the file area.

doWorkOnActivity

CcView doWorkOnActivity(StpActivity act,
                        Feedback feedback)
                        throws WvcmException
Work on the specified activity in this CC view. 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.

Parameters:
act - the activity to work on - either a CqRecord or CcActivity
feedback - optional property request
Returns:
new proxy for this view, with requested properties
Throws:
WvcmException
See Also:
Workspace.CURRENT_ACTIVITY, StpActivity.BOUND_CC_ACTIVITY, StpActivity.BOUND_CQ_RECORD

getArePermissionsValid

Boolean getArePermissionsValid()
                               throws WvcmException
Returns the value of this proxy's ARE_PERMISSIONS_VALID property.

Returns:
true if this view's permissions are valid; false otherwise.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getComponentRootDirectoryList

ResourceList<CcDirectory> getComponentRootDirectoryList()
                                                        throws WvcmException
Returns the value of the COMPONENT_ROOT_DIRECTORY_LIST property.

Returns:
List of the component root directories for this view's UCM stream, or an empty list if this is not a UCM view.
Throws:
WvcmException - if this property is not defined by this proxy.

getConfigSpec

CcConfigSpec getConfigSpec()
                           throws WvcmException
Get the value of this view's CONFIG_SPEC property.

Returns:
this view's config spec as a CcConfigSpec instance
Throws:
WvcmException

getFileAreaNeedsUpgrade

boolean getFileAreaNeedsUpgrade()
                                throws WvcmException
Get the value of this view's FILE_AREA_NEEDS_UPGRADE property.

Returns:
true if this view's local file area needs upgrading; false otherwise.
Throws:
WvcmException - if this property is not defined by this proxy.

getFileAreaRootDirectory

File getFileAreaRootDirectory()
                              throws WvcmException
Returns the value of the FILE_AREA_ROOT_DIRECTORY property.

Returns:
This view's copy area root directory, or null if it has no copy area on the local machine
Throws:
WvcmException - if this property is not defined by this proxy.

getIsExpress

Boolean getIsExpress()
                     throws WvcmException
Returns the value of this proxy's IS_EXPRESS property.

Returns:
true if this view has non-shareable DOs; false otherwise.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getIsReadOnly

Boolean getIsReadOnly()
                      throws WvcmException
Returns the value of this proxy's IS_READ_ONLY property.

Returns:
true if this view is read-only; false otherwise.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getIsUcmView

boolean getIsUcmView()
                     throws WvcmException
Get the value of this view's IS_UCM_VIEW property.

Returns:
true if this view represents a UCM view; false otherwise.
Throws:
WvcmException - if this property is not defined by this proxy.

getLoadedChildMap

Map<String,Resource> getLoadedChildMap()
                                       throws WvcmException
Get the value of this proxy's LOADED_CHILD_MAP property.

Returns:
this view's loaded child map
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getPermissions

CcPermissions getPermissions()
                             throws WvcmException
Returns the value of this proxy's PERMISSIONS property.

Returns:
A permissions object from which specific permissions information can be extracted.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getServerUrl

String getServerUrl()
                    throws WvcmException
Get the value of this proxy's SERVER_URL property.

Returns:
this view's server URL
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getShareDerivedObjects

Boolean getShareDerivedObjects()
                               throws WvcmException
Get the value of this view's SHARE_DERIVED_OBJECTS property.

Returns:
true if view creates shared derived objects, false otherwise
Throws:
WvcmException

getTextMode

CcView.TextMode getTextMode()
                            throws WvcmException
Get the value of this view's TEXT_MODE property.

Returns:
enumeration value representing this view's text mode.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getViewAccessInfo

CcViewAccessInfo getViewAccessInfo()
                                   throws WvcmException
Returns the value of this proxy's VIEW_ACCESS_INFO property.

Returns:
the CcViewAccessInfo object.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getViewStoragePath

String getViewStoragePath()
                          throws WvcmException
Returns the value of this proxy's VIEW_STORAGE_PATH property.

Returns:
path to the view storage
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getViewTag

CcViewTag getViewTag()
                     throws WvcmException
Get the value of this proxy's VIEW_TAG property.

Returns:
this view's view tag
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getViewTagString

String getViewTagString()
                        throws WvcmException
Get the value of this proxy's VIEW_TAG_STRING property.

Returns:
this view's view tag
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getViewType

CcViewTag.ViewType getViewType()
                               throws WvcmException
Returns the value of this proxy's VIEW_TYPE property.

Returns:
Kind of view this tag refers to.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getViewUuidString

String getViewUuidString()
                         throws WvcmException
Get the value of this proxy's VIEW_UUID_STRING property.

Returns:
this view's uuid
Throws:
WvcmException - if this proxy doesn't define a value for this property.

registerFileArea

void registerFileArea()
                      throws WvcmException
Register this local web view's file area in the local file area registry. Web views are registered automatically when created, but may need to be re-registered if the registry is accidentally deleted, etc.

Throws:
WvcmException

setConfigSpec

void setConfigSpec(CcConfigSpec configSpec)
Set the value of this view's CONFIG_SPEC property.

Parameters:
configSpec - the new config spec for this view

setRegion

void setRegion(CcRegistryRegion region)
Set the value of this view's 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.

Parameters:
region - network region in which to register the view

setShareDerivedObjects

void setShareDerivedObjects(Boolean shareDerivedObjects)
Set the value of this view's 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.

Parameters:
shareDerivedObjects - true to make derived objects available for winkin by other views, otherwise false

setStream

void setStream(Stream stream)
Set the Workspace.STREAM property.

Parameters:
stream - the Stream object that identifies the Workspace.STREAM for this Workspace.
See Also:
Workspace.getStream()

setTextMode

void setTextMode(CcView.TextMode textMode)
Set the value of this view's TEXT_MODE property. This property may only be set at view creation time.

Parameters:
textMode - the text mode of the view.

setViewStorageLocation

void setViewStorageLocation(CcStorageLocation viewStorageLocation)
Set the value of this view's VIEW_STORAGE_LOCATION property. This property may only be set at view creation time. It is a write-only property.

Parameters:
viewStorageLocation - the storage location for the new view

setViewStoragePath

void setViewStoragePath(String viewStoragePath)
Set the value of this view's VIEW_STORAGE_PATH property. This property may only be set at view creation time.

Parameters:
viewStoragePath - the storage path for the new view

setViewTagString

void setViewTagString(String viewTag)
Set the value of this view's VIEW_TAG_STRING property. This property may only be set at view creation time.

Parameters:
viewTag - the view tag for the new view

unregisterFileArea

void unregisterFileArea()
                        throws WvcmException
Remove this local web view's file area from the local file area registry. Once removed, this view will no longer show up when listing local views.

Throws:
WvcmException
See Also:
CcProvider.getClientViewList(javax.wvcm.PropertyRequestItem.PropertyRequest)

updateServerUrl

void updateServerUrl(String updatedUrl)
                     throws WvcmException
Change the URL used to connect to the CCRC WAN server on which this web view resides. Note: Web views cannot be moved from one CCRC WAN server to another. Use this method only to change the server URL, not to try to connect to a different server.

This may be necessary if, for example:

Parameters:
updatedUrl - the updated URL of this web view's CCRC WAN server
Throws:
WvcmException

Generated Thu 17-Apr-2014 02:17 PM

Copyright © IBM 2014. All rights reserved.