IBM Information Integrator for Content V8.2 APIs

com.ibm.mm.sdk.client
Class DKIKFServiceFed

java.lang.Object
  |
  +--com.ibm.mm.sdk.client.dkClientService
        |
        +--com.ibm.mm.sdk.client.dkAbstractService
              |
              +--com.ibm.mm.sdk.client.DKIKFServiceFed
All Implemented Interfaces:
com.ibm.mm.sdk.common.DKConstant, DKIKFService, com.ibm.mm.sdk.common.DKMessageId, dkService, java.rmi.Remote

public abstract class DKIKFServiceFed
extends dkAbstractService
implements DKIKFService

This is the client implementation of the information mining service.


Constructor Summary
DKIKFServiceFed()
          Use create() to get a service instance.
 
Method Summary
static DKIKFServiceFed create()
          Creates a new service object.
abstract  DKIKFLibrary getLibrary()
          Returns a library object for this service.
abstract  DKIKFServerTask getServerTask()
          Returns the currently registered server task object of this service.
abstract  java.io.Serializable runServerTask(java.io.Serializable argument)
          Starts the server task by calling its runServerTask method in the server context.
abstract  void setServerTask(DKIKFServerTask serverTask)
          Registers the specified server task object in the server runtime.
 
Methods inherited from class com.ibm.mm.sdk.client.dkAbstractService
addExtension, connect, connection, destroy, disconnect, getExtension, isConnected, listExtensionNames, removeExtension, serviceCategory, serviceId, serviceName, serviceType, setServiceName, setUserName, userName
 
Methods inherited from class com.ibm.mm.sdk.client.dkClientService
getDatastore, setDatastore
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.mm.sdk.common.DKIKFService
connect, disconnect, isConnected
 
Methods inherited from interface com.ibm.mm.sdk.common.dkService
addExtension, connection, destroy, getExtension, listExtensionNames, removeExtension, serviceCategory, serviceId, serviceName, serviceType, setServiceName, setUserName, userName
 

Constructor Detail

DKIKFServiceFed

public DKIKFServiceFed()
                throws DKException,
                       java.lang.Exception
Use create() to get a service instance.
Method Detail

create

public static DKIKFServiceFed create()
                              throws DKException,
                                     java.rmi.RemoteException,
                                     java.lang.Exception
Creates a new service object. In order to use the API you first have to connect.

getLibrary

public abstract DKIKFLibrary getLibrary()
Description copied from interface: DKIKFService
Returns a library object for this service.
Specified by:
getLibrary in interface DKIKFService
Following copied from interface: com.ibm.mm.sdk.common.DKIKFService
Returns:
the library object

setServerTask

public abstract void setServerTask(DKIKFServerTask serverTask)
Description copied from interface: DKIKFService
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.
Specified by:
setServerTask in interface DKIKFService
Following copied from interface: com.ibm.mm.sdk.common.DKIKFService
Parameters:
serverTask - a server task
See Also:
DKIKFService.getServerTask(), DKIKFService.runServerTask(Serializable)

getServerTask

public abstract DKIKFServerTask getServerTask()
Description copied from interface: DKIKFService
Returns the currently registered server task object of this service.
Specified by:
getServerTask in interface DKIKFService
Following copied from interface: com.ibm.mm.sdk.common.DKIKFService
Returns:
the server task object or null if not set
See Also:
DKIKFService.setServerTask(DKIKFServerTask), DKIKFService.runServerTask(Serializable)

runServerTask

public abstract java.io.Serializable runServerTask(java.io.Serializable argument)
                                            throws DKIKFServerTaskNotSetException,
                                                   DKIKFServerTaskException
Description copied from interface: DKIKFService
Starts the server task by calling its runServerTask method in the server context.
Specified by:
runServerTask in interface DKIKFService
Following copied from interface: com.ibm.mm.sdk.common.DKIKFService
Parameters:
argument - the server task arguments
Returns:
the server task result
See Also:
DKIKFService.setServerTask(DKIKFServerTask), DKIKFService.getServerTask()

IBM Information Integrator for Content V8.2 APIs

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