Project: stp

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

All Superinterfaces:
CcResource, CcVobResource, Resource, StpResource

public interface CcHyperlink
extends CcVobResource

A proxy for a ClearCase hyperlink object.

Conceptually, a hyperlink is an “arrow” from one VOB-database object (version, branch, element, VOB symbolic link or VOB) to another. A merge arrow is a special kind of hyperlink.

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


Nested Class Summary
 
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<CcResource> FROM_RESOURCE
          The resource at the "from" end of the hyperlink
static PropertyNameList.PropertyName<String> FROM_TEXT
          The text associated with the "from" end of the hyperlink.
static PropertyNameList.PropertyName<CcResource> TO_RESOURCE
          The resource at the "to" end of the hyperlink
static PropertyNameList.PropertyName<String> TO_TEXT
          The text associated with the "to" end of the hyperlink.
static PropertyNameList.PropertyName<CcHyperlinkType> TYPE
          The hyperlink type of which this hyperlink is an instance.
 
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
 CcResource getFromResource()
          Get the value of this hyperlink instance's FROM_RESOURCE property.
 String getFromText()
          Get the value of this hyperlink instance's FROM_TEXT property.
 CcResource getToResource()
          Get the value of this hyperlink instance's TO_RESOURCE property.
 String getToText()
          Get the value of this hyperlink instance's TO_TEXT property.
 CcHyperlinkType getType()
          Get the value of this hyperlink instance's TYPE property.
 
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, 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

FROM_RESOURCE

static final PropertyNameList.PropertyName<CcResource> FROM_RESOURCE
The resource at the "from" end of the hyperlink


FROM_TEXT

static final PropertyNameList.PropertyName<String> FROM_TEXT
The text associated with the "from" end of the hyperlink.


TO_RESOURCE

static final PropertyNameList.PropertyName<CcResource> TO_RESOURCE
The resource at the "to" end of the hyperlink


TO_TEXT

static final PropertyNameList.PropertyName<String> TO_TEXT
The text associated with the "to" end of the hyperlink.


TYPE

static final PropertyNameList.PropertyName<CcHyperlinkType> TYPE
The hyperlink type of which this hyperlink is an instance.

Method Detail

getFromResource

CcResource getFromResource()
                           throws WvcmException
Get the value of this hyperlink instance's FROM_RESOURCE property.

Returns:
resource hyperlink instance points from
Throws:
WvcmException - if this proxy doesn't define a value for this property or the resource is unavailable/does not exist

getFromText

String getFromText()
                   throws WvcmException
Get the value of this hyperlink instance's FROM_TEXT property.

Returns:
String containing text associated with the "from" end of the hyperlink. Will be null if no text was specified during hyperlink creation.
Throws:
WvcmException - if this proxy doesn't define a value for this property or the resource is unavailable/does not exist

getToResource

CcResource getToResource()
                         throws WvcmException
Get the value of this hyperlink instance's TO_RESOURCE property.

Returns:
resource hyperlink instance points to, or null if single-ended hyperlink
Throws:
WvcmException - if this proxy doesn't define a value for this property or the resource is unavailable/does not exist

getToText

String getToText()
                 throws WvcmException
Get the value of this hyperlink instance's TO_TEXT property.

Returns:
String containing text associated with the "to" end of the hyperlink. Will be null if no text was specified during hyperlink creation.
Throws:
WvcmException - if this proxy doesn't define a value for this property or the resource is unavailable/does not exist

getType

CcHyperlinkType getType()
                        throws WvcmException
Get the value of this hyperlink instance's TYPE property.

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

Generated Thu 3-Nov-2011 01:39 AM

Copyright © IBM 2011. All rights reserved.