com.ibm.task.clientmodel
Class HTMConnection

java.lang.Object
  extended bycom.ibm.task.clientmodel.HTMConnection

public class HTMConnection
extends java.lang.Object

Provides access to the HumanTaskManagerService API. The Human Task Manager API is rendered through an EJB. Use HTMConnection to initialize and configure references to the EJB.

To configure the connection use the following parameters:


Field Summary
static java.lang.String COPYRIGHT
          (C) Copyright IBM Corporation 2005.
 
Constructor Summary
HTMConnection()
          Create a new connection to the HumanTaskManagerService.
 
Method Summary
 void close()
          Closes the connection to the process engine
protected  void finalize()
          Makes sure that the close() method is called before the object is disposed by the garbage collector.
 com.ibm.task.api.HumanTaskManagerService getHumanTaskManagerService()
          Retrieve the HumanTaskManagerService bean.
 java.lang.String getJndiName()
          Get the JNDI name for the Human Task Manager API EJB.
 java.lang.String getProviderURL()
          Get the URL to the service provider for the Human Task Manager API EJBs.
 java.lang.Object retrieve(com.ibm.task.api.TKIID id)
          Retrieve a task by its identifier
 void setJndiName(java.lang.String newName)
          Set the JNDI name for the Human Task Manager API EJB.
 void setProviderURL(java.lang.String url)
          Set the URL to the service provider of the Human Task Manager API EJBs.
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
(C) Copyright IBM Corporation 2005.

See Also:
Constant Field Values
Constructor Detail

HTMConnection

public HTMConnection()
Create a new connection to the HumanTaskManagerService.

Method Detail

getProviderURL

public java.lang.String getProviderURL()
Get the URL to the service provider for the Human Task Manager API EJBs.

Returns:
an URL

setProviderURL

public void setProviderURL(java.lang.String url)
Set the URL to the service provider of the Human Task Manager API EJBs.

Parameters:
url - , e.g. "iiop://localhost"

getJndiName

public java.lang.String getJndiName()
Get the JNDI name for the Human Task Manager API EJB.

Returns:
the JNDI lookup name

setJndiName

public void setJndiName(java.lang.String newName)
Set the JNDI name for the Human Task Manager API EJB.

Parameters:
newName - The new JNDI lookup name

retrieve

public java.lang.Object retrieve(com.ibm.task.api.TKIID id)
                          throws ClientException
Retrieve a task by its identifier

Parameters:
id - TKIID for the task
Returns:
the task object defined by the TKIID
Throws:
ClientException

close

public void close()
Closes the connection to the process engine


finalize

protected void finalize()
                 throws java.lang.Throwable
Makes sure that the close() method is called before the object is disposed by the garbage collector.

Throws:
java.lang.Throwable
See Also:
Object.finalize()

getHumanTaskManagerService

public com.ibm.task.api.HumanTaskManagerService getHumanTaskManagerService()
                                                                    throws javax.naming.NamingException,
                                                                           javax.ejb.CreateException,
                                                                           java.rmi.RemoteException
Retrieve the HumanTaskManagerService bean.

Returns:
the HumanTaskManagerService bean.
Throws:
javax.naming.NamingException
javax.ejb.CreateException
java.rmi.RemoteException