|
Oracle® Fusion Middleware Oracle Imaging and Process Management Java API Reference 11g Release 1 (11.1.1) E12853-02 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |
java.lang.Object
java.lang.Enum<WorkflowFunction>
oracle.imaging.WorkflowFunction
public enum WorkflowFunction
The set of Workflow Mapping Functions to map various values to workflow payload elements.
Nested Class Summary | |
---|---|
static class |
WorkflowFunction.FunctionType |
Enum Constant Summary | |
---|---|
APPLICATION_ID Maps the Id of an application to which a document belongs to a workflow payload element. |
|
APPLICATION_NAME Maps the name of an application to which a document belongs to a workflow payload element. |
|
BATCH_ID Maps the batch Id of a document to a workflow payload element. |
|
DOCUMENT_CREATE_BY Maps the name of a user who created a document to a workflow payload element. |
|
DOCUMENT_CREATE_DATE Maps the date when a document was created to a workflow payload element. |
|
DOCUMENT_FIELDVALUE Maps the value of a document application field to a workflow payload element. |
|
DOCUMENT_ID Maps the Id of a document to a workflow payload element. |
|
DOCUMENT_MIME_TYPE Maps the MIME type of a document to a workflow payload element. |
|
DOCUMENT_MODIFY_BY Maps the name of a user who last modified a document to a workflow payload element. |
|
DOCUMENT_MODIFY_DATE Maps the date when a document was last modified to a workflow payload element. |
|
DOCUMENT_NAME Maps the name of a document to a workflow payload element. |
|
DOCUMENT_SIZE Maps the size of a document to a workflow payload element. |
|
DOCUMENT_STORAGE_VOLUME Maps the name of a volume where a document is stored to a workflow payload element. |
|
DOCUMENT_STORAGE_VOLUME_DATE Maps the date used for storage stage actions related to a document to a workflow payload element. |
|
DOCUMENT_URL Maps the URL to view a document to a workflow payload element. |
|
DOCUMENT_URL_ROOT Maps the root of a URL for the imaging system to a workflow payload element. |
|
DOCUMENT_VERSION Maps the version number of a document to a workflow payload element. |
|
FORMAT_VALUE Maps a string containing formating codes to a workflow payload element. |
|
POLICY_OVERRIDE Maps a string value to a workflow payload element. |
|
SUPPORTING_CONTENT Maps the value data contained in a documents supporting context. |
|
VALUE_FALSE Maps the boolean value False to a workflow payload element. |
|
VALUE_TRUE Maps the boolean value True to a workflow payload element. |
Field Summary | |
---|---|
static char |
CLOSE_DELIM |
static java.lang.String |
FUNC_PARAM_SEP |
static char |
OPEN_DELIM |
Method Summary | |
---|---|
java.lang.String |
getKey() Gets the key for the WorkflowFunction. |
java.lang.String |
getLabel(java.util.Locale locale) |
WorkflowFunction.FunctionType |
getType() Gets the type for the WorkflowFunction. |
static WorkflowFunction |
getWorkflowFunction(java.lang.String function) |
boolean |
isValueRequired() Returns whether a value is required. |
static WorkflowFunction |
valueOf(java.lang.String name) Returns the enum constant of this type with the specified name. |
static WorkflowFunction[] |
values() Returns an array containing the constants of this enum type, in the order they are declared. |
Methods inherited from class java.lang.Enum |
---|
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Enum Constant Detail |
---|
public static final WorkflowFunction DOCUMENT_ID
Function Key: DocId
Function Type: WorkflowFunction.FunctionType#NUMBER
A value parameter is not allowed.
public static final WorkflowFunction DOCUMENT_NAME
Function Key: DocName
Function Type: WorkflowFunction.FunctionType#TEXT
A value parameter is not allowed.
public static final WorkflowFunction DOCUMENT_VERSION
Function Key: Version
Function Type: WorkflowFunction.FunctionType#NUMBER
A value parameter is not allowed.
public static final WorkflowFunction DOCUMENT_CREATE_BY
Function Key: CreateBy
Function Type: WorkflowFunction.FunctionType#TEXT
A value parameter is not allowed.
public static final WorkflowFunction DOCUMENT_CREATE_DATE
Function Key: CreateDate
Function Type: WorkflowFunction.FunctionType#DATE
A value parameter is not allowed.
public static final WorkflowFunction DOCUMENT_MODIFY_BY
Function Key: ModifyBy
Function Type: WorkflowFunction.FunctionType#TEXT
A value parameter is not allowed.
public static final WorkflowFunction DOCUMENT_MODIFY_DATE
Function Key: ModifyDate
Function Type: WorkflowFunction.FunctionType#DATE
A value parameter is not allowed.
public static final WorkflowFunction DOCUMENT_MIME_TYPE
Function Key: MimeType
Function Type: WorkflowFunction.FunctionType#TEXT
A value parameter is not allowed.
public static final WorkflowFunction DOCUMENT_URL
Function Key: DocUrl
Function Type: WorkflowFunction.FunctionType#URI
A value parameter is not allowed.
public static final WorkflowFunction DOCUMENT_URL_ROOT
Function Key: DocUrlRoot
Function Type: WorkflowFunction.FunctionType#TEXT
A value parameter is not allowed.
public static final WorkflowFunction DOCUMENT_SIZE
Function Key: DocSize
Function Type: WorkflowFunction.FunctionType#NUMBER
A value parameter is not allowed.
public static final WorkflowFunction DOCUMENT_STORAGE_VOLUME_DATE
Function Key: StoragePolicyDate
Function Type: WorkflowFunction.FunctionType#DATE
A value parameter is not allowed.
public static final WorkflowFunction DOCUMENT_STORAGE_VOLUME
Function Key: StorageVolume
Function Type: WorkflowFunction.FunctionType#TEXT
A value parameter is not allowed.
public static final WorkflowFunction APPLICATION_ID
Function Key: AppId
Function Type: WorkflowFunction.FunctionType#NUMBER
A value parameter is not allowed.
public static final WorkflowFunction APPLICATION_NAME
Function Key: AppName
Function Type: WorkflowFunction.FunctionType#TEXT
A value parameter is not allowed.
public static final WorkflowFunction BATCH_ID
Function Key: BatchId
Function Type: WorkflowFunction.FunctionType#NUMBER
A value parameter is not allowed.
public static final WorkflowFunction DOCUMENT_FIELDVALUE
Function Key: FieldValue
Function Type: Varies
A value parameter is required.
The value parameter is the name of an application field.
public static final WorkflowFunction SUPPORTING_CONTENT
Function Key: SupportingContent
Function Type: Varies
A value parameter is required.
The value parameter is the name of the supporting content key.
public static final WorkflowFunction VALUE_TRUE
Function Key: True
Function Type: WorkflowFunction.FunctionType#BOOLEAN
A value parameter is not allowed.
public static final WorkflowFunction VALUE_FALSE
Function Key: False
Function Type: WorkflowFunction.FunctionType#BOOLEAN
A value parameter is not allowed.
public static final WorkflowFunction FORMAT_VALUE
Function Key: FormatValue
Function Type: Special
A value parameter is required.
The value parameter contains literal text and function codes. Function codes must begin with [
, contain a function name, contain an optional parameter, and end with ]
. If a function requires a parameter, it is separated from the function name with a colon (:
).
For example, given a document with an Id of 76345, a Version of 1, and an application Invoice Number field value 4598220, the following format values will evaluate to:
Id=[DocId], Version=[Version]
- Id=76345, Version=1Invoice [FieldValue:Invoice Number]
- Invoice 4598220A FormatValue function may not contain nested FormatValue functions.
public static final WorkflowFunction POLICY_OVERRIDE
Function Key: PolicyOverride
Function Type: WorkflowFunction.FunctionType#POLICY
A value parameter is required.
Field Detail |
---|
public static final java.lang.String FUNC_PARAM_SEP
public static final char OPEN_DELIM
public static final char CLOSE_DELIM
Method Detail |
---|
public static WorkflowFunction[] values()
for (WorkflowFunction c : WorkflowFunction.values()) System.out.println(c);
public static WorkflowFunction valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is nullpublic java.lang.String getKey()
public java.lang.String getLabel(java.util.Locale locale)
public WorkflowFunction.FunctionType getType()
public boolean isValueRequired()
true
if a value is required; otherwise, false
public static WorkflowFunction getWorkflowFunction(java.lang.String function)
|
Oracle® Fusion Middleware Oracle Imaging and Process Management Java API Reference 11g Release 1 (11.1.1) E12853-02 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |