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.

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 CcFile
clientResourceFile, createCcFile, doApplyAttribute, doApplyLabel, doCcCheckout, doCcVersionControl, doCheckin, doLoad, 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, 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.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.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.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
 
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?


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 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 view's file area root directory on the local machine. The value of this property will be null if this is not a web view, or if it does not have a file area on the local machine.


IS_EXPRESS

static final PropertyNameList.PropertyName<Boolean> IS_EXPRESS
Does this view have non-shareable derived objects?


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.


PERMISSIONS

static final PropertyNameList.PropertyName<CcPermissions> PERMISSIONS

The permissions applied to this resource.


SERVER_URL

static final 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.


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

Method Detail

breakFileAreaLock

boolean breakFileAreaLock(CcFileAreaLockedCallback.CcFileAreaLockInfo lockInfo)
                          throws WvcmException
Break a file area lock on this 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

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.

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.

doSynchronizeFileAreaDb

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:

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.

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.

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.

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.

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

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.

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 CM server on which this web view resides. Note: Web views cannot be moved from one CM 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 CM server
Throws:
WvcmException

Generated Wed 15-Jul-2015 01:05 AM

Copyright © IBM 2015. All rights reserved.