Project: stp

com.ibm.rational.wvcm.stp.cq
Interface CqReplica

All Superinterfaces:
CqResource, Resource, StpResource

public interface CqReplica
extends CqResource

A proxy interface for a ClearQuest replica. Proxies of this type are returned by the CqDb.LOCAL_REPLICA property and the CQ_MASTER_REPLICA property of CqGroup, CQUser, CqQueryFolderItem, and CqRecord. A database has mastership of a resource if it's LOCAL_REPLICA property matches the CQ_MASTER_REPLICA of the resource. Setting the CQ_MASTER_REPLICA property of a resource to a new CqReplica value will change the mastership of that resource to that replica. A list of possible replica names is returned by the CHOICE_LIST property of the system-owned field named "ratl_mastership"

The user-friendly specification for the location of a replica has the form

  cq.replica:<replica-name>@<db-set>
 


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<CqDbSet> DB_SET
          The database set that contains this replica
 
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
 CqDbSet getDbSet()
          Returns the value of the DB_SET property as defined by this proxy.
 
Methods inherited from interface CqResource
cqProvider, getComment, getContentCharacterSet, getContentIdentifier, getContentLanguage, getContentLength, getContentType, getCreationDate, getCreatorDisplayName, getCreatorGroupName, getCreatorLoginName, getIsExecutable, getLastModified, getProviderList, getWorkspaceFolderList, setComment, setContentCharacterSet, setContentLanguage, setContentType, setCreatorDisplayName, setIsExecutable
 
Methods inherited from interface com.ibm.rational.wvcm.stp.StpResource
doReadProperties, equals, getAllProperties, getAuthenticationRealm, 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, getDisplayName, getParentList, getPathnameLocation, getProperty, initProperty, location, lookupProperty, modifyLocation, propertyNameList, provider, removeProperty, setDisplayName, setProperty, setProperty, updatedPropertyNameList
 

Field Detail

DB_SET

static final PropertyNameList.PropertyName<CqDbSet> DB_SET
The database set that contains this replica

Method Detail

getDbSet

CqDbSet getDbSet()
                 throws WvcmException
Returns the value of the DB_SET property as defined by this proxy.

Returns:
A CqDbSet proxy for the database set that contains this replica.
Throws:
WvcmException - if this proxy does not define a value for the DB_SET property.

Generated Wed 18-May-2011 04:12 PM

Copyright © IBM 2011. All rights reserved.