IBM Information Integrator for Content V8.2 APIs

com.ibm.mm.sdk.common
Interface DKIKFService

All Superinterfaces:
dkService
All Known Implementing Classes:
DKIKFServiceFed, DKIKFServiceFed, DKIKFServiceFed

public interface DKIKFService
extends dkService

A DKIKFService provides the access to the information mining functions. Depending on which type of application you want, you can create a service object using one of the following implementations:


Method Summary
 void connect(java.lang.String service_name, java.lang.String user_name, java.lang.String authentication, java.lang.String connect_string)
          Connects to the named service with user name, authentication, and connect string information.
 void disconnect()
          Disconnects from the service.
 DKIKFLibrary getLibrary()
          Returns a library object for this service.
 DKIKFServerTask getServerTask()
          Returns the currently registered server task object of this service.
 boolean isConnected()
          Returns the status of connecting to the service.
 java.io.Serializable runServerTask(java.io.Serializable argument)
          Starts the server task by calling its runServerTask method in the server context.
 void setServerTask(DKIKFServerTask serverTask)
          Registers the specified server task object in the server runtime.
 
Methods inherited from interface com.ibm.mm.sdk.common.dkService
addExtension, connection, destroy, getExtension, listExtensionNames, removeExtension, serviceCategory, serviceId, serviceName, serviceType, setServiceName, setUserName, userName
 

Method Detail

connect

public void connect(java.lang.String service_name,
                    java.lang.String user_name,
                    java.lang.String authentication,
                    java.lang.String connect_string)
             throws DKException,
                    java.lang.Exception
Connects to the named service with user name, authentication, and connect string information.
Specified by:
connect in interface dkService
Parameters:
service_name - name of the service.
user_name - user name.
authentication - authentification of the user.
connect_string - optional connection string.

disconnect

public void disconnect()
                throws DKException,
                       java.lang.Exception
Disconnects from the service.
Specified by:
disconnect in interface dkService

isConnected

public boolean isConnected()
                    throws java.lang.Exception
Returns the status of connecting to the service.
Specified by:
isConnected in interface dkService
Returns:
boolean value indicating the connection status.

getLibrary

public DKIKFLibrary getLibrary()
Returns a library object for this service.
Returns:
the library object

setServerTask

public void setServerTask(DKIKFServerTask serverTask)
Registers the specified server task object in the server runtime. If your are using a client service, a copy of the server task is send to the server. Each service object can hold one server task.
Parameters:
serverTask - a server task
See Also:
getServerTask(), runServerTask(Serializable)

getServerTask

public DKIKFServerTask getServerTask()
Returns the currently registered server task object of this service.
Returns:
the server task object or null if not set
See Also:
setServerTask(DKIKFServerTask), runServerTask(Serializable)

runServerTask

public java.io.Serializable runServerTask(java.io.Serializable argument)
                                   throws DKIKFServerTaskNotSetException,
                                          DKIKFServerTaskException
Starts the server task by calling its runServerTask method in the server context.
Parameters:
argument - the server task arguments
Returns:
the server task result
See Also:
setServerTask(DKIKFServerTask), getServerTask()

IBM Information Integrator for Content V8.2 APIs

© Copyright International Business Machines Corporation 1996, 2003 IBM Corp. All rights reserved.