com.ibm.di.api.local
Interface Sequence

All Known Implementing Classes:

SequenceImpl

public interface Sequence

Represents a running Sequence of AssemblyLines

Since:

7.2

Method Summary

ConfigInstance	getConfigInstance() Returns the configuration instance of the Sequence.
java.lang.String	getName() Returns the name of the Sequence.
Entry	getResult() This method returns the result entry object.
TaskStatistics	getStatistics() This method returns the TaskStatistics object for this Sequence.
int	getUniqueCode() Returns the unique code of the AssemblyLine.
boolean	isActive() Checks if the Sequence is active.
void	stop() Stops the execution of the Sequence.
void	stop(boolean sync) Stops the execution of the Sequence, and waits for it to stop.

Method Detail

getConfigInstance

ConfigInstance getConfigInstance()
                                 throws DIException

Returns the configuration instance of the Sequence.

Returns:

Returns ConfigInstance object

Throws:

DIException - if an error occurs while retrieving the configuration instance information.

getName

java.lang.String getName()
                         throws DIException

Returns the name of the Sequence.

Returns:

String object representing the Sequence's name.

Throws:

DIException - if an error occurs while retrieving the name

getUniqueCode

int getUniqueCode()
                  throws DIException

Returns the unique code of the AssemblyLine.

Returns:

int value representing the unique code of the Sequence.

Throws:

DIException - if an error occurs while retrieving the unique code.

getStatistics

TaskStatistics getStatistics()
                             throws DIException

This method returns the TaskStatistics object for this Sequence.

Returns:

The accumulated TaskStatistics object.

Throws:

DIException - if an error occurs while getting the Sequence statistics.

isActive

boolean isActive()
                 throws DIException

Checks if the Sequence is active.

Returns:

true if the Sequence thread is alive, false otherwise.

Throws:

DIException - if an error occurs while getting the state.

getResult

Entry getResult()
                throws DIException

This method returns the result entry object. This object is a copy of the working entry.

Returns:

The last "work" entry object.

Throws:

DIException - if an error occurs while getting the result Entry.

stop

void stop()
          throws DIException

Stops the execution of the Sequence.

Throws:

DIException - if an error occurs while stopping the AssemblyLine.

stop

void stop(boolean sync)
          throws DIException

Stops the execution of the Sequence, and waits for it to stop.

Parameters:

sync - If true, create a new Thread to do the waiting.

Throws:

DIException - if an error occurs while stopping the Sequence.