com.ibm.di.api.remote
Interface AssemblyLine

All Superinterfaces:

Remote

All Known Implementing Classes:

AssemblyLineImpl

public interface AssemblyLine
extends Remote

Represents an AssemblyLine instance.

Method Summary

AssemblyLineConfig	getConfig() Returns configuration information about the AssemblyLine.
ConfigInstance	getConfigInstance() Returns the configuration instance of the AssemblyLine.
String	getGlobalUniqueID() Returns AssemblyLine GUID.
String	getName() Returns the name of the AssemblyLine.
String	getNullBehavior() Gets the nullBehavior attribute of the AssemblyLine object
String	getNullBehaviorValue() Gets the nullBehaviorValue attribute of the AssemblyLine object.
Entry	getResult() This method returns the result entry object.
TaskStatistics	getStatistics() This method returns the TaskStatistics object for this AssemblyLine.
String	getSystemLog() Retrieves the current AssemblyLine's system log.
String	getSystemLogFileName() Returns the name of the log file of the AssemblyLine (not prefixed by folders path).
String	getSystemLogFilePath() Returns the fully-qualified path of the log file of the AssemblyLine.
String	getSystemLogLastChunk(int aLastKilobytes) Retrieves the last chunk from the current AssemblyLine's system log.
int	getUniqueCode() Returns the unique code of the AssemblyLine.
boolean	isActive() Checks if the AssemblyLine is active.
void	stop() Stops the execution of the AssemblyLine.

Method Detail

getConfigInstance

ConfigInstance getConfigInstance()
                                 throws DIException,
                                        RemoteException

Returns the configuration instance of the AssemblyLine.

Returns:

Returns ConfigInstance object representing the configuration instance of the AssemblyLine.

Throws:

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

RemoteException - if a communication-related exception occurs.

getName

String getName()
               throws DIException,
                      RemoteException

Returns the name of the AssemblyLine.

Returns:

String object representing the AssemblyLine’s name.

Throws:

DIException - if an error occurs while retrieving the name of the AssemblyLine.

RemoteException - if a communication-related exception occurs.

getUniqueCode

int getUniqueCode()
                  throws DIException,
                         RemoteException

Returns the unique code of the AssemblyLine.

Returns:

int value representing the unique code of the AssemblyLine.

Throws:

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

RemoteException - if a communication-related exception occurs.

getConfig

AssemblyLineConfig getConfig()
                             throws DIException,
                                    RemoteException

Returns configuration information about the AssemblyLine.

Returns:

AssemblyLineConfig representing the configuration information of the AssemblyLine.

Throws:

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

RemoteException - if a communication-related exception occurs.

getNullBehavior

String getNullBehavior()
                       throws DIException,
                              RemoteException

Gets the nullBehavior attribute of the AssemblyLine object

Returns:

String object representing the nullBehavior attribute value or null if no setting values are available for the AssemblyLine.

Throws:

DIException - if an error occurs while getting the nullBehavior attribute.

RemoteException - if a communication-related exception occurs.

getNullBehaviorValue

String getNullBehaviorValue()
                            throws DIException,
                                   RemoteException

Gets the nullBehaviorValue attribute of the AssemblyLine object.

Returns:

String object representing the nullBehaviorValue attribute value or null if no setting values are available for the AssemblyLine.

Throws:

DIException - if an error occurs while getting the nullBehaviorValue attribute.

RemoteException - if a communication-related exception occurs.

getStatistics

TaskStatistics getStatistics()
                             throws DIException,
                                    RemoteException

This method returns the TaskStatistics object for this AssemblyLine.

Returns:

The accumulated TaskStatistics object.

Throws:

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

RemoteException - if a communication-related exception occurs.

isActive

boolean isActive()
                 throws DIException,
                        RemoteException

Checks if the AssemblyLine is active.

Returns:

true if the AssemblyLine’s thread is alive, false otherwise.

Throws:

DIException - if an error occurs while getting the AssemblyLine state.

RemoteException - if a communication-related exception occurs.

getResult

Entry getResult()
                throws DIException,
                       RemoteException

This method returns the result entry object. This object is a copy of the working entry as it were when the AssemblyLine finished processing the connectors.

Returns:

The last "work" entry object.

Throws:

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

RemoteException - if a communication-related exception occurs.

stop

void stop()
          throws DIException,
                 RemoteException

Stops the execution of the AssemblyLine.

Throws:

DIException - if an error occurs while stopping the AssemblyLine.

RemoteException - if a communication-related exception occurs.

getSystemLogFilePath

String getSystemLogFilePath()
                            throws DIException,
                                   RemoteException

Returns the fully-qualified path of the log file of the AssemblyLine.

Returns:

the fully-qualified log file path.

Throws:

DIException - if an error occurs while obtaining AssemblyLine log file path.

RemoteException - if a communication-related exception occurs.

getSystemLogFileName

String getSystemLogFileName()
                            throws DIException,
                                   RemoteException

Returns the name of the log file of the AssemblyLine (not prefixed by folders path).

Returns:

the log file name.

Throws:

DIException - if an error occurs while obtaining AssemblyLine log file name.

RemoteException - if a communication-related exception occurs.

getSystemLog

String getSystemLog()
                    throws DIException,
                           RemoteException

Retrieves the current AssemblyLine's system log.

Returns:

the log generated by the AssemblyLine so far.

Throws:

DIException - if an error occurs while obtaining AssemblyLine's log.

RemoteException - if a communication-related exception occurs.

getSystemLogLastChunk

String getSystemLogLastChunk(int aLastKilobytes)
                             throws DIException,
                                    RemoteException

Retrieves the last chunk from the current AssemblyLine's system log.

Parameters:

aLastKilobytes - specifies in kilobytes the size of the log's last chunk that will be read.

Returns:

the last chunk of the AssemblyLine's log, generated so far.

Throws:

DIException - if an error occurs while obtaining AssemblyLine's log.

RemoteException - if a communication-related exception occurs.

getGlobalUniqueID

String getGlobalUniqueID()
                         throws DIException,
                                RemoteException

Returns AssemblyLine GUID. The GUID is a string value that is unique for each component ever created by a particular TDI Server.

Returns:

The AssemblyLine GUID value.

Throws:

DIException - if an error occurs while obtaining the AssemblyLine GUID value.

RemoteException - if a communication-related exception occurs.