com.adobe.livecycle.ibmfilenetprocessengineconnector.client.type
Interface IStepParameterDefinition

public interface IStepParameterDefinition

This class represents information about parameters associated with an IBM FileNet Workflow step. This information includes name, description, dataType, modeType, and isArray flag.

The following dataTypes are supported:

• ATTACHMENT("attachment")
• BOOLEAN("boolean")
• FLOAT("double")
• INTEGER("int")
• PARTICIPANT("participant")
• STRING("string")
• TIME("date"), XML("xml")

The following mode types are supported:

• IN("input")
• OUT("output")
• IN_OUT("input_output")

Since:

10 September 2007

Nested Class Summary

static class	IStepParameterDefinition.DataType Data Types for the step parameter value.
static class	IStepParameterDefinition.ModeType Modes for the step parameter.

Method Summary

IStepParameterDefinition.DataType	getDataType() Retrieves the data type of the parameter.
java.lang.String	getDescription() Retrieves the description text of the parameter.
IStepParameterDefinition.ModeType	getModeType() Retrieves the mode of the parameter.
java.lang.String	getName() Retrieves the name of the parameter.
boolean	isArray() Retrieves whether the parameter is an array of values.
void	setDataType(IStepParameterDefinition.DataType aDataType) Sets the data type of the parameter.
void	setDescription(java.lang.String aDescription) Sets the description text for the parameter.
void	setIsArray(boolean isArray) Sets whether the parameter is an array of values.
void	setModeType(IStepParameterDefinition.ModeType aModeType) Sets the mode of the parameter.
void	setName(java.lang.String aName) Sets the name of the parameter.

Method Detail

setName

void setName(java.lang.String aName)

Sets the name of the parameter.

getName

java.lang.String getName()

Retrieves the name of the parameter.

setDescription

void setDescription(java.lang.String aDescription)

Sets the description text for the parameter.

getDescription

java.lang.String getDescription()

Retrieves the description text of the parameter.

setDataType

void setDataType(IStepParameterDefinition.DataType aDataType)

Sets the data type of the parameter.

getDataType

IStepParameterDefinition.DataType getDataType()

Retrieves the data type of the parameter.

setIsArray

void setIsArray(boolean isArray)

Sets whether the parameter is an array of values.

isArray

boolean isArray()

Retrieves whether the parameter is an array of values.

setModeType

void setModeType(IStepParameterDefinition.ModeType aModeType)

Sets the mode of the parameter.

getModeType

IStepParameterDefinition.ModeType getModeType()

Retrieves the mode of the parameter.