|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.task.clientmodel.HTMConnection
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:
jndiName
(mandatory): JNDI name for the EJB module.remote
(optional): Setting defines whether the connection is supposed to be via 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 supposed to be
against the local nameserver
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT
(C) Copyright IBM Corporation 2005, 2006. |
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.String |
getRemote()
Get whether the connection is supposed to be via remote or local EJB interface. |
java.lang.Object |
retrieve(com.ibm.bpe.api.OID id)
Retrieve a TaskTemplate, Task or Escalation object by its identifier. |
java.lang.Object |
retrieve(com.ibm.task.api.TKIID id)
Deprecated. use retrieve(OID) |
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. |
void |
setRemote(java.lang.String booleanString)
Set whether the connection is supposed to be via remote or local EJB interface. |
Methods inherited from class java.lang.Object |
---|
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String COPYRIGHT
Constructor Detail |
public HTMConnection()
Method Detail |
public java.lang.String getProviderURL()
public void setProviderURL(java.lang.String url)
url
- , e.g. "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.Object retrieve(com.ibm.task.api.TKIID id) throws ClientException
retrieve(OID)
id
- TKIID
for the task
ClientException
public java.lang.Object retrieve(com.ibm.bpe.api.OID id) throws ClientException
id
- OID
for the object
ClientException
public void close()
protected void finalize() throws java.lang.Throwable
close()
method is called before
the object is disposed by the garbage collector.
java.lang.Throwable
Object.finalize()
public com.ibm.task.api.HumanTaskManagerService getHumanTaskManagerService() throws javax.naming.NamingException, javax.ejb.CreateException, java.rmi.RemoteException
javax.naming.NamingException
javax.ejb.CreateException
java.rmi.RemoteException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |