Project: stp

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

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

public interface CcHyperlinkType
extends CcTypeBase

A proxy for a ClearCase hyperlink type.

After creating a hyperlink type, you can connect pairs of objects with hyperlinks of that type. Conceptually, a hyperlink is an “arrow” from one VOB-database object (version, branch, element, or VOB symbolic link) to another. To enable objects in two different VOBs to be connected, a hyperlink type with the same name must be created in both VOBs. For example, you create a hyperlink type named design_spec, for use in linking source code files to the associated design documents. Later, you can create a hyperlink of this type between my_prog.c and my_prog.dsn.

For more information about hyperlinks and hyperlink types, see the ClearCase "Guide to Managing Software Projects" manual, and the cleartool man pages "mkhltype" and "mkhlink".


Nested Class Summary
 
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
 
Fields inherited from interface CcTypeBase
HAS_SHARED_MASTERSHIP, INSTANCE_CONSTRAINT, SCOPE
 
Fields inherited from interface CcVobResource
ATTRIBUTE_LIST, CC_MASTER_REPLICA, CURRENT_REPLICA, HAS_LOCAL_MASTERSHIP, HYPERLINK_LIST, LOCK_INFO, PERMISSIONS, 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
 CcHyperlinkType doCreateCcHyperlinkType(CcTypeBase.TypeCreateFlag[] flags, Feedback feedback)
          Create a new hyperlink type at the location identified by this proxy.
 
Methods inherited from interface CcTypeBase
getHasSharedMastership, getInstanceConstraint, getScope, setHasSharedMastership, setInstanceConstraint, setScope
 
Methods inherited from interface CcVobResource
doApplyAttribute, doRemoveAttribute, doRequestForMastership, getAttributeList, getCurrentReplica, getHasLocalMastership, getHyperlinkList, getLockInfo, getMasterReplica, getPermissions, getVob, setLockInfo, setPermissions
 
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
 

Method Detail

doCreateCcHyperlinkType

CcHyperlinkType doCreateCcHyperlinkType(CcTypeBase.TypeCreateFlag[] flags,
                                        Feedback feedback)
                                        throws WvcmException

Create a new hyperlink type at the location identified by this proxy. The location should be an object name selector specifying the hyperlink type's name and the repository (VOB) in which to create it.

Set the CcTypeBase.SCOPE property to specify the new type's global scope. If no scope is set, a scope of NONE (ordinary scope) is used.

Set the CcTypeBase.HAS_SHARED_MASTERSHIP property to true to allow instances of this type to be created in any VOB replica. If unspecified, the default mastership is unshared.

Parameters:
flags - Resource-specific creation flags.
Throws:
WvcmException

Generated Fri 26-Feb-2010 04:01 AM

Copyright © IBM 2010. All rights reserved.