Project: stp

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

All Superinterfaces:
CqResource, CqUserDbMember, Resource, StpResource

public interface CqAction
extends CqUserDbMember

An object that represents a method to be applied to an CqRecord.

The set of CqActions applicable to a CqRecord can be obtained from its CqRecordType resource. (See CqRecordType.ACTION_LIST)

Some Actions require additional arguments when they are applied to an Record. These will be documented in the description of the action types.

The user-friendly specification for the location of an action has the form

  cq.action:<record-type>/<action-name>@<db-set>/<user-db>
 


Nested Class Summary
static class CqAction.Type
          The type of an action, which places certain restrictions on its use.
 
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> DESTINATION_STATE
          The name of the state that a record will be in upon successful application of this action to the record.
static PropertyNameList.PropertyName<CqRecordType> RECORD_TYPE
          The record type with which this action is associated.
static PropertyNameList.PropertyName<List<String>> SOURCE_STATE_LIST
          A list of the states a record must be in to apply this action to it.
static PropertyNameList.PropertyName<CqAction.Type> TYPE
          The Type of this action.
 
Fields inherited from interface CqUserDbMember
DB_SET, USER_DB
 
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
 Map<String,Object> argumentMap()
          Returns the Map containing the argument name/value pairs for by this Action.
 void argumentMap(Map<String,Object> args)
          Sets any arguments needed when applying this action to an actionable resource.
 String getDestinationState()
          Returns the value of the DESTINATION_STATE property as defined by this proxy.
 CqRecordType getRecordType()
          Returns the value of the RECORD_TYPE property as defined by this proxy.
 List<String> getSourceStateList()
          Returns the value of the SOURCE_STATE_LIST property as defined by this proxy.
 CqAction.Type getType()
          Returns the value of the TYPE property as defined by this proxy.
 
Methods inherited from interface CqUserDbMember
getDbSet, getUserDb
 
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

DESTINATION_STATE

static final PropertyNameList.PropertyName<String> DESTINATION_STATE
The name of the state that a record will be in upon successful application of this action to the record.


RECORD_TYPE

static final PropertyNameList.PropertyName<CqRecordType> RECORD_TYPE
The record type with which this action is associated.


SOURCE_STATE_LIST

static final PropertyNameList.PropertyName<List<String>> SOURCE_STATE_LIST
A list of the states a record must be in to apply this action to it.


TYPE

static final PropertyNameList.PropertyName<CqAction.Type> TYPE
The Type of this action.

Method Detail

argumentMap

Map<String,Object> argumentMap()
Returns the Map containing the argument name/value pairs for by this Action.

Returns:
The argument/value Map defined for this action. Will be null if no such Map has been established.

argumentMap

void argumentMap(Map<String,Object> args)
Sets any arguments needed when applying this action to an actionable resource.

Parameters:
args - A Map associating each argument name with its corresponding value. May be null or empty if this action does not require any arguments.

getDestinationState

String getDestinationState()
                           throws WvcmException
Returns the value of the DESTINATION_STATE property as defined by this proxy.

Returns:
A String naming the state in which this action leaves a record when successfully applied to that record; an empty string if this action is not a CHANGE_STATE action.
Throws:
WvcmException - if this proxy does not define a value for the DESTINATION_STATE property.

getRecordType

CqRecordType getRecordType()
                           throws WvcmException
Returns the value of the RECORD_TYPE property as defined by this proxy.

Returns:
A CqRecordType proxy for the record type with which this action is associated.
Throws:
WvcmException - if this proxy does not define a value for the RECORD_TYPE property.

getSourceStateList

List<String> getSourceStateList()
                                throws WvcmException
Returns the value of the SOURCE_STATE_LIST property as defined by this proxy.

Returns:
A list of Strings, each containing the name of a state in which this action may be applied; an empty list if the action is not a CHANGE_STATE action.
Throws:
WvcmException - if this proxy does not define a value for the SOURCE_STATE_LIST property.

getType

CqAction.Type getType()
                      throws WvcmException
Returns the value of the TYPE property as defined by this proxy.

Returns:
A Type enumerator identifying the type of this action.
Throws:
WvcmException - if this proxy does not define a value for the TYPE property.

Generated Tue 22-May-2012 12:04 PM

Copyright © IBM 2012. All rights reserved.