Project: stp

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

All Superinterfaces:
CcFile, CcResource, ControllableFolder, ControllableResource, Folder, Resource, StpResource
All Known Subinterfaces:
CcView

public interface CcDirectory
extends CcFile, ControllableFolder

A proxy for a directory in a ClearCase view. This directory is either under version control or could potentially be put under version control.


Nested Class Summary
 
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
 
Field Summary
static PropertyNameList.PropertyName<ResourceList<CcFile>> AGGREGATED_CHECKOUT_LIST
          A list of all checkouts in the tree below this directory.
static PropertyNameList.PropertyName<ResourceList<CcFile>> AGGREGATED_HIJACK_LIST
          A list of all hijacks in the tree below this directory.
static PropertyNameList.PropertyName<List<String>> ECLIPSED_LIST
          The list of String objects that identify the names of version-controlled resources in this CcDirectory that are eclipsed by non-version-controlled resources.
static PropertyNameList.PropertyName<Boolean> HAS_DESCENDANT_CHECKOUTS
          Are there checkouts anywhere in the tree below this directory?
static PropertyNameList.PropertyName<Boolean> HAS_DESCENDANT_HIJACKS
          Are there hijacks anywhere in the tree below this directory?
static PropertyNameList.PropertyName<Boolean> IS_VOB_ROOT
          Is this directory the root of a ClearCase VOB.
 
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
 
Method Summary
 CcDirectory createCcDirectory(Feedback feedback)
          Create a new view-private directory at the location specified by this resource.
 ResourceList<CcFile> getAggregatedCheckoutList()
          Get the AGGREGATED_CHECKOUT_LIST property.
 ResourceList<CcFile> getAggregatedHijackList()
          Get the AGGREGATED_HIJACK_LIST property.
 List<String> getEclipsedList()
          Get the ECLIPSED_LIST property.
 boolean getHasDescendantCheckouts()
          Get the HAS_DESCENDANT_CHECKOUTS property.
 boolean getHasDescendantHijacks()
          Get the HAS_DESCENDANT_HIJACKS property.
 boolean getIsVobRoot()
          Returns the value of this proxy's IS_VOB_ROOT property.
 
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
 

Field Detail

AGGREGATED_CHECKOUT_LIST

static final PropertyNameList.PropertyName<ResourceList<CcFile>> AGGREGATED_CHECKOUT_LIST
A list of all checkouts in the tree below this directory. Returns a list of CcFile resources.


AGGREGATED_HIJACK_LIST

static final PropertyNameList.PropertyName<ResourceList<CcFile>> AGGREGATED_HIJACK_LIST
A list of all hijacks in the tree below this directory. Returns a list of CcFile resources.


ECLIPSED_LIST

static final PropertyNameList.PropertyName<List<String>> ECLIPSED_LIST
The list of String objects that identify the names of version-controlled resources in this CcDirectory that are eclipsed by non-version-controlled resources.

A Workspace.doUpdate or Workspace.doMerge request can give a version-controlled folder a version-controlled bound member that has the same name as an existing uncontrolled bound member. In this case, the uncontrolled bound member takes precedence and is said to "eclipse" the new versioned-controlled bound member.


HAS_DESCENDANT_CHECKOUTS

static final PropertyNameList.PropertyName<Boolean> HAS_DESCENDANT_CHECKOUTS
Are there checkouts anywhere in the tree below this directory?


HAS_DESCENDANT_HIJACKS

static final PropertyNameList.PropertyName<Boolean> HAS_DESCENDANT_HIJACKS
Are there hijacks anywhere in the tree below this directory?


IS_VOB_ROOT

static final PropertyNameList.PropertyName<Boolean> IS_VOB_ROOT
Is this directory the root of a ClearCase VOB.

Method Detail

createCcDirectory

CcDirectory createCcDirectory(Feedback feedback)
                              throws WvcmException
Create a new view-private directory at the location specified by this resource. The request will fail if a resource already exists at that location.

Throws:
WvcmException
See Also:
ControllableResource.doCreateResource(Feedback)

getAggregatedCheckoutList

ResourceList<CcFile> getAggregatedCheckoutList()
                                               throws WvcmException
Get the AGGREGATED_CHECKOUT_LIST property.

Returns:
List of CcFile proxies representing all checkouts in the tree rooted by this directory.
Throws:
WvcmException - if this ControllableFolder was not created with AGGREGATED_CHECKOUT_LIST as a wanted property.

getAggregatedHijackList

ResourceList<CcFile> getAggregatedHijackList()
                                             throws WvcmException
Get the AGGREGATED_HIJACK_LIST property.

Returns:
List of CcFile proxies representing all hijacks in the tree rooted by this directory.
Throws:
WvcmException - if this ControllableFolder was not created with AGGREGATED_HIJACK_LIST as a wanted property.

getEclipsedList

List<String> getEclipsedList()
                             throws WvcmException
Get the ECLIPSED_LIST property.

Returns:
String list of the names of the eclipsed version-controlled resources
Throws:
WvcmException - if this ControllableFolder was not created with ECLIPSED_LIST as a wanted property.

getHasDescendantCheckouts

boolean getHasDescendantCheckouts()
                                  throws WvcmException
Get the HAS_DESCENDANT_CHECKOUTS property.

Returns:
true if there are checkouts anywhere in the tree rooted by this directory, else false.
Throws:
WvcmException - if this ControllableFolder was not created with HAS_DESCENDANT_CHECKOUTS as a wanted property.

getHasDescendantHijacks

boolean getHasDescendantHijacks()
                                throws WvcmException
Get the HAS_DESCENDANT_HIJACKS property.

Returns:
true if there are hijacks anywhere in the tree rooted by this directory, else false.
Throws:
WvcmException - if this ControllableFolder was not created with HAS_DESCENDANT_HIJACKS as a wanted property.

getIsVobRoot

boolean getIsVobRoot()
                     throws WvcmException
Returns the value of this proxy's IS_VOB_ROOT property.

Returns:
true if the directory is the root of a VOB, else false
Throws:
WvcmException - if this proxy doesn't define a value for this property.

Generated Tue 10-Jun-2014 09:00 AM

Copyright © IBM 2014. All rights reserved.