com.ibm.rational.wvcm.stp.cq
Interface CqHook
- All Superinterfaces:
- CqResource, CqUserDbMember, Resource, StpResource
public interface CqHook
- extends CqUserDbMember
A schema-defined script to be executed during the application of an Action to
an actionable resource. Hooks can be referred to directly from record form
controls or in the source of another record, action or field hook.
Both named record hooks and global hooks are defined in the HOOK Namespace.
Named record hooks are defined as a child of a record type.
At this time, named record hooks and global hooks are supported.
Named record hooks are defined by a record type as the value of the
NAMED_HOOK_LIST property of a CqRecordType resource.
Global hook names must be known in advance and used to construct a location.
These can then be used as an argument to CqRecord.doFireNamedHook();
The user-friendly specification for the location of a named hook has the form
cq.hook:<record-type>/<hook-name>@<db-set>/<user-db>
The user-friendly specification for the location of a global hook has the form
cq.hook:<hook-name>@<db-set>/<user-db>
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 |
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 |
Copyright © IBM 2014. All rights reserved.