com.ibm.di.fc.idml
Class CloseIdMLFC

java.lang.Object
  com.ibm.di.fc.Function
      com.ibm.di.fc.idml.CloseIdMLFC

All Implemented Interfaces:

FunctionInterface, VersionInfoInterface

public class CloseIdMLFC
extends Function

This Function is used to close explicitly the used IdML book, if it is not closed already. Depending on the type of the closed book, it will return either its content, represented as a String (for in-memory IdMLs), or the full path of the IdML file (for books stored as files).

Field Summary

Fields inherited from class com.ibm.di.fc.Function

logger

Constructor Summary

CloseIdMLFC()

Method Summary

String	getVersion() Version information.
void	initialize(Object object) This method is/should be called once after the object has been given its configuration
Object	perform(Object obj) The FC updates the name of the used IdML book (if it has been modified), and a attempts to close the book.

Methods inherited from class com.ibm.di.fc.Function

debug, getConfiguration, getContext, getDebug, getLog, getParam, getRSInterface, getUI, initialize, logmsg, querySchema, setConfiguration, setContext, setDebug, setLog, setParam, setRSInterface, terminate, updateSchema, verifyInitialized

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CloseIdMLFC

public CloseIdMLFC()

Method Detail

initialize

public void initialize(Object object)
                throws Exception

This method is/should be called once after the object has been given its configuration

Specified by:

initialize in interface FunctionInterface

Overrides:

initialize in class Function

Parameters:

object - this object provides information to the Function Component needed on initialization

Throws:

Exception - An exception is thrown if the initialization fails.

perform

public Object perform(Object obj)
               throws Exception

The FC updates the name of the used IdML book (if it has been modified), and a attempts to close the book. If the book has already been closed or never opened a message is displayed.

Parameters:

obj - the work entry passed to the FC.

Returns:

an entry object, containing the IdMLConstants.BOOK_ATTR attribute.

Throws:

Exception - if a problem occurs.

getVersion

public String getVersion()

Version information.

Returns:

version information