Skip navigation links

oracle.imaging
Enum BpelFunction

java.lang.Object
java.lang.Enum<BpelFunction>
oracle.imaging.BpelFunction

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BpelFunction>

public enum BpelFunction

extends java.lang.Enum<BpelFunction>

The set of BPEL Mapping Functions to map various values to BPEL payload elements.

Nested Class Summary

static class

BpelFunction.FunctionType

Enum Constant Summary

APPLICATION_ID
Maps the Id of an application to which a document belongs to a BPEL payload element.

APPLICATION_NAME
Maps the name of an application to which a document belongs to a BPEL payload element.

BATCH_ID
Maps the batch Id of a document to a BPEL payload element.

DOCUMENT_CREATE_BY
Maps the name of a user who created a document to a BPEL payload element.

DOCUMENT_CREATE_DATE
Maps the date when a document was created to a BPEL payload element.

DOCUMENT_FIELDVALUE
Maps the value of a document application field to a BPEL payload element.

DOCUMENT_ID
Maps the Id of a document to a BPEL payload element.

DOCUMENT_MIME_TYPE
Maps the MIME type of a document to a BPEL payload element.

DOCUMENT_MODIFY_BY
Maps the name of a user who last modified a document to a BPEL payload element.

DOCUMENT_MODIFY_DATE
Maps the date when a document was last modified to a BPEL payload element.

DOCUMENT_NAME
Maps the name of a document to a BPEL payload element.

DOCUMENT_SIZE
Maps the size of a document to a BPEL payload element.

DOCUMENT_STORAGE_VOLUME
Maps the name of a volume where a document is stored to a BPEL payload element.

DOCUMENT_STORAGE_VOLUME_DATE
Maps the date used for storage stage actions related to a document to a BPEL payload element.

DOCUMENT_URL
Maps the URL to view a document to a BPEL payload element.

DOCUMENT_URL_ROOT
Maps the URL to view a document to a BPEL payload element.

DOCUMENT_VERSION
Maps the version number of a document to a BPEL payload element.

FORMAT_VALUE
Maps a string containing formating codes to a BPEL payload element.

POLICY_OVERRIDE
Maps a string value to a BPEL payload element.

VALUE_FALSE
Maps the boolean value False to a BPEL payload element.

VALUE_TRUE
Maps the boolean value True to a BPEL payload element.

Field Summary

static char	CLOSE_DELIM
static java.lang.String	FUNC_PARAM_SEP
static char	OPEN_DELIM

Method Summary

static BpelFunction	getBpelFunction(java.lang.String function)
java.lang.String	getKey() Gets the key for the BpelFunction.
java.lang.String	getLabel(java.util.Locale locale)
abstract java.lang.String	getMappedValue(Document document, java.lang.String value, java.lang.String xmlType) Returns the mapped value for this BpelFunction.
BpelFunction.FunctionType	getType() Gets the type for the BpelFunction.
boolean	isValueRequired() Returns whether a value is required.
static BpelFunction	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static BpelFunction[]	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

DOCUMENT_ID

public static final BpelFunction DOCUMENT_ID

Maps the Id of a document to a BPEL payload element.

Function Key: DocId

Function Type: BpelFunction.FunctionType#NUMBER

A value parameter is not allowed.

DOCUMENT_NAME

public static final BpelFunction DOCUMENT_NAME

Maps the name of a document to a BPEL payload element.

Function Key: DocName

Function Type: BpelFunction.FunctionType#TEXT

A value parameter is not allowed.

DOCUMENT_VERSION

public static final BpelFunction DOCUMENT_VERSION

Maps the version number of a document to a BPEL payload element.

Function Key: Version

Function Type: BpelFunction.FunctionType#NUMBER

A value parameter is not allowed.

DOCUMENT_CREATE_BY

public static final BpelFunction DOCUMENT_CREATE_BY

Maps the name of a user who created a document to a BPEL payload element.

Function Key: CreateBy

Function Type: BpelFunction.FunctionType#TEXT

A value parameter is not allowed.

DOCUMENT_CREATE_DATE

public static final BpelFunction DOCUMENT_CREATE_DATE

Maps the date when a document was created to a BPEL payload element.

Function Key: CreateDate

Function Type: BpelFunction.FunctionType#DATE

A value parameter is not allowed.

DOCUMENT_MODIFY_BY

public static final BpelFunction DOCUMENT_MODIFY_BY

Maps the name of a user who last modified a document to a BPEL payload element.

Function Key: ModifyBy

Function Type: BpelFunction.FunctionType#TEXT

A value parameter is not allowed.

DOCUMENT_MODIFY_DATE

public static final BpelFunction DOCUMENT_MODIFY_DATE

Maps the date when a document was last modified to a BPEL payload element.

Function Key: ModifyDate

Function Type: BpelFunction.FunctionType#DATE

A value parameter is not allowed.

DOCUMENT_MIME_TYPE

public static final BpelFunction DOCUMENT_MIME_TYPE

Maps the MIME type of a document to a BPEL payload element.

Function Key: MimeType

Function Type: BpelFunction.FunctionType#TEXT

A value parameter is not allowed.

DOCUMENT_URL

public static final BpelFunction DOCUMENT_URL

Maps the URL to view a document to a BPEL payload element.

Function Key: DocUrl

Function Type: BpelFunction.FunctionType#URI

A value parameter is not allowed.

DOCUMENT_URL_ROOT

public static final BpelFunction DOCUMENT_URL_ROOT

Maps the URL to view a document to a BPEL payload element.

Function Key: DocUrlRoot

Function Type: BpelFunction.FunctionType#URI

A value parameter is not allowed.

DOCUMENT_SIZE

public static final BpelFunction DOCUMENT_SIZE

Maps the size of a document to a BPEL payload element.

Function Key: DocSize

Function Type: BpelFunction.FunctionType#NUMBER

A value parameter is not allowed.

DOCUMENT_STORAGE_VOLUME_DATE

public static final BpelFunction DOCUMENT_STORAGE_VOLUME_DATE

Maps the date used for storage stage actions related to a document to a BPEL payload element.

Function Key: StoragePolicyDate

Function Type: BpelFunction.FunctionType#DATE

A value parameter is not allowed.

DOCUMENT_STORAGE_VOLUME

public static final BpelFunction DOCUMENT_STORAGE_VOLUME

Maps the name of a volume where a document is stored to a BPEL payload element.

Function Key: StorageVolume

Function Type: BpelFunction.FunctionType#TEXT

A value parameter is not allowed.

APPLICATION_ID

public static final BpelFunction APPLICATION_ID

Maps the Id of an application to which a document belongs to a BPEL payload element.

Function Key: AppId

Function Type: BpelFunction.FunctionType#NUMBER

A value parameter is not allowed.

APPLICATION_NAME

public static final BpelFunction APPLICATION_NAME

Maps the name of an application to which a document belongs to a BPEL payload element.

Function Key: AppName

Function Type: BpelFunction.FunctionType#TEXT

A value parameter is not allowed.

BATCH_ID

public static final BpelFunction BATCH_ID

Maps the batch Id of a document to a BPEL payload element.

Function Key: BatchId

Function Type: BpelFunction.FunctionType#NUMBER

A value parameter is not allowed.

DOCUMENT_FIELDVALUE

public static final BpelFunction DOCUMENT_FIELDVALUE

Maps the value of a document application field to a BPEL payload element.

Function Key: FieldValue

Function Type: Varies

A value parameter is required.

The value parameter is the name of an application field.

VALUE_TRUE

public static final BpelFunction VALUE_TRUE

Maps the boolean value True to a BPEL payload element.

Function Key: True

Function Type: BpelFunction.FunctionType#BOOLEAN

A value parameter is not allowed.

VALUE_FALSE

public static final BpelFunction VALUE_FALSE

Maps the boolean value False to a BPEL payload element.

Function Key: False

Function Type: BpelFunction.FunctionType#BOOLEAN

A value parameter is not allowed.

FORMAT_VALUE

public static final BpelFunction FORMAT_VALUE

Maps a string containing formating codes to a BPEL payload element.

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=1
• Invoice [FieldValue:Invoice Number] - Invoice 4598220

A FormatValue function may not contain nested FormatValue functions.

POLICY_OVERRIDE

public static final BpelFunction POLICY_OVERRIDE

Maps a string value to a BPEL payload element.

Function Key: PolicyOverride

Function Type: BpelFunction.FunctionType#POLICY

A value parameter is required.

Field Detail

FUNC_PARAM_SEP

public static final java.lang.String FUNC_PARAM_SEP

See Also:

Constant Field Values

OPEN_DELIM

public static final char OPEN_DELIM

See Also:

Constant Field Values

CLOSE_DELIM

public static final char CLOSE_DELIM

See Also:

Constant Field Values

Method Detail

values

public static BpelFunction[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BpelFunction c : BpelFunction.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BpelFunction valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getMappedValue

public abstract java.lang.String getMappedValue(Document document,
                                                java.lang.String value,
                                                java.lang.String xmlType)
                                         throws ImagingException

Returns the mapped value for this BpelFunction.

Parameters:

document - a Document object from which to obtain document properties

value - a value required for some BpelFunctions

xmlType - the XML primative type

Returns:

a String representation of the value

Throws:

ImagingException

getKey

public java.lang.String getKey()

Gets the key for the BpelFunction.

Returns:

a String key

getLabel

public java.lang.String getLabel(java.util.Locale locale)

getType

public BpelFunction.FunctionType getType()

Gets the type for the BpelFunction.

Returns:

a FunctionType object

isValueRequired

public boolean isValueRequired()

Returns whether a value is required.

Returns:

true if a value is required; otherwise, false

getBpelFunction

public static BpelFunction getBpelFunction(java.lang.String function)

Skip navigation links