Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Interface dkService

All Known Subinterfaces:
dkIKFServiceFed, dkWorkFlowServiceFed
All Known Implementing Classes:
DKDocRoutingServiceICM, dkAbstractService

public interface dkService

This class defines methods of service with basic methods


Method Summary
 void addExtension(java.lang.String extensionName, dkExtension extensionObj)
          Adds a new extension object.
 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.
 DKHandle connection()
          Returns the connection handle of the service.
 void destroy()
          service destroy - service cleanup if needed
 void disconnect()
          Disconnects from the service.
 dkExtension getExtension(java.lang.String extensionName)
          Gets the extension object from a given extenstion name.
 boolean isConnected()
          Returns the status of connecting to the service.
 java.lang.String[] listExtensionNames()
          Gets the list of extension objects' names
 void removeExtension(java.lang.String extensionName)
          Remove an existing extension object
 java.lang.String serviceCategory()
          Returns the category of the service.
 java.lang.String serviceId()
          Returns the id of the service.
 java.lang.String serviceName()
          Returns the name of the service.
 java.lang.String serviceType()
          Returns the type of the service.
 void setServiceName(java.lang.String service_name)
          Sets the name of the service.
 void setUserName(java.lang.String user_name)
          Sets the name of the user.
 java.lang.String userName()
          Returns the user name.
 

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.
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.

serviceName

public java.lang.String serviceName()
                             throws java.lang.Exception
Returns the name of the service.
Returns:
service name.

serviceType

public java.lang.String serviceType()
                             throws java.lang.Exception
Returns the type of the service.
Returns:
service type.

serviceId

public java.lang.String serviceId()
                           throws java.lang.Exception
Returns the id of the service.
Returns:
service id.

serviceCategory

public java.lang.String serviceCategory()
                                 throws java.lang.Exception
Returns the category of the service.
Returns:
service category.

userName

public java.lang.String userName()
                          throws java.lang.Exception
Returns the user name.
Returns:
user name.

connection

public DKHandle connection()
                    throws java.lang.Exception
Returns the connection handle of the service.
Returns:
DKHandle object.

isConnected

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

setServiceName

public void setServiceName(java.lang.String service_name)
                    throws java.lang.Exception
Sets the name of the service.
Parameters:
service_name - name of the service.

setUserName

public void setUserName(java.lang.String user_name)
                 throws java.lang.Exception
Sets the name of the user.
Parameters:
user_name - user name.

getExtension

public dkExtension getExtension(java.lang.String extensionName)
                         throws DKException,
                                java.lang.Exception
Gets the extension object from a given extenstion name.
Parameters:
extensionName - name of the extension object.
Returns:
extension object.

addExtension

public void addExtension(java.lang.String extensionName,
                         dkExtension extensionObj)
                  throws DKException,
                         java.lang.Exception
Adds a new extension object.
Parameters:
extensionName - name of new extension object
extensionObj - the extension object to be set

removeExtension

public void removeExtension(java.lang.String extensionName)
                     throws DKException,
                            java.lang.Exception
Remove an existing extension object
Parameters:
extensionName - name of extension object to be removed

listExtensionNames

public java.lang.String[] listExtensionNames()
                                      throws DKException,
                                             java.lang.Exception
Gets the list of extension objects' names
Returns:
an array of extension objects' names

destroy

public void destroy()
             throws DKException,
                    java.lang.Exception
service destroy - service cleanup if needed

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.