com.ibm.task.clientmodel
Class HTMConnection
- java.lang.Object
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:
-
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 nameserver -
observer
(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
.
Field Summary
Modifier and Type | Field and Description |
---|---|
|
COPYRIGHT
(C) Copyright IBM Corporation 2005, 2012.
|
Constructor Summary
Constructor and Description |
---|
HTMConnection()
Creates a new connection to the HumanTaskManagerService.
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
close()
Closes the connection to the process engine.
|
|
finalize()
Ensures that the
close() method is called before
the object is disposed of by the garbage collector.
|
getHumanTaskManagerService()
Retrieves the HumanTaskManagerService bean.
|
|
|
getJndiName()
Gets the JNDI name for the Human Task Manager API EJB.
|
|
getObserver()
Deprecated. As of version 8.0.1, the reporting feature is no longer supported. This method always returns false.
|
|
getProviderURL()
Gets the URL to the service provider for the Human Task Manager API EJBs.
|
|
getRemote()
Gets whether the connection is to be made through a remote or local EJB interface.
|
|
retrieve(OID id)
Retrieve a TaskTemplate, Task or Escalation
object using its identifier.
|
|
retrieve(TKIID id)
Deprecated. use
retrieve(OID)
|
|
setJndiName(java.lang.String newName)
Sets the JNDI name for the Human Task Manager API EJB.
|
|
setObserver(java.lang.Boolean booleanValue)
Deprecated. As of version 8.0.1, the reporting feature is no longer supported. This value is ignored.
|
|
setProviderURL(java.lang.String url)
Sets the URL to the service provider of the Human Task Manager API EJBs.
|
|
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, 2012.
See Also:
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( )
Deprecated. As of version 8.0.1, the reporting feature is no longer supported. This method always returns false.
Gets whether the observer EJB is configured within BPCExplorer.
Returns:
'FALSE'.
setObserver
- public void setObserver(java.lang.Boolean booleanValue)
Deprecated. As of version 8.0.1, the reporting feature is no longer supported. This value is ignored.
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:
retrieve
- public java.lang.Object retrieve( OID id)
- throws ClientException
Retrieve a TaskTemplate, Task or Escalation
object using its identifier.
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