Project: stp

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

All Superinterfaces:
CcResource, Resource, StpResource

public interface CcVobTag
extends CcResource

A proxy for a ClearCase VOB tag - the handle by which a ClearCase VOB is identified and managed.

VOB tags are treated as distinct objects from VOBs in order to allow for the retrieval of basic VOB info and passing of handles to VOBs without incurring the overhead of actually opening a real VOB connection.


Nested Class Summary
 
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> GLOBAL_PATH
          Global path for this VOB's storage
static PropertyNameList.PropertyName<String> HOST_NAME
          Name of host on which the VOB resides
static PropertyNameList.PropertyName<String> HOST_PATH
          Host specific path for this VOB's storage
static PropertyNameList.PropertyName<Boolean> IS_MOUNTED
          Is the VOB represented by this tag mounted?
static PropertyNameList.PropertyName<Boolean> IS_PROJECT_VOB
          Is this a tag for a project VOB?
static PropertyNameList.PropertyName<Boolean> IS_PUBLIC
          Is this a tag for a public VOB?
static PropertyNameList.PropertyName<String> MOUNT_OPTIONS
          Mount options specified for this VOB tag in the registry.
static PropertyNameList.PropertyName<CcRegistryRegion> REGISTRY_REGION
          The registry region this tag resides in
static PropertyNameList.PropertyName<CcVob> VOB
          The VOB to which this tag refers
 
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 getGlobalPath()
          Returns the value of this proxy's GLOBAL_PATH property.
 String getHostName()
          Returns the value of this proxy's HOST_NAME property.
 String getHostPath()
          Returns the value of this proxy's HOST_PATH property.
 boolean getIsMounted()
          Returns the value of this proxy's IS_MOUNTED property.
 boolean getIsProjectVob()
          Returns the value of this proxy's IS_PROJECT_VOB property.
 boolean getIsPublic()
          Returns the value of this proxy's IS_PUBLIC property.
 String getMountOptions()
          Returns the value of this proxy's MOUNT_OPTIONS property.
 CcRegistryRegion getRegistryRegion()
          Returns the value of this proxy's REGISTRY_REGION property.
 CcVob getVob()
          Returns the value of this proxy's VOB property.
 void setIsMounted(boolean mount)
          Sets the value of this proxy's (@link #IS_MOUNTED) property.
 
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

GLOBAL_PATH

static final PropertyNameList.PropertyName<String> GLOBAL_PATH
Global path for this VOB's storage


HOST_NAME

static final PropertyNameList.PropertyName<String> HOST_NAME
Name of host on which the VOB resides


HOST_PATH

static final PropertyNameList.PropertyName<String> HOST_PATH
Host specific path for this VOB's storage


IS_MOUNTED

static final PropertyNameList.PropertyName<Boolean> IS_MOUNTED
Is the VOB represented by this tag mounted?


IS_PROJECT_VOB

static final PropertyNameList.PropertyName<Boolean> IS_PROJECT_VOB
Is this a tag for a project VOB?


IS_PUBLIC

static final PropertyNameList.PropertyName<Boolean> IS_PUBLIC
Is this a tag for a public VOB?


MOUNT_OPTIONS

static final PropertyNameList.PropertyName<String> MOUNT_OPTIONS
Mount options specified for this VOB tag in the registry.


REGISTRY_REGION

static final PropertyNameList.PropertyName<CcRegistryRegion> REGISTRY_REGION
The registry region this tag resides in


VOB

static final PropertyNameList.PropertyName<CcVob> VOB
The VOB to which this tag refers

Method Detail

getGlobalPath

String getGlobalPath()
                     throws WvcmException
Returns the value of this proxy's GLOBAL_PATH property.

Returns:
global pathname for this VOB's storage
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getHostName

String getHostName()
                   throws WvcmException
Returns the value of this proxy's HOST_NAME property.

Returns:
host name for this VOB
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getHostPath

String getHostPath()
                   throws WvcmException
Returns the value of this proxy's HOST_PATH property.

Returns:
host specific pathname for this VOB's storage
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getIsMounted

boolean getIsMounted()
                     throws WvcmException
Returns the value of this proxy's IS_MOUNTED property.

Returns:
true if the VOB tag is for a VOB that is mounted, else false
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getIsProjectVob

boolean getIsProjectVob()
                        throws WvcmException
Returns the value of this proxy's IS_PROJECT_VOB property.

Returns:
true if the VOB tag is for a project VOB, else false
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getIsPublic

boolean getIsPublic()
                    throws WvcmException
Returns the value of this proxy's IS_PUBLIC property.

Returns:
true if the VOB tag is for a publicVOB, else false
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getMountOptions

String getMountOptions()
                       throws WvcmException
Returns the value of this proxy's MOUNT_OPTIONS property.

Returns:
string of mount options, null if none were specified.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getRegistryRegion

CcRegistryRegion getRegistryRegion()
                                   throws WvcmException
Returns the value of this proxy's REGISTRY_REGION property.

Returns:
A proxy for the registry region of this VOB tag.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getVob

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

Returns:
the VOB to which this tag refers, as a CcVob instance
Throws:
WvcmException - if this proxy doesn't define a value for this property.

setIsMounted

void setIsMounted(boolean mount)
                  throws WvcmException
Sets the value of this proxy's (@link #IS_MOUNTED) property.

Parameters:
mount - true to mount this VOB, else false to unmount it
Throws:
WvcmException

Generated Sat 22-Feb-2014 01:07 AM

Copyright © IBM 2014. All rights reserved.