oracle.adf.controller.metadata.binding
Interface TaskFlowBinding

public interface TaskFlowBinding

Interface to access taskFlow binding element for DT@RT.

Field Summary

static oracle.adfdt.model.binding.BindingInfo

BINDING_INFO Return the BindingInfo for a TaskFlow binding.

Method Summary

void	addInputParameter(java.lang.String id, java.lang.String value) Adds a parameter to the taskflow binding definition.
void	clearInputParameters() Removes all parameters of the taskflow binding.
TaskFlowBindingParameter	findInputParameter(java.lang.String id) Given the id of the parameter, this method returns the corresponding input parameter, if not found returns null.
java.lang.String	getActivation() Getter for the activation property.
java.lang.String	getActive() Getter for the active property.
java.util.List<TaskFlowBindingParameter>	getInputParameters() Returns list of parameters.
java.lang.String	getInputParametersMap() Getter for the parametersMap property.
java.lang.String	getRefreshExpression() Getter for the RefreshExpression attribute
int	getRefreshFlag() Getter for the Refresh attribute
java.lang.String	getTaskFlowId() Getter for the taskFlowId property.
TaskFlowId	getTaskFlowIdAsObject() Get task flow id as an object, if EL evaluation is possible.
void	removeInputParameter(java.lang.String parameterId) This method locates the parameter with the given id and removes it.
void	removeInputParameter(TaskFlowBindingParameter parameter) This method removes the given TaskFlowBindingParameter.
void	setActivation(java.lang.String activation) Setter for the activation property.
void	setActive(java.lang.String active) Setter for the active property.
void	setInputParametersMap(java.lang.String expression) Setter for the parametersMap property.
void	setRefreshExpression(java.lang.String exp) Setter for the RefreshExpression attribute
void	setRefreshFlag(int flag) Setter for the Refresh attribute
void	setTaskFlowId(java.lang.String localTaskFlowId) Setter for the taskFlowId property.

Field Detail

BINDING_INFO

static final oracle.adfdt.model.binding.BindingInfo BINDING_INFO

Return the BindingInfo for a TaskFlow binding. This is used to create a personalization object.

Method Detail

getTaskFlowId

java.lang.String getTaskFlowId()

Getter for the taskFlowId property. Since the attribute can be an EL and that the literal EL syntax is synonymous to the non-el syntax, this method always return the non-el syntax when the EL is a literal. So in case the value is ${'regionDocument#regionId'}, it will return regionDocument#regionId

Returns:

the taskFlowId value

setTaskFlowId

void setTaskFlowId(java.lang.String localTaskFlowId)

Setter for the taskFlowId property.

Parameters:

localTaskFlowId - the taskFlowId value

getTaskFlowIdAsObject

TaskFlowId getTaskFlowIdAsObject()

Get task flow id as an object, if EL evaluation is possible. If not, return null.

Returns:

task flow id.

getRefreshFlag

int getRefreshFlag()

Getter for the Refresh attribute

Returns:

setRefreshFlag

void setRefreshFlag(int flag)

Setter for the Refresh attribute

Parameters:

flag -

getRefreshExpression

java.lang.String getRefreshExpression()

Getter for the RefreshExpression attribute

Returns:

setRefreshExpression

void setRefreshExpression(java.lang.String exp)

Setter for the RefreshExpression attribute

Parameters:

exp -

getInputParametersMap

java.lang.String getInputParametersMap()

Getter for the parametersMap property.

Returns:

the El expression to the parameters map.

setInputParametersMap

void setInputParametersMap(java.lang.String expression)

Setter for the parametersMap property.

Parameters:

expression - the EL expression to the parameters map

getActivation

java.lang.String getActivation()

Getter for the activation property.

Returns:

the activation value.

setActivation

void setActivation(java.lang.String activation)

Setter for the activation property.

Parameters:

activation - the activation value.

getActive

java.lang.String getActive()

Getter for the active property.

Returns:

the active value.

setActive

void setActive(java.lang.String active)

Setter for the active property.

Parameters:

active - the active value.

addInputParameter

void addInputParameter(java.lang.String id,
                       java.lang.String value)

Adds a parameter to the taskflow binding definition. The parameter id and value are passed in.

Parameters:

id - the name of the parameter

value - the value of the parameter

removeInputParameter

void removeInputParameter(TaskFlowBindingParameter parameter)

This method removes the given TaskFlowBindingParameter.

Parameters:

parameter - the TaskFlowBindingParameter to remove

removeInputParameter

void removeInputParameter(java.lang.String parameterId)

This method locates the parameter with the given id and removes it.

Parameters:

parameterId -

clearInputParameters

void clearInputParameters()

Removes all parameters of the taskflow binding.

findInputParameter

TaskFlowBindingParameter findInputParameter(java.lang.String id)

Given the id of the parameter, this method returns the corresponding input parameter, if not found returns null.

Parameters:

id - of the parameter to find

Returns:

the TaskFlowBindingParameter object with this id

getInputParameters

java.util.List<TaskFlowBindingParameter> getInputParameters()

Returns list of parameters.

Returns:

the list of parameters