Project: stp

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

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

public interface CcVob
extends StpRepository, CcVobResource

A proxy for a ClearCase versioned object base (VOB) - the repository for all server-side ClearCase resources.

A VOB can either be a regular VOB or project VOB. A project VOB is a partcular type of VOB that may contain UCM project metadata - projects, streams, activities, components, and baselines.


Field Summary
static PropertyNameList.PropertyName<ResourceList<CcAttributeType>> ATTRIBUTE_TYPE_LIST
          List of attribute types in this VOB.
static PropertyNameList.PropertyName<ResourceList<CcBranchType>> BRANCH_TYPE_LIST
          List of branch types in this VOB.
static PropertyNameList.PropertyName<ResourceList<CcComponent>> COMPONENT_LIST
          List of UCM components in this project VOB.
static PropertyNameList.PropertyName<ResourceList<CcElementType>> ELEMENT_TYPE_LIST
          List of element types in this VOB.
static PropertyNameList.PropertyName<ResourceList<CcHyperlinkType>> HYPERLINK_TYPE_LIST
          List of hyperlink types in this VOB.
static PropertyNameList.PropertyName<Boolean> IS_PROJECT_VOB
          Is this VOB a project VOB?
static PropertyNameList.PropertyName<Boolean> IS_REPLICATED
          Is this VOB replicated?
static PropertyNameList.PropertyName<ResourceList<CcLabelType>> LABEL_TYPE_LIST
          List of label types in this VOB.
static PropertyNameList.PropertyName<ResourceList<CcVob>> ORDERED_ADMIN_VOB_LIST
          Ordered list of Admin VOBs for this VOB with the immediate parent first and the furthest ancestor last.
static PropertyNameList.PropertyName<ResourceList<CcReplica>> REPLICA_LIST
          The list of MultiSite replicas of this VOB.
static PropertyNameList.PropertyName<CcProjectFolder> ROOT_PROJECT_FOLDER
          This project VOB's root UCM project folder.
static PropertyNameList.PropertyName<Long> SCHEMA_VERSION
          This VOB's db schema version.
static PropertyNameList.PropertyName<ResourceList<CcTriggerType>> TRIGGER_TYPE_LIST
          List of trigger types in this VOB
static PropertyNameList.PropertyName<CcVobTag> VOB_TAG
          This VOB's VOB tag as a CcVobTag resource in the current registry region.
static PropertyNameList.PropertyName<String> VOB_TAG_STRING
          This VOB's VOB tag as a string in the current registry region.
 
Fields inherited from interface com.ibm.rational.wvcm.stp.StpRepository
PRODUCT_INFO
 
Fields inherited from interface CcVobResource
ATTRIBUTE_LIST, CC_MASTER_REPLICA, CURRENT_REPLICA, HAS_LOCAL_MASTERSHIP, HYPERLINK_LIST, LOCK_INFO, PERMISSIONS, VOB
 
Method Summary
 boolean doIsLabelTypeVisible(String labelName)
          Check to see if a type with the given name is visible in this VOB.
 ResourceList<CcAttributeType> getAttributeTypeList()
          Get the value of this proxy's ATTRIBUTE_TYPE_LIST property.
 ResourceList<CcBranchType> getBranchTypeList()
          Get the value of this proxy's BRANCH_TYPE_LIST property.
 ResourceList<CcComponent> getComponentList()
          Get the value of this proxy's COMPONENT_LIST property.
 ResourceList<CcElementType> getElementTypeList()
          Get the value of this proxy's ELEMENT_TYPE_LIST property.
 ResourceList<CcHyperlinkType> getHyperlinkTypeList()
          Get the value of this proxy's HYPERLINK_TYPE_LIST property.
 boolean getIsProjectVob()
          Returns the value of this proxy's IS_PROJECT_VOB property.
 boolean getIsReplicated()
          Returns the value of this proxy's IS_REPLICATED property.
 ResourceList<CcLabelType> getLabelTypeList()
          Get the value of this proxy's LABEL_TYPE_LIST property.
 ResourceList<CcVob> getOrderedAdminVobList()
          Get the value of this proxy's ORDERED_ADMIN_VOB_LIST property.
 ResourceList<CcReplica> getReplicaList()
          Returns the value of this proxy's REPLICA_LIST property.
 CcProjectFolder getRootProjectFolder()
          Returns the value of this proxy's ROOT_PROJECT_FOLDER property.
 long getSchemaVersion()
          Get the value of this proxy's SCHEMA_VERSION property.
 ResourceList<CcTriggerType> getTriggerTypeList()
          Get the value of this proxy's TRIGGER_TYPE_LIST property.
 CcVobTag getVobTag()
          Returns the value of this proxy's VOB_TAG property.
 String getVobTagString()
          Returns the value of this proxy's VOB_TAG_STRING property.
 
Methods inherited from interface com.ibm.rational.wvcm.stp.StpRepository
getProductInfo
 
Methods inherited from interface CcVobResource
getAttributeList, getCurrentReplica, getHasLocalMastership, getHyperlinkList, getLockInfo, getMasterReplica, getPermissions, getVob, setLockInfo, setPermissions
 
Methods inherited from interface CcResource
ccProvider, doResolve, isResolved
 

Field Detail

ATTRIBUTE_TYPE_LIST

static final PropertyNameList.PropertyName<ResourceList<CcAttributeType>> ATTRIBUTE_TYPE_LIST
List of attribute types in this VOB. Includes global types.


BRANCH_TYPE_LIST

static final PropertyNameList.PropertyName<ResourceList<CcBranchType>> BRANCH_TYPE_LIST
List of branch types in this VOB. Includes global types.


COMPONENT_LIST

static final PropertyNameList.PropertyName<ResourceList<CcComponent>> COMPONENT_LIST
List of UCM components in this project VOB. This property is only supported on project VOBs.


ELEMENT_TYPE_LIST

static final PropertyNameList.PropertyName<ResourceList<CcElementType>> ELEMENT_TYPE_LIST
List of element types in this VOB. Includes global types.


HYPERLINK_TYPE_LIST

static final PropertyNameList.PropertyName<ResourceList<CcHyperlinkType>> HYPERLINK_TYPE_LIST
List of hyperlink types in this VOB. Includes global types.


IS_PROJECT_VOB

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


IS_REPLICATED

static final PropertyNameList.PropertyName<Boolean> IS_REPLICATED
Is this VOB replicated?


LABEL_TYPE_LIST

static final PropertyNameList.PropertyName<ResourceList<CcLabelType>> LABEL_TYPE_LIST
List of label types in this VOB. Includes global types.


ORDERED_ADMIN_VOB_LIST

static final PropertyNameList.PropertyName<ResourceList<CcVob>> ORDERED_ADMIN_VOB_LIST
Ordered list of Admin VOBs for this VOB with the immediate parent first and the furthest ancestor last.


REPLICA_LIST

static final PropertyNameList.PropertyName<ResourceList<CcReplica>> REPLICA_LIST
The list of MultiSite replicas of this VOB. This list may be incomplete; other replicas may exist, but their creation packets have not yet been imported at the current replica.


ROOT_PROJECT_FOLDER

static final PropertyNameList.PropertyName<CcProjectFolder> ROOT_PROJECT_FOLDER
This project VOB's root UCM project folder. This property is only supported on project VOBs.


SCHEMA_VERSION

static final PropertyNameList.PropertyName<Long> SCHEMA_VERSION
This VOB's db schema version.


TRIGGER_TYPE_LIST

static final PropertyNameList.PropertyName<ResourceList<CcTriggerType>> TRIGGER_TYPE_LIST
List of trigger types in this VOB


VOB_TAG

static final PropertyNameList.PropertyName<CcVobTag> VOB_TAG
This VOB's VOB tag as a CcVobTag resource in the current registry region.


VOB_TAG_STRING

static final PropertyNameList.PropertyName<String> VOB_TAG_STRING
This VOB's VOB tag as a string in the current registry region.

Method Detail

doIsLabelTypeVisible

boolean doIsLabelTypeVisible(String labelName)
                             throws WvcmException
Check to see if a type with the given name is visible in this VOB. To be visible a type must be an ordinary or local type defined in the VOB or a global type in the AdminVOB hierarchy above this VOB which has not yet been instantiated.

Parameters:
labelName - Name of the label to look for.
Returns:
true if a label with that name is visible from this VOB, else false.
Throws:
WvcmException

getAttributeTypeList

ResourceList<CcAttributeType> getAttributeTypeList()
                                                   throws WvcmException
Get the value of this proxy's ATTRIBUTE_TYPE_LIST property. Note that this includes global types higher up the Admin VOB hierarchy with no local copy in this VOB.

Returns:
list of attribute types in this VOB as AttributeType instances.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getBranchTypeList

ResourceList<CcBranchType> getBranchTypeList()
                                             throws WvcmException
Get the value of this proxy's BRANCH_TYPE_LIST property. Note that this includes global types higher up the Admin VOB hierarchy with no local copy in this VOB.

Returns:
list of branch types in this VOB as BranchType instances.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getComponentList

ResourceList<CcComponent> getComponentList()
                                           throws WvcmException
Get the value of this proxy's COMPONENT_LIST property.

Returns:
list of components in this VOB as UcmComponent instances.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getElementTypeList

ResourceList<CcElementType> getElementTypeList()
                                               throws WvcmException
Get the value of this proxy's ELEMENT_TYPE_LIST property. Note that this includes global types higher up the Admin VOB hierarchy with no local copy in this VOB.

Returns:
list of element types in this VOB as ElementType instances.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getHyperlinkTypeList

ResourceList<CcHyperlinkType> getHyperlinkTypeList()
                                                   throws WvcmException
Get the value of this proxy's HYPERLINK_TYPE_LIST property. Note that this includes global types higher up the Admin VOB hierarchy with no local copy in this VOB.

Returns:
list of hyperlink types in this VOB as HyperlinkType instances.
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 this VOB is a project VOB, else false
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getIsReplicated

boolean getIsReplicated()
                        throws WvcmException
Returns the value of this proxy's IS_REPLICATED property.

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

getLabelTypeList

ResourceList<CcLabelType> getLabelTypeList()
                                           throws WvcmException
Get the value of this proxy's LABEL_TYPE_LIST property. Note that this includes global types higher up the Admin VOB hierarchy with no local copy in this VOB.

Returns:
list of label types in this VOB as LabelType instances.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getOrderedAdminVobList

ResourceList<CcVob> getOrderedAdminVobList()
                                           throws WvcmException
Get the value of this proxy's ORDERED_ADMIN_VOB_LIST property.

Returns:
list of Admin VOBs for this VOB
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getReplicaList

ResourceList<CcReplica> getReplicaList()
                                       throws WvcmException
Returns the value of this proxy's REPLICA_LIST property.

Returns:
this VOB's list of replicas as a list of CcReplica instances
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getRootProjectFolder

CcProjectFolder getRootProjectFolder()
                                     throws WvcmException
Returns the value of this proxy's ROOT_PROJECT_FOLDER property.

Returns:
A client proxy for this project VOB's root project folder
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getSchemaVersion

long getSchemaVersion()
                      throws WvcmException
Get the value of this proxy's SCHEMA_VERSION property.

Returns:
long indicating VOB's schema version
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getTriggerTypeList

ResourceList<CcTriggerType> getTriggerTypeList()
                                               throws WvcmException
Get the value of this proxy's TRIGGER_TYPE_LIST property.

Returns:
list of trigger types in this VOB as TriggerType instances.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getVobTag

CcVobTag getVobTag()
                   throws WvcmException
Returns the value of this proxy's VOB_TAG property.

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

getVobTagString

String getVobTagString()
                       throws WvcmException
Returns the value of this proxy's VOB_TAG_STRING property.

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

Generated Mon 2-Mar-2009 11:14 PM

Copyright © IBM 2009. All rights reserved.