Project: stp

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

All Superinterfaces:
CcResource, CcVobResource, Resource, StpResource
All Known Subinterfaces:
CcAttributeType, CcBranchType, CcElementType, CcHyperlinkType, CcLabelType, CcPolicy, CcRolemap, CcTriggerType

public interface CcTypeBase
extends CcVobResource

Base interface for all ClearCase "type" interfaces - branch type, label type, etc. A type object controls certain aspects of the creation and behavior of instances of that type. For instance, the name of a label instance is determined by it's label type. Changing the name of a label type changes the names of all instances of that type.


Nested Class Summary
static class CcTypeBase.InstanceConstraint
          Instance constraint of a ClearCase type object.
static class CcTypeBase.Scope
          Scope of a ClearCase type object.
static class CcTypeBase.TypeCreateFlag
          Enum for the doCreateResource method
 
Nested classes/interfaces inherited from interface CcVobResource
CcVobResource.ApplyAttributeFlag
 
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<Boolean> HAS_SHARED_MASTERSHIP
          Does this type object have shared mastership?
static PropertyNameList.PropertyName<CcTypeBase.InstanceConstraint> INSTANCE_CONSTRAINT
          The instance constraint of this type object.
static PropertyNameList.PropertyName<CcTypeBase.Scope> SCOPE
          The scope of this type object.
 
Fields inherited from interface CcVobResource
ATTRIBUTE_LIST, CC_MASTER_REPLICA, CURRENT_REPLICA, EFFECTIVE_ACL, HAS_LOCAL_MASTERSHIP, HYPERLINK_LIST, LOCK_INFO, MY_EFFECTIVE_ACCESS, MY_EFFECTIVE_ACL, PERMISSIONS, ROLEMAP, VOB
 
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
 boolean getHasSharedMastership()
          Get the value of this proxy's HAS_SHARED_MASTERSHIP property.
 CcTypeBase.InstanceConstraint getInstanceConstraint()
          Get the value of this proxy's INSTANCE_CONSTRAINT property.
 CcTypeBase.Scope getScope()
          Get the value of this proxy's SCOPE property.
 void setHasSharedMastership(boolean hasSharedMastership)
          Set the value of this proxy's HAS_SHARED_MASTERSHIP property.
 void setInstanceConstraint(CcTypeBase.InstanceConstraint constraint)
          Set the value of this proxy's INSTANCE_CONSTRAINT property.
 void setScope(CcTypeBase.Scope scope)
          Set the value of this proxy's SCOPE property.
 
Methods inherited from interface CcVobResource
doApplyAttribute, doApplyRolemap, doRemoveAttribute, doRequestForMastership, getAttributeList, getCurrentReplica, getEffectiveAcl, getHasLocalMastership, getHyperlinkList, getLockInfo, getMasterReplica, getMyEffectiveAccess, getMyEffectiveAcl, getPermissions, getRolemap, getVob, setLockInfo, setPermissions
 
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
 

Field Detail

HAS_SHARED_MASTERSHIP

static final PropertyNameList.PropertyName<Boolean> HAS_SHARED_MASTERSHIP
Does this type object have shared mastership? If true, instances of this type can be created in any VOB replica in this type object's VOB family. Otherwise, instances of this type can only be created in the VOB replica that is the current master of this type object. For more information, see the ClearCase Administrator's Guide.


INSTANCE_CONSTRAINT

static final PropertyNameList.PropertyName<CcTypeBase.InstanceConstraint> INSTANCE_CONSTRAINT
The instance constraint of this type object.


SCOPE

static final PropertyNameList.PropertyName<CcTypeBase.Scope> SCOPE
The scope of this type object.

Method Detail

getHasSharedMastership

boolean getHasSharedMastership()
                               throws WvcmException
Get the value of this proxy's HAS_SHARED_MASTERSHIP property.

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

getInstanceConstraint

CcTypeBase.InstanceConstraint getInstanceConstraint()
                                                    throws WvcmException
Get the value of this proxy's INSTANCE_CONSTRAINT property.

Returns:
this type object's instance constraint
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getScope

CcTypeBase.Scope getScope()
                          throws WvcmException
Get the value of this proxy's SCOPE property.

Returns:
this type object's scope
Throws:
WvcmException - if this proxy doesn't define a value for this property.

setHasSharedMastership

void setHasSharedMastership(boolean hasSharedMastership)
Set the value of this proxy's HAS_SHARED_MASTERSHIP property. This property can only be set at type creation time.

Parameters:
hasSharedMastership - true if this type is to have shared mastership, else false

setInstanceConstraint

void setInstanceConstraint(CcTypeBase.InstanceConstraint constraint)
Set the value of this proxy's INSTANCE_CONSTRAINT property. This property can only be set at type creation time.

Parameters:
constraint - The new instance constraint

setScope

void setScope(CcTypeBase.Scope scope)
Set the value of this proxy's SCOPE property. This property can only be set at type creation time.

Parameters:
scope - The new scope

Generated Wed 22-May-2013 09:09 AM

Copyright © IBM 2013. All rights reserved.