com.ibm.task.clientmodel
Class HTMConnection

java.lang.Object
  extended by com.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.

Use the following parameters to configure the connection:

For example, the HTMConnection can be used as context for a Command.


Field Summary
static java.lang.String COPYRIGHT
          (C) Copyright IBM Corporation 2005, 2009.
 
Constructor Summary
HTMConnection()
          Creates a new connection to the HumanTaskManagerService.
 
Method Summary
 void close()
          Closes the connection to the process engine.
protected  void finalize()
          Ensures that the close() method is called before the object is disposed of by the garbage collector.
 HumanTaskManagerService getHumanTaskManagerService()
          Retrieves the HumanTaskManagerService bean.
 java.lang.String getJndiName()
          Gets the JNDI name for the Human Task Manager API EJB.
 java.lang.Boolean getObserver()
          Gets whether the observer EJB is configured within BPCExplorer.
 java.lang.String getProviderURL()
          Gets the URL to the service provider for the Human Task Manager API EJBs.
 java.lang.String getRemote()
          Gets whether the connection is to be made through a remote or local EJB interface.
 java.lang.Object retrieve(OID id)
          Retrieve a TaskTemplate, Task or Escalation object using its identifier.
 java.lang.Object retrieve(TKIID id)
          Deprecated. use retrieve(OID)
 void setJndiName(java.lang.String newName)
          Sets the JNDI name for the Human Task Manager API EJB.
 void setObserver(java.lang.Boolean booleanValue)
          Sets whether the observer EJB is configured within BPCExplorer.
 void setProviderURL(java.lang.String url)
          Sets the URL to the service provider of the Human Task Manager API EJBs.
 void setRemote(java.lang.String booleanString)
          Sets whether the connection is to be made through a remote or local EJB interface.
 
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, 2009.

See Also:
Constant Field Values
Constructor Detail

HTMConnection

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

Method Detail

getProviderURL

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

Returns:
an URL

setProviderURL

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

Parameters:
url - for example, "iiop://localhost"

getJndiName

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

Returns:
the JNDI lookup name

setJndiName

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

Parameters:
newName - The new JNDI lookup name

setRemote

public void setRemote(java.lang.String booleanString)
Sets whether the connection is to be made through a remote or local EJB interface.

Parameters:
booleanString - 'TRUE' and 'FALSE' are valid values.

getRemote

public java.lang.String getRemote()
Gets whether the connection is to be made through a remote or local EJB interface.

Returns:
'TRUE' or 'FALSE'.

getObserver

public java.lang.Boolean getObserver()
Gets whether the observer EJB is configured within BPCExplorer.

Returns:
'TRUE' or 'FALSE'.

setObserver

public void setObserver(java.lang.Boolean booleanValue)
Sets whether the observer EJB is configured within BPCExplorer.

Parameters:
booleanValue - 'TRUE' and 'FALSE' are valid values.

retrieve

public java.lang.Object retrieve(TKIID id)
                          throws ClientException
Deprecated. use retrieve(OID)

Retrieve a task using its identifier

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

retrieve

public java.lang.Object retrieve(OID id)
                          throws ClientException
Retrieve a TaskTemplate, Task or Escalation object using its identifier.

Parameters:
id - OID for the object
Returns:
the application object
Throws:
ClientException

close

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


finalize

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

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

getHumanTaskManagerService

public HumanTaskManagerService getHumanTaskManagerService()
                                                   throws javax.naming.NamingException,
                                                          javax.ejb.CreateException,
                                                          java.rmi.RemoteException
Retrieves the HumanTaskManagerService bean.

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