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:
jndiName
(mandatory): JNDI name for the EJB module.remote
(optional): Defines whether the connection is made through a remote or local EJB interface.
'TRUE' and 'FALSE' are valid values. Default is 'FALSE'.providerURL
(optional): This parameter is used if the JNDI lookup for the EJB is not to be made
against the local nameserverobserver
(optional): Deprecated - The reporting feature is no longer supported.
This value is ignored and always 'FALSE'.HTMConnection
can be used as context for a Command
.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT
(C) Copyright IBM Corporation 2005, 2012.
|
Constructor and Description |
---|
HTMConnection()
Creates a new connection to the HumanTaskManagerService.
|
Modifier and Type | Method and Description |
---|---|
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()
Deprecated.
As of version 8.0.1, the reporting feature is no longer supported. This method always returns false.
|
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)
Deprecated.
As of version 8.0.1, the reporting feature is no longer supported. This value is ignored.
|
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.
|
public static final java.lang.String COPYRIGHT
public HTMConnection()
public java.lang.String getProviderURL()
public void setProviderURL(java.lang.String url)
url
- for example, "iiop://localhost"public java.lang.String getJndiName()
public void setJndiName(java.lang.String newName)
newName
- The new JNDI lookup namepublic void setRemote(java.lang.String booleanString)
booleanString
- 'TRUE' and 'FALSE' are valid values.public java.lang.String getRemote()
public java.lang.Boolean getObserver()
public void setObserver(java.lang.Boolean booleanValue)
booleanValue
- 'TRUE' and 'FALSE' are valid values.public java.lang.Object retrieve(TKIID id) throws ClientException
retrieve(OID)
id
- TKIID
for the taskClientException
public java.lang.Object retrieve(OID id) throws ClientException
id
- OID
for the objectClientException
public void close()
protected void finalize() throws java.lang.Throwable
close()
method is called before
the object is disposed of by the garbage collector.finalize
in class java.lang.Object
java.lang.Throwable
Object.finalize()
public HumanTaskManagerService getHumanTaskManagerService() throws javax.naming.NamingException, javax.ejb.CreateException, java.rmi.RemoteException
javax.naming.NamingException
javax.ejb.CreateException
java.rmi.RemoteException