Project: stp

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

All Superinterfaces:
CcResource, CcTypeBase, CcVobResource, Resource, StpResource

public interface CcAttributeType
extends CcTypeBase

A proxy for a ClearCase attribute type.

The ClearCase attribute mechanism lets you associate arbitrary name/value pairs with particular ClearCase versions or elements.

Attributes are typically used to customize and extend standard ClearCase functionality. For example, to notify various people in your group when particular files are modified, you could store those peoples' email addresses in an "EmailList" attribute associated with each element of interest. Then associate a checkin "post-op" trigger with those elements that reads the attribute value and sends the notice.

You can also use the cleartool "find" command to find elements and versions based on their attributes.

For more attribute information, see the ClearCase "Guide to Managing Software Projects" manual, and the cleartool man pages "mkattype" and "find".


Nested Class Summary
static class CcAttributeType.ValueType
          Value type of a ClearCase attribute type.
 
Nested classes/interfaces inherited from interface CcTypeBase
CcTypeBase.InstanceConstraint, CcTypeBase.Scope, CcTypeBase.TypeCreateFlag
 
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<String> DEFAULT_VALUE
          The default value for this attribute type.
static PropertyNameList.PropertyName<CcAttributeType.ValueType> VALUE_TYPE
          The value type of this attribute type
 
Fields inherited from interface CcTypeBase
HAS_SHARED_MASTERSHIP, INSTANCE_CONSTRAINT, SCOPE
 
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
 String getDefaultValue()
          Get the value of this proxy's DEFAULT_VALUE property.
 CcAttributeType.ValueType getValueType()
          Get the value of this proxy's VALUE_TYPE property.
 
Methods inherited from interface CcTypeBase
getHasSharedMastership, getInstanceConstraint, getScope, setHasSharedMastership, setInstanceConstraint, setScope
 
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, 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

DEFAULT_VALUE

static final PropertyNameList.PropertyName<String> DEFAULT_VALUE
The default value for this attribute type. It is aways provided in string form, regardless of its value type. If no default value has been set, the property will be null.


VALUE_TYPE

static final PropertyNameList.PropertyName<CcAttributeType.ValueType> VALUE_TYPE
The value type of this attribute type

Method Detail

getDefaultValue

String getDefaultValue()
                       throws WvcmException
Get the value of this proxy's DEFAULT_VALUE property.

Returns:
this attribute type's default value, or null if not defined
Throws:
WvcmException

getValueType

CcAttributeType.ValueType getValueType()
                                       throws WvcmException
Get the value of this proxy's VALUE_TYPE property.

Returns:
this attribute type's value type
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.