com.ibm.di.api.remote
Interface AssemblyLineHandler

All Superinterfaces:
java.rmi.Remote
All Known Implementing Classes:
AssemblyLineHandlerImpl

public interface AssemblyLineHandler
extends java.rmi.Remote

This interface provides several methods to handle an AssemblyLine.


Method Summary
 void close()
          Closes the handler
 java.io.Serializable eval(java.lang.String script)
          Evaluates the passed in as parameter script in the context of this AssemblyLine.
 Entry executeCycle()
          Executes an AssemblyLine cycle with null work Entry attribute.
 Entry executeCycle(Entry aEntry)
          Executes an AssemblyLine cycle.
 Entry executeCycle(Entry aEntry, boolean aProcessTCB)
          Executes an AssemblyLine cycle.
 AssemblyLine getAssemblyLine()
          Returns an AssemblyLine instance.
 

Method Detail

getAssemblyLine

AssemblyLine getAssemblyLine()
                             throws DIException,
                                    java.rmi.RemoteException
Returns an AssemblyLine instance.

Returns:
this AssemblyLine.
Throws:
DIException - if an error occurs while retrieving the AssemblyLine.
java.rmi.RemoteException - if a communication-related exception occurs.

executeCycle

Entry executeCycle(Entry aEntry,
                   boolean aProcessTCB)
                   throws DIException,
                          java.rmi.RemoteException
Executes an AssemblyLine cycle. If an Entry is provided then it becomes the work entry.

Parameters:
aEntry - the work entry to use, or null to use an empty work entry/iterator entry.
aProcessTCB - if true, the AL's call/return attribute maps are applied to the provided entry and returned entry.
Returns:
the work entry at the end of the cycle.
Throws:
DIException - if an error occurs while executing the AssemblyLine.
java.rmi.RemoteException - if a communication-related exception occurs.

executeCycle

Entry executeCycle(Entry aEntry)
                   throws DIException,
                          java.rmi.RemoteException
Executes an AssemblyLine cycle. If an Entry is provided then it becomes the work entry.

Parameters:
aEntry - the work entry to use, or null to use an empty work entry/iterator entry.
Returns:
the work entry at the end of the cycle.
Throws:
DIException - if an error occurs while executing the AssemblyLine.
java.rmi.RemoteException - if a communication-related exception occurs.

executeCycle

Entry executeCycle()
                   throws DIException,
                          java.rmi.RemoteException
Executes an AssemblyLine cycle with null work Entry attribute.

Returns:
the work entry at the end of the cycle
Throws:
DIException - if an error occurs while executing the AssemblyLine.
java.rmi.RemoteException - if a communication-related exception occurs.

eval

java.io.Serializable eval(java.lang.String script)
                          throws DIException,
                                 java.rmi.RemoteException
Evaluates the passed in as parameter script in the context of this AssemblyLine. You can access all the script beans defined in the scope of this AssemblyLine.

Parameters:
script - the script to evaluate.
Returns:
the serializable object returned by the script or null if no return statement.
Throws:
DIException - if an error occurs while evaluating the script
java.rmi.RemoteException - if a communication-related exception occurs.
Since:
7.2

close

void close()
           throws DIException,
                  java.rmi.RemoteException
Closes the handler

Throws:
DIException - if an error occurs while executing the AssemblyLine.
java.rmi.RemoteException - if a communication-related exception occurs.