|
Project: stp | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CcView
A proxy for a ClearCase view. ClearCase "view" and WVCM "workspace" are equivalent terms for the same type of resource.
In this release, only ClearCase CCRC web views are supported. ClearCase dynamic and snapshot views are not currently supported.
Nested Class Summary | |
---|---|
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.ControllableResource |
---|
ControllableResource.CheckinFlag, ControllableResource.CheckoutFlag |
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 |
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<CcConfigSpec> |
CONFIG_SPEC
This view's config spec. |
static PropertyNameList.PropertyName<Boolean> |
FILE_AREA_NEEDS_UPGRADE
Is this 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. |
static PropertyNameList.PropertyName<CcPermissions> |
PERMISSIONS
The permissions applied to this resource. |
static PropertyNameList.PropertyName<String> |
SERVER_URL
If this is a local web view, the URL of the CM Server where this view's view database resides. |
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<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. |
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.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.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 |
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 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 |
doCreateCcWebView(Feedback feedback)
Create a new ClearCase web view based on this CcView proxy. |
StpActivity |
doFinishActivity(StpActivity act,
Feedback feedback)
Transitions the specified activity to the default completed state. |
CcView |
doSynchronizeFileAreaDb(CcView.SynchronizeFileAreaDbFlag[] flags,
Feedback feedback)
Synchronize this 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. |
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. |
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. |
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. |
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 |
setStream(Stream stream)
Set the Workspace.STREAM property. |
void |
setTextMode(CcView.TextMode textMode)
Set the value of this view's TEXT_MODE 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 CM server on which this web view resides. |
Methods inherited from interface CcDirectory |
---|
createCcDirectory, getAggregatedCheckoutList, getAggregatedHijackList, getEclipsedList, getHasDescendantCheckouts, getHasDescendantHijacks, getIsVobRoot |
Methods inherited from interface CcResource |
---|
ccProvider, doResolve, 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, stpLocation, stpProvider |
Methods inherited from interface javax.wvcm.ControllableFolder |
---|
doBaselineControl, doCreateBaselineControlledFolder, getIsBaselineControllable, getIsBaselineControlled, getRootFolderOf |
Methods inherited from interface javax.wvcm.Folder |
---|
doBindChild, doReadMemberList, doRebindAll, doRebindChild, doUnbindChild, getChildList, getChildMap |
Methods inherited from interface javax.wvcm.ControllableFolder |
---|
doBaselineControl, doCreateBaselineControlledFolder, getIsBaselineControllable, getIsBaselineControlled, getRootFolderOf |
Methods inherited from interface javax.wvcm.Folder |
---|
doBindChild, doReadMemberList, doRebindAll, doRebindChild, doUnbindChild, getChildList, getChildMap |
Field Detail |
---|
static final PropertyNameList.PropertyName<Boolean> ARE_PERMISSIONS_VALID
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.
static final PropertyNameList.PropertyName<CcPermissions> PERMISSIONS
The permissions applied to this resource.
static final PropertyNameList.PropertyName<String> SERVER_URL
static final PropertyNameList.PropertyName<CcView.TextMode> TEXT_MODE
CcView.TextMode.TRANSPARENT
.
static final PropertyNameList.PropertyName<CcViewAccessInfo> VIEW_ACCESS_INFO
static final PropertyNameList.PropertyName<CcViewTag> VIEW_TAG
CcViewTag
resource.
static final PropertyNameList.PropertyName<String> VIEW_TAG_STRING
Method Detail |
---|
boolean breakFileAreaLock(CcFileAreaLockedCallback.CcFileAreaLockInfo lockInfo) throws WvcmException
lockInfo
- information about the lock
WvcmException
- 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 request
WvcmException
Workspace.CURRENT_ACTIVITY
,
StpActivity.BOUND_CC_ACTIVITY
,
StpActivity.BOUND_CQ_RECORD
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.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:
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 activity
WvcmException
- if the preconditions are not met.CcView doSynchronizeFileAreaDb(CcView.SynchronizeFileAreaDbFlag[] flags, Feedback feedback) throws WvcmException
Synchronize this 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 view
WvcmException
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 request
WvcmException
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.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.CcPermissions getPermissions() throws WvcmException
PERMISSIONS
property.
WvcmException
- if this proxy doesn't define a value for this property.String getServerUrl() throws WvcmException
SERVER_URL
property.
WvcmException
- if this proxy doesn't define a value for this property.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.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.void registerFileArea() throws WvcmException
WvcmException
void setConfigSpec(CcConfigSpec configSpec)
CONFIG_SPEC
property.
configSpec
- the new config spec for this viewvoid 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 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 unregisterFileArea() throws WvcmException
WvcmException
CcProvider.getClientViewList(javax.wvcm.PropertyRequestItem.PropertyRequest)
void updateServerUrl(String updatedUrl) throws WvcmException
This may be necessary if, for example:
updatedUrl
- the updated URL of this web view's CM server
WvcmException
|
Generated Wed 17-Oct-2012 09:36 PM | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |