Skip navigation links

oracle.adf.controller
Interface TaskFlowTrainModel

public interface TaskFlowTrainModel

Logical model of a task flow's train model.

Note: this model is only valid after the task flow has been completely initialized and until the task flow reaches a return activity. Outside of that window any access to this model will produce undefined results.

Method Summary

TaskFlowTrainStopModel	getCurrentStop()
TaskFlowTrainStopModel	getNextStop(TaskFlowTrainStopModel stop) Returns the next train stop after the specified stop.
TaskFlowTrainStopModel	getPreviousStop(TaskFlowTrainStopModel stop) Returns the previous train stop before the specified stop.

Method Detail

getCurrentStop

TaskFlowTrainStopModel getCurrentStop()
                                      throws java.lang.IllegalStateException

Returns:

the current train stop.

Throws:

java.lang.IllegalStateException - if called before the task flow has been initialized or after it has completed.

getNextStop

TaskFlowTrainStopModel getNextStop(TaskFlowTrainStopModel stop)
                                   throws java.lang.IllegalStateException

Returns the next train stop after the specified stop. The returned stop is the next stop defined in the train's metadata, which may not be the next stop the user will navigate to if the next stop is disabled or ignored.

Parameters:

stop - the specified stop.

Returns:

the stop following the specified stop or null if there isn't a next stop.

Throws:

java.lang.IllegalStateException - if called before the task flow has been initialized or after it has completed.

getPreviousStop

TaskFlowTrainStopModel getPreviousStop(TaskFlowTrainStopModel stop)
                                       throws java.lang.IllegalStateException

Returns the previous train stop before the specified stop. The returned stop is the previous stop defined in the train's metadata, which may not be the previous stop the user will navigate to if the previous stop is disabled or ignored.

Parameters:

stop - the specified stop.

Returns:

the stop before the specified stop or null if there isn't a previous stop.

Throws:

java.lang.IllegalStateException - if called before the task flow has been initialized or after it has completed.

Skip navigation links