com.ibm.di.api.remote
Interface AssemblyLineHandler

All Superinterfaces:

Remote

All Known Implementing Classes:

AssemblyLineHandlerImpl

public interface AssemblyLineHandler
extends Remote

This interface provides several methods to handle an AssemblyLine.

Method Summary

void	close() Closes the handler
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,
                                    RemoteException

Returns an AssemblyLine instance.

Returns:

this AssemblyLine.

Throws:

DIException - if an error occurs while retrieving the AssemblyLine.

RemoteException - if a communication-related exception occurs.

executeCycle

Entry executeCycle(Entry aEntry,
                   boolean aProcessTCB)
                   throws DIException,
                          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.

RemoteException - if a communication-related exception occurs.

executeCycle

Entry executeCycle(Entry aEntry)
                   throws DIException,
                          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.

RemoteException - if a communication-related exception occurs.

executeCycle

Entry executeCycle()
                   throws DIException,
                          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.

RemoteException - if a communication-related exception occurs.

close

void close()
           throws DIException,
                  RemoteException

Closes the handler

Throws:

DIException - if an error occurs while executing the AssemblyLine.

RemoteException - if a communication-related exception occurs.