Project: stp

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

All Superinterfaces:
CcResource, Resource, StpResource
All Known Subinterfaces:
CcActivity, CcAttributeType, CcBaseline, CcBranch, CcBranchType, CcComponent, CcDirectoryElement, CcDirectoryVersion, CcElement, CcElementType, CcHyperlink, CcHyperlinkType, CcLabelType, CcPolicy, CcProject, CcProjectFolder, CcReplica, CcRolemap, CcStream, CcTriggerType, CcTypeBase, CcVersion, CcVob

public interface CcVobResource
extends CcResource

Base interface containing properties and methods common to all VOB-resident ClearCase resources.


Nested Class Summary
static class CcVobResource.ApplyAttributeFlag
          Flags for the doApplyAttribute method
 
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
 
Field Summary
static PropertyNameList.PropertyName<List<CcAttribute>> ATTRIBUTE_LIST
          List of attributes attached to this resource.
static PropertyNameList.PropertyName<CcReplica> CC_MASTER_REPLICA
          Replica which has mastery of this resource.
static PropertyNameList.PropertyName<CcReplica> CURRENT_REPLICA
          Replica in which this resource resides.
static PropertyNameList.PropertyName<List<CcAccessControlEntry>> EFFECTIVE_ACL
          List of access control entries which make up the effective ACLs for this resource.
static PropertyNameList.PropertyName<Boolean> HAS_LOCAL_MASTERSHIP
          Does this object have local mastership?
static PropertyNameList.PropertyName<ResourceList<CcHyperlink>> HYPERLINK_LIST
          List of hyperlink resources attached to this resource.
static PropertyNameList.PropertyName<CcLockInfo> LOCK_INFO
          CcLockInfo object contains the supported lock properties.
static PropertyNameList.PropertyName<String> MY_EFFECTIVE_ACCESS
          A permission string describing the operations the current user may performe on this resource.
static PropertyNameList.PropertyName<List<CcAccessControlEntry>> MY_EFFECTIVE_ACL
          List of access control entries, affecting the current user, which make up the effective ACLs for this resource.
static PropertyNameList.PropertyName<CcPermissions> PERMISSIONS
           The permissions applied to this resource.
static PropertyNameList.PropertyName<CcRolemap> ROLEMAP
          Rolemap used to define the ACLs for this resource.
static PropertyNameList.PropertyName<CcVob> VOB
          The VOB in which this VOB resource resides.
 
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
 
Method Summary
 CcVobResource doApplyAttribute(CcVobResource.ApplyAttributeFlag[] flags, String comment, String attributeName, String attributeValue, Feedback feedback)
          Apply the specified attribute to this VOB resource.
 void doApplyRolemap(String comment, String rolemap)
          Apply the specified rolemap to this VOB resource.
 CcVobResource doRemoveAttribute(String comment, String attributeName, Feedback feedback)
          Remove the specified attribute from this VOB resource.
 CcVobResource doRequestForMastership(com.ibm.rational.wvcm.stp.ccex.CcExFileList.RequestForMastershipFlag[] flags, String comment, Feedback feedback)
           Request for local mastership of this VOB resource.
 List<CcAttribute> getAttributeList()
          Get the value of this proxy's ATTRIBUTE_LIST property.
 CcReplica getCurrentReplica()
          Returns the value of this proxy's CURRENT_REPLICA property.
 List<CcAccessControlEntry> getEffectiveAcl()
          Get the value of this resource's EFFECTIVE_ACL property.
 boolean getHasLocalMastership()
          Get the value of this proxy's HAS_LOCAL_MASTERSHIP property.
 ResourceList<CcHyperlink> getHyperlinkList()
          Get the value of this proxy's HYPERLINK_LIST property.
 CcLockInfo getLockInfo()
          Returns the value of this proxy's LOCK_INFO property.
 CcReplica getMasterReplica()
          Returns the value of this proxy's CC_MASTER_REPLICA property.
 String getMyEffectiveAccess()
          Get the value of this resource's MY_EFFECTIVE_ACCESS property.
 List<CcAccessControlEntry> getMyEffectiveAcl()
          Get the value of this resource's MY_EFFECTIVE_ACL property.
 CcPermissions getPermissions()
          Get the value of this resource's PERMISSIONS property.
 CcRolemap getRolemap()
          Get the value of this resource's ROLEMAP property.
 CcVob getVob()
          Get the value of this proxy's VOB property.
 void setLockInfo(CcLockInfo lockInfo)
          Sets (or replaces) the lock on this proxy according to the LOCK_INFO property.
 void setPermissions(CcPermissions permissions)
          Set the value of this proxy's PERMISSIONS property.
 
Methods inherited from interface CcResource
ccProvider, doResolve, doWriteProperties, hasSupportedProperties, isResolved, readProperties, readProperties, resolve, writeProperties, writeProperties
 
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
 

Field Detail

ATTRIBUTE_LIST

static final PropertyNameList.PropertyName<List<CcAttribute>> ATTRIBUTE_LIST
List of attributes attached to this resource.


CC_MASTER_REPLICA

static final PropertyNameList.PropertyName<CcReplica> CC_MASTER_REPLICA
Replica which has mastery of this resource.


CURRENT_REPLICA

static final PropertyNameList.PropertyName<CcReplica> CURRENT_REPLICA
Replica in which this resource resides.


EFFECTIVE_ACL

static final PropertyNameList.PropertyName<List<CcAccessControlEntry>> EFFECTIVE_ACL
List of access control entries which make up the effective ACLs for this resource.


HAS_LOCAL_MASTERSHIP

static final PropertyNameList.PropertyName<Boolean> HAS_LOCAL_MASTERSHIP
Does this object have local mastership? If true, this object is mastered in the same replica as its VOB. Otherwise, it is mastered at a replica remote from that of its VOB.


HYPERLINK_LIST

static final PropertyNameList.PropertyName<ResourceList<CcHyperlink>> HYPERLINK_LIST
List of hyperlink resources attached to this resource.


LOCK_INFO

static final PropertyNameList.PropertyName<CcLockInfo> LOCK_INFO
CcLockInfo object contains the supported lock properties.


MY_EFFECTIVE_ACCESS

static final PropertyNameList.PropertyName<String> MY_EFFECTIVE_ACCESS
A permission string describing the operations the current user may performe on this resource.


MY_EFFECTIVE_ACL

static final PropertyNameList.PropertyName<List<CcAccessControlEntry>> MY_EFFECTIVE_ACL
List of access control entries, affecting the current user, which make up the effective ACLs for this resource.


PERMISSIONS

static final PropertyNameList.PropertyName<CcPermissions> PERMISSIONS

The permissions applied to this resource.


ROLEMAP

static final PropertyNameList.PropertyName<CcRolemap> ROLEMAP
Rolemap used to define the ACLs for this resource.


VOB

static final PropertyNameList.PropertyName<CcVob> VOB
The VOB in which this VOB resource resides.

Method Detail

doApplyAttribute

CcVobResource doApplyAttribute(CcVobResource.ApplyAttributeFlag[] flags,
                               String comment,
                               String attributeName,
                               String attributeValue,
                               Feedback feedback)
                               throws WvcmException
Apply the specified attribute to this VOB resource.

Parameters:
flags - array of flags which specify the behavior of the operation
comment - Comment (if any) to be used for operation. Empty string if none.
attributeName - Name of an existing attribute type to be used to create an instance will to be applied to this resource.
attributeValue - Value of attribute instance. If the vtype of the attribute type is a string, it must be enclosed in additional quotes within the string. For example, if specified as a constant it would appear as "\"string value\"". If the vtype is not a string, this should be a string representation of the given value (e.g. "3.1415", "0xa413", etc.).
feedback -
Returns:
A new proxy for this resource, whose properties are specified by feedback.
Throws:
WvcmException

doApplyRolemap

void doApplyRolemap(String comment,
                    String rolemap)
                    throws WvcmException
Apply the specified rolemap to this VOB resource.

Parameters:
comment - Comment (if any) to be used for operation. Empty string if none.
rolemap - The name of the rolemap to be applied to this resource.
Throws:
WvcmException

doRemoveAttribute

CcVobResource doRemoveAttribute(String comment,
                                String attributeName,
                                Feedback feedback)
                                throws WvcmException
Remove the specified attribute from this VOB resource.

Parameters:
comment - Comment (if any) to be used for operation. Empty string if none.
attributeName - Name of the attribute to be removed from this resource
feedback -
Returns:
A new proxy for this resource, whose properties are specified by feedback.
Throws:
WvcmException

doRequestForMastership

CcVobResource doRequestForMastership(com.ibm.rational.wvcm.stp.ccex.CcExFileList.RequestForMastershipFlag[] flags,
                                     String comment,
                                     Feedback feedback)
                                     throws WvcmException

Request for local mastership of this VOB resource.

Note: this operation is only supported for CcBranch and CcBranchType resources.

Parameters:
flags - array of flags which specify the behavior of the operation.
comment - Comment (if any) to be used for operation. Empty string if none.
feedback - list of properties to fetch on this resource.
Returns:
new proxy with the requested properties available.
Throws:
WvcmException

getAttributeList

List<CcAttribute> getAttributeList()
                                   throws WvcmException
Get the value of this proxy's ATTRIBUTE_LIST property.

Returns:
List of CcAttribute proxies applied to this resource. Empty list if none.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getCurrentReplica

CcReplica getCurrentReplica()
                            throws WvcmException
Returns the value of this proxy's CURRENT_REPLICA property.

Returns:
Replica in which the resource resides as a CcReplica instance.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getEffectiveAcl

List<CcAccessControlEntry> getEffectiveAcl()
                                           throws WvcmException
Get the value of this resource's EFFECTIVE_ACL property.

Returns:
List of access control entries which make up the effective ACLs for this resource. null if the resource does not support ACLs.
Throws:
WvcmException

getHasLocalMastership

boolean getHasLocalMastership()
                              throws WvcmException
Get the value of this proxy's HAS_LOCAL_MASTERSHIP property.

Returns:
true if this object has local mastership, else false
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getHyperlinkList

ResourceList<CcHyperlink> getHyperlinkList()
                                           throws WvcmException
Get the value of this proxy's HYPERLINK_LIST property.

Returns:
List of CcHyperlink proxies applied to this resource. Empty list if none.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getLockInfo

CcLockInfo getLockInfo()
                       throws WvcmException
Returns the value of this proxy's LOCK_INFO property.

Returns:
the CcLockInfo object for the resource. null if the object is not locked.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getMasterReplica

CcReplica getMasterReplica()
                           throws WvcmException
Returns the value of this proxy's CC_MASTER_REPLICA property.

Returns:
Replica in which the resource is mastered as a CcReplica instance. null if resource cannot be mastered.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getMyEffectiveAccess

String getMyEffectiveAccess()
                            throws WvcmException
Get the value of this resource's MY_EFFECTIVE_ACCESS property.

Returns:
A permission string describing the operations the current user may performe on this resource. null if the resource does not support ACLs.
Throws:
WvcmException

getMyEffectiveAcl

List<CcAccessControlEntry> getMyEffectiveAcl()
                                             throws WvcmException
Get the value of this resource's MY_EFFECTIVE_ACL property.

Returns:
List of access control entries, affecting the current user, which make up the effective ACLs for this resource. null if the resource does not support ACLs.
Throws:
WvcmException

getPermissions

CcPermissions getPermissions()
                             throws WvcmException
Get the value of this resource's PERMISSIONS property.

Returns:
A permissions object from which specific permissions information can be extracted.
Throws:
WvcmException

getRolemap

CcRolemap getRolemap()
                     throws WvcmException
Get the value of this resource's ROLEMAP property.

Returns:
Rolemap used to define the ACLs for this resource. null if the resource has no rolemap.
Throws:
WvcmException

getVob

CcVob getVob()
             throws WvcmException
Get the value of this proxy's VOB property.

Returns:
This resource's VOB. Will never be null.
Throws:
WvcmException

setLockInfo

void setLockInfo(CcLockInfo lockInfo)
Sets (or replaces) the lock on this proxy according to the LOCK_INFO property.

Parameters:
lockInfo - lock information for the new lock, or null to unlock the proxy.

setPermissions

void setPermissions(CcPermissions permissions)
                    throws WvcmException
Set the value of this proxy's PERMISSIONS property.

Parameters:
permissions - A permissions object. Use the one returned by getPermissions and modify it.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

Generated Thu 6-Nov-2014 11:02 PM

Copyright © IBM 2014. All rights reserved.