public interface CqAction extends CqUserDbMember
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>
Modifier and Type | Interface and Description |
---|---|
static class |
CqAction.Type
The type of an action, which places certain restrictions on its use.
|
StpResource.UnsupportedProperty
Resource.CopyFlag
Modifier and Type | Field and Description |
---|---|
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. |
DB_SET, USER_DB
ALL_PROPERTIES, AUTHENTICATION_REALM, CREATOR_GROUP_NAME, CREATOR_LOGIN_NAME, EFFICIENT_LOCATION, INVALID_PROPERTIES, REPOSITORY, STABLE_LOCATION, USER_FRIENDLY_LOCATION
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
Modifier and Type | Method and Description |
---|---|
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. |
getDbSet, getUserDb
cqProvider, getComment, getContentCharacterSet, getContentIdentifier, getContentLanguage, getContentLength, getContentType, getCreationDate, getCreatorDisplayName, getCreatorGroupName, getCreatorLoginName, getIsExecutable, getLastModified, getProviderList, getWorkspaceFolderList, setComment, setContentCharacterSet, setContentLanguage, setContentType, setCreatorDisplayName, setIsExecutable
doReadProperties, equals, getAllProperties, getAuthenticationRealm, getCustomProperties, getEfficientLocation, getInvalidProperties, getMetaProperties, getPropertyException, getRepository, getResourceError, getResourceIdentifier, getStableLocation, getUserFriendlyLocation, hashCode, hasProperties, initMetaProperty, proxyType, setPropertyClean, stpLocation, stpProvider
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
static final PropertyNameList.PropertyName<String> DESTINATION_STATE
static final PropertyNameList.PropertyName<CqRecordType> RECORD_TYPE
static final PropertyNameList.PropertyName<List<String>> SOURCE_STATE_LIST
static final PropertyNameList.PropertyName<CqAction.Type> TYPE
Type
of this action.Map<String,Object> argumentMap()
void argumentMap(Map<String,Object> args)
args
- A Map associating each argument name with its corresponding
value. May be null or empty if this action does not
require any arguments.String getDestinationState() throws WvcmException
DESTINATION_STATE
property as defined by this proxy.WvcmException
- if this proxy does not define a value for the
DESTINATION_STATE
property.CqRecordType getRecordType() throws WvcmException
RECORD_TYPE
property as
defined by this proxy.WvcmException
- if this proxy does not define a value for the
RECORD_TYPE
property.List<String> getSourceStateList() throws WvcmException
SOURCE_STATE_LIST
property as defined by this proxy.WvcmException
- if this proxy does not define a value for the
SOURCE_STATE_LIST
property.CqAction.Type getType() throws WvcmException
TYPE
property as defined by this
proxy.WvcmException
- if this proxy does not define a value for the
TYPE
property.Copyright © IBM 2018. All rights reserved.