com.ibm.di.api.remote.impl
Class SequenceImpl

java.lang.Object
  java.rmi.server.RemoteObject
      java.rmi.server.RemoteServer
          java.rmi.server.UnicastRemoteObject
              com.ibm.di.api.remote.impl.APIRemoteObject
                  com.ibm.di.api.remote.impl.SequenceImpl

All Implemented Interfaces:

Sequence, java.io.Serializable, java.rmi.Remote

public class SequenceImpl
extends APIRemoteObject
implements Sequence

See Also:

Serialized Form

Field Summary

Fields inherited from class java.rmi.server.RemoteObject

ref

Method Summary

static SequenceImpl	createInstance(Sequence sequence, SessionImpl session)
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 Sequence.
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.

Methods inherited from class java.rmi.server.UnicastRemoteObject

clone, exportObject, exportObject, exportObject, unexportObject

Methods inherited from class java.rmi.server.RemoteServer

getClientHost, getLog, setLog

Methods inherited from class java.rmi.server.RemoteObject

equals, getRef, hashCode, toString, toStub

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

createInstance

public static SequenceImpl createInstance(Sequence sequence,
                                          SessionImpl session)
                                   throws DIException,
                                          java.rmi.RemoteException

Throws:

DIException

java.rmi.RemoteException

getConfigInstance

public ConfigInstance getConfigInstance()
                                 throws DIException,
                                        java.rmi.RemoteException

Description copied from interface: Sequence

Returns the configuration instance of the Sequence.

Specified by:

getConfigInstance in interface Sequence

Returns:

Returns ConfigInstance object

Throws:

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

java.rmi.RemoteException

getName

public java.lang.String getName()
                         throws DIException,
                                java.rmi.RemoteException

Description copied from interface: Sequence

Returns the name of the Sequence.

Specified by:

getName in interface Sequence

Returns:

String object representing the Sequence's name.

Throws:

DIException - if an error occurs while retrieving the name

java.rmi.RemoteException

getResult

public Entry getResult()
                throws DIException,
                       java.rmi.RemoteException

Description copied from interface: Sequence

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

Specified by:

getResult in interface Sequence

Returns:

The last "work" entry object.

Throws:

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

java.rmi.RemoteException

getStatistics

public TaskStatistics getStatistics()
                             throws DIException,
                                    java.rmi.RemoteException

Description copied from interface: Sequence

This method returns the TaskStatistics object for this Sequence.

Specified by:

getStatistics in interface Sequence

Returns:

The accumulated TaskStatistics object.

Throws:

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

java.rmi.RemoteException

getUniqueCode

public int getUniqueCode()
                  throws DIException,
                         java.rmi.RemoteException

Description copied from interface: Sequence

Returns the unique code of the Sequence.

Specified by:

getUniqueCode in interface Sequence

Returns:

int value representing the unique code of the Sequence.

Throws:

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

java.rmi.RemoteException

isActive

public boolean isActive()
                 throws DIException,
                        java.rmi.RemoteException

Description copied from interface: Sequence

Checks if the Sequence is active.

Specified by:

isActive in interface Sequence

Returns:

true if the Sequence thread is alive, false otherwise.

Throws:

DIException - if an error occurs while getting the state.

java.rmi.RemoteException

stop

public void stop()
          throws DIException,
                 java.rmi.RemoteException

Description copied from interface: Sequence

Stops the execution of the Sequence.

Specified by:

stop in interface Sequence

Throws:

DIException - if an error occurs while stopping the AssemblyLine.

java.rmi.RemoteException

stop

public void stop(boolean sync)
          throws DIException,
                 java.rmi.RemoteException

Description copied from interface: Sequence

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

Specified by:

stop in interface Sequence

Parameters:

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

Throws:

DIException - if an error occurs while stopping the Sequence.

java.rmi.RemoteException