Project: stp

com.ibm.rational.wvcm.stp
Interface StpActivity

All Superinterfaces:
Resource, StpResource
All Known Subinterfaces:
CcActivity, CqRecord

public interface StpActivity
extends StpResource

StpActivity is an interface for a proxy which may represent one of these three cases:

It serves two purposes:

Although this interface extends StpResource, it is an abstraction. There is no factory method for constructing an instance of StpActivity, specifically. Proxies that implement this interface may be constructed only by constructing a CcActivity or a CqRecord. The location of an StpActivity will be that of a CcActivity or a CqRecord.


Nested Class Summary
static class StpActivity.CqUcmIntegrationState
           
 
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<CcActivity> BOUND_CC_ACTIVITY
          The UCM activity to which this ClearQuest record is bound.
static PropertyNameList.PropertyName<String> BOUND_CC_ACTIVITY_LOCATION
          The location of UCM activity to which this ClearQuest record is bound.
static PropertyNameList.PropertyName<CqRecord> BOUND_CQ_RECORD
          The ClearQuest record to which this UCM activity is bound.
static PropertyNameList.PropertyName<StpActivity.CqUcmIntegrationState> CQ_UCM_INTEGRATION_STATE
          This activity's CQ-UCM integration state
static PropertyNameList.PropertyName<String> HEADLINE
          A descriptive string - not necessarily unique - used to identify this activity when it appears in a GUI or in a report.
static PropertyNameList.PropertyName<String> ID_SELECTOR
          A unique string to identify this activity.
 
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
 CcActivity getBoundCcActivity()
          Returns the value of this proxy's BOUND_CC_ACTIVITY property.
 String getBoundCcActivityLocation()
          Returns the value of this proxy's BOUND_CC_ACTIVITY_LOCATION property.
 CqRecord getBoundCqRecord()
          Returns the value of this proxy's BOUND_CQ_RECORD property.
 StpActivity.CqUcmIntegrationState getCqUcmIntegrationState()
          Returns the value of this proxy's CQ_UCM_INTEGRATION_STATE property.
 String getHeadline()
          Returns the value of this proxy's HEADLINE property.
 String getIdSelector()
          Returns the value of this proxy's ID_SELECTOR property.
 void setHeadline(String headline)
          Defines a new value for the HEADLINE property of this proxy.
 
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

BOUND_CC_ACTIVITY

static final PropertyNameList.PropertyName<CcActivity> BOUND_CC_ACTIVITY
The UCM activity to which this ClearQuest record is bound. In ClearQuest-enabled UCM projects, ClearQuest records may or may not be bound. In ClearQuest-enabled UCM projects the value of this property may or may not be null. In non-CQ-enabled projects the value of this property will always be null. If this StpActivity represents a UCM Activity, the value of this property will be this StpActivity and always non-null.


BOUND_CC_ACTIVITY_LOCATION

static final PropertyNameList.PropertyName<String> BOUND_CC_ACTIVITY_LOCATION
The location of UCM activity to which this ClearQuest record is bound. In ClearQuest-enabled UCM projects, ClearQuest records may or may not be bound. In ClearQuest-enabled UCM projects the value of this property may or may not be null. In non-CQ-enabled projects the value of this property will always be null. If this StpActivity represents a UCM Activity, the value of this property will be this StpActivity's location and always non-null.


BOUND_CQ_RECORD

static final PropertyNameList.PropertyName<CqRecord> BOUND_CQ_RECORD
The ClearQuest record to which this UCM activity is bound. In ClearQuest-enabled UCM projects, all UCM activities are bound and the value of this property will always be non-null. In non-CQ-enabled projects, the value of this property will always be null. If this StpActivity represents a ClearQuest record, the value of this property will be this StpActivity and always non-null.


CQ_UCM_INTEGRATION_STATE

static final PropertyNameList.PropertyName<StpActivity.CqUcmIntegrationState> CQ_UCM_INTEGRATION_STATE
This activity's CQ-UCM integration state


HEADLINE

static final PropertyNameList.PropertyName<String> HEADLINE
A descriptive string - not necessarily unique - used to identify this activity when it appears in a GUI or in a report.


ID_SELECTOR

static final PropertyNameList.PropertyName<String> ID_SELECTOR
A unique string to identify this activity.

Method Detail

getBoundCcActivity

CcActivity getBoundCcActivity()
                              throws WvcmException
Returns the value of this proxy's BOUND_CC_ACTIVITY property.

Returns:
this activity's bound CQ record, or null if thi activity is not bound to a CcActivity
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getBoundCcActivityLocation

String getBoundCcActivityLocation()
                                  throws WvcmException
Returns the value of this proxy's BOUND_CC_ACTIVITY_LOCATION property.

Returns:
bound activity's location as string, or null if this record is not bound to a CcActivity
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getBoundCqRecord

CqRecord getBoundCqRecord()
                          throws WvcmException
Returns the value of this proxy's BOUND_CQ_RECORD property.

Returns:
this activity's bound CQ record, or null if activity is not bound to a CQ record.
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getCqUcmIntegrationState

StpActivity.CqUcmIntegrationState getCqUcmIntegrationState()
                                                           throws WvcmException
Returns the value of this proxy's CQ_UCM_INTEGRATION_STATE property.

Returns:
this activity's CQ-UCM integration state
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getHeadline

String getHeadline()
                   throws WvcmException
Returns the value of this proxy's HEADLINE property.

Returns:
A String containing the description of this StpActivity
Throws:
WvcmException - if this proxy doesn't define a value for this property.

getIdSelector

String getIdSelector()
                     throws WvcmException
Returns the value of this proxy's ID_SELECTOR property.

Returns:
A String containing the unique identifier for this StpActivity
Throws:
WvcmException - if this proxy doesn't define a value for this property.

setHeadline

void setHeadline(String headline)
Defines a new value for the HEADLINE property of this proxy.

Parameters:
headline - The new headline string. Must not be null.

Generated Mon 24-Aug-2015 12:11 PM

Copyright © IBM 2015. All rights reserved.