Project: stp

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

All Superinterfaces:
CcResource, Resource, StpResource

public interface CcViewTag
extends CcResource

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

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


Nested Class Summary
static class CcViewTag.ViewType
          Type of ClearCase view.
 
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<Boolean> IS_ACTIVE
          Is the View represented by this tag started?
static PropertyNameList.PropertyName<Boolean> IS_UCM_VIEW
          Is this a tag for a UCM view?
static PropertyNameList.PropertyName<CcRegistryRegion> REGISTRY_REGION
          The registry region this tag resides in
static PropertyNameList.PropertyName<CcView> VIEW
          The view to which this tag refers
static PropertyNameList.PropertyName<CcViewTag.ViewType> VIEW_TYPE
          Kind of view 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
 boolean getIsActive()
          Returns the value of this proxy's IS_ACTIVE property.
 boolean getIsUcmView()
          Returns the value of this proxy's IS_UCM_VIEW property.
 CcRegistryRegion getRegistryRegion()
          Returns the value of this proxy's REGISTRY_REGION property.
 CcView getView()
          Returns the value of this proxy's VIEW property.
 CcViewTag.ViewType getViewType()
          Returns the value of this proxy's VIEW_TYPE property.
 void setIsActive(boolean isActive)
          Sets the value of this proxy's (@link #IS_ACTIVE) 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

IS_ACTIVE

static final PropertyNameList.PropertyName<Boolean> IS_ACTIVE
Is the View represented by this tag started?


IS_UCM_VIEW

static final PropertyNameList.PropertyName<Boolean> IS_UCM_VIEW
Is this a tag for a UCM view?


REGISTRY_REGION

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


VIEW

static final PropertyNameList.PropertyName<CcView> VIEW
The view to which this tag refers


VIEW_TYPE

static final PropertyNameList.PropertyName<CcViewTag.ViewType> VIEW_TYPE
Kind of view to which this tag refers

Method Detail

getIsActive

boolean getIsActive()
                    throws WvcmException
Returns the value of this proxy's IS_ACTIVE property.

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

getIsUcmView

boolean getIsUcmView()
                     throws WvcmException
Returns the value of this proxy's IS_UCM_VIEW property.

Returns:
true if the view tag is for a UCM view, else false
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:
The registry region of this view tag.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getView

CcView getView()
               throws WvcmException
Returns the value of this proxy's VIEW property.

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

getViewType

CcViewTag.ViewType getViewType()
                               throws WvcmException
Returns the value of this proxy's VIEW_TYPE property.

Returns:
Kind of view this tag refers to.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

setIsActive

void setIsActive(boolean isActive)
                 throws WvcmException
Sets the value of this proxy's (@link #IS_ACTIVE) property.

Parameters:
isActive - true to start the server for this view; false to stop it
Throws:
WvcmException

Generated Mon 30-Jan-2017 04:26 PM

Copyright © IBM 2017. All rights reserved.