Package com.ibm.di.api.jmx.mbeans

Interface AssemblyLineHandlerMBean

All Superinterfaces:

BaseAdminMBean, BaseMBean

All Known Implementing Classes:

AssemblyLineHandler

public interface AssemblyLineHandlerMBean
extends BaseAdminMBean

This interface provides several methods to handle an AssemblyLine.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the Assembly LineHandler MBean.
Entry	executeCycle()	Executes an AssemblyLine cycle with null work Entry attribute.
Entry	executeCycle(Entry aEntry)	Executes an AssemblyLine cycle.
Entry	executeCycle(Entry aEntry, java.lang.Boolean aProcessTCB)	Executes an AssemblyLine cycle.
javax.management.ObjectName	getAssemblyLine()	Returns an ObjectName generated from the AssemblyLine's name and AssemblyLine's unique code.

Methods inherited from interface com.ibm.di.api.jmx.mbeans.BaseMBean

getId, getType

Method Detail

getAssemblyLine

javax.management.ObjectName getAssemblyLine()
                                     throws DIException

Returns an ObjectName generated from the AssemblyLine's name and AssemblyLine's unique code.

Returns:

the ObjectName of the AssemblyLine.

Throws:

DIException - if an error occurs while getting the AssemblyLine's ObjectName.

executeCycle

Entry executeCycle(Entry aEntry,
                   java.lang.Boolean aProcessTCB)
            throws DIException

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.

executeCycle

Entry executeCycle(Entry aEntry)
            throws DIException

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.

executeCycle

Entry executeCycle()
            throws DIException

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.

close

void close()
    throws DIException

Closes the Assembly LineHandler MBean.

Throws:

DIException - if error occurs while closing the MBean.