|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.b2bi.im.bfm.client.BFMBean
Field Summary | |
static java.lang.String |
copyrightNotice
|
Constructor Summary | |
BFMBean()
|
Method Summary | |
java.util.Hashtable |
adocServiceRequest(java.lang.String request,
java.util.Hashtable context,
java.util.Hashtable input,
java.lang.String adocId)
Deprecated. As of WSBI 2.0. Use serviceRequest instead. |
void |
archiveAdoc(java.lang.String adocId)
Archives the Adoc. |
java.lang.Object |
createAdoc(java.lang.String adocType)
Creates an instance of an Adoc for the given type. |
java.lang.String |
createAdocIdReturn(java.lang.String adocType)
Creates a Adoc for a given adoc type. |
com.ibm.b2bi.im.bfm.client.Tamap |
findTamapByTaskId(java.lang.String taskId)
Deprecated. As of WSBI 2.0. With the advent of the generic serviceRequest methods the Adoc query methods should be used. |
java.util.Vector |
findTamapsByAdoc(java.lang.String adocId)
Deprecated. As of WSBI 2.0. With the advent of the generic serviceRequest methods the Adoc query methods should be used. |
java.util.Vector |
findTamapsByAdocForUser(java.lang.String adocId,
java.lang.String user)
Deprecated. As of WSBI 2.0. With the advent of the generic serviceRequest methods the Adoc query methods should be used. |
java.util.Vector |
findTamapsByProcessInstance(java.lang.String procId)
Deprecated. As of WSBI 2.0. With the advent of the generic serviceRequest this method should not be required. |
java.util.Vector |
findTamapsByUser(java.lang.String user)
Deprecated. As of WSBI 2.0. With the advent of the generic serviceRequest methods the Adoc query methods should be used. |
java.lang.Object |
getAdoc(java.lang.Object adocKey,
java.lang.String adocType)
Gets an Adoc. |
com.ibm.b2bi.im.bfm.client.AdocDetails |
getAdoc(java.lang.String adocId)
Gets the AdocDetails object for the given adoc instance. |
java.lang.String |
getAdocFromTaskId(java.lang.String taskId)
Gets the ADOC ID for the given Task ID. |
java.util.Vector |
getAdocs(java.lang.String adocType,
java.lang.String user,
java.lang.String state)
Gets a list of Adocs matching some criterion. |
java.util.Vector |
getAdocsByFilter(java.lang.String adocType,
java.util.Hashtable filterParams)
Gets a list of Adocs based on an user filter. |
java.util.Vector |
getAdocsByFilter(java.lang.String adocType,
java.lang.String user,
java.lang.String state,
java.util.Hashtable filterParams)
Gets a list of Adocs based on an user filter. |
java.util.Vector |
getAllAdocEvents(java.lang.String adocType,
java.lang.String state,
java.lang.String role,
java.lang.String user)
Gets a list of Adocs and get a list of events that the Adoc alone can accept in current state. |
java.util.Vector |
getAllPossibleBusinessEvents(java.lang.String adocId,
java.lang.String role,
java.lang.String user)
Gets a list of events that the Adoc alone can accept in current state. |
java.util.Vector |
getArchivedAdocs(java.lang.String adocType,
java.lang.String startDateTimeStr,
java.lang.String endDateTimeStr)
Gets a list of Adocs that have been archived. |
java.util.Vector |
getEventListForAdoc(java.lang.String adocId,
java.lang.String role)
Gets a list of events that the Adoc alone can accept in current state. |
java.util.Vector |
getEventListForTask(java.lang.String taskId,
java.lang.String role)
Gets a list of events that the Activity alone can accept in current state. |
java.util.Vector |
getInboxList(java.lang.String user)
|
com.ibm.b2bi.im.bfm.client.Tamap |
getProcDetails(java.lang.String taskId)
|
java.util.Vector |
getWorklist(java.lang.String user)
|
java.util.Hashtable |
incomingEpicMessage(com.ibm.b2bi.im.bfm.client.EpicMessage em)
This method provides the necessary logic to map/transform an incoming message ( EpicMessage ) to raise an event
on an Adoc instance using the serviceRequest method. |
java.util.Hashtable |
incomingEpicMessage(java.lang.String bodyCategory,
java.lang.String bodyType,
java.lang.String corrId,
java.lang.String message)
This method provides the necessary logic to map/transform an incoming message ( EpicMessage ) to raise an event
on an Adoc instance using the serviceRequest method. |
void |
initialize()
Gets a reference to BFMAdmin server object. |
java.util.Hashtable |
invoke(java.lang.String commandId,
java.util.Hashtable _context,
java.util.Hashtable _inputList)
Allows to execute any command defined in the command.xml without involving a Controller. |
void |
remove()
Removes the instance of BFMAdmin in BFM server. |
void |
removeAdoc(java.lang.String strkey)
Removes the given Adoc object. |
com.ibm.b2bi.im.bfm.client.AdocDetails |
resolveDocument(java.lang.String taskId)
|
java.lang.Object |
reviveAdoc(java.lang.String adocId)
Revives the Adoc specified in the AdocDetails . |
java.util.Hashtable |
serviceRequest(java.lang.String request,
java.util.Hashtable context,
java.util.Hashtable input,
java.lang.String adocId,
java.lang.String user)
This method does a state transistion change on a Adoc controller. |
void |
setServerString(java.lang.String serverString)
Sets the location of the BFM server. |
java.util.Hashtable |
taskServiceRequest(java.lang.String request,
java.util.Hashtable context,
java.util.Hashtable input,
java.lang.String taskId)
This method does a state transistion change on a task controller. |
Methods inherited from class java.lang.Object |
equals,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Field Detail |
public static final java.lang.String copyrightNotice
Constructor Detail |
public BFMBean()
Method Detail |
public java.util.Hashtable adocServiceRequest(java.lang.String request, java.util.Hashtable context, java.util.Hashtable input, java.lang.String adocId) throws BFMClientException
serviceRequest
instead.
request
) on the adoc instance (adocId
) passing in the context and the input parameters.
For more information please read the Client Programming section of the PBS Developer Guide.request
- The Event.context
- The context information.input
- The input information.adocId
- The adoc Id.public void archiveAdoc(java.lang.String adocId) throws BFMClientException
AdocDetails
and any business attributes specified by the Hashtable archive()
method in the Solution Adoc. Normally this method is invoked automatically by the Adoc Archival Listener when the archival request is
scheduled.
For more information please refer to the Adoc Life Cycle Management section of the PBS Developer Guide.AdocDetails
- The adoc structure holding the base adoc attributescom.ibm.epic.bfm.ejb.base.AdocDetails
public java.lang.Object createAdoc(java.lang.String adocType) throws BFMClientException
adocType
- The adoc Typepublic java.lang.String createAdocIdReturn(java.lang.String adocType) throws BFMClientException
adocType
- Adoc Typepublic com.ibm.b2bi.im.bfm.client.Tamap findTamapByTaskId(java.lang.String taskId) throws BFMClientException
serviceRequest
methods the Adoc query methods should be used.
Tamap
object for the task/activity id from the internal Activity Maps.taskId
- The activity id.Tamap
object.com.ibm.epic.bfm.ejb.base.Tamap
public java.util.Vector findTamapsByAdoc(java.lang.String adocId) throws BFMClientException
serviceRequest
methods the Adoc query methods should be used.
adocId
- The Adoc instance.Tamap objects.- Throws:
- RemoteException - Wrapped around any exception thrown.
- See Also:
- getAllAdocEvents,
getAllPossibleBusinessEvents,
com.ibm.epic.bfm.ejb.base.Tamap
public java.util.Vector findTamapsByAdocForUser(java.lang.String adocId, java.lang.String user) throws BFMClientException
serviceRequest
methods the Adoc query methods should be used.
adocId
- The Adoc instance.Tamap objects.- Throws:
- RemoteException - Wrapped around any exception thrown.
- See Also:
- getAllAdocEvents,
getAllPossibleBusinessEvents,
com.ibm.epic.bfm.ejb.base.Tamap
public java.util.Vector findTamapsByProcessInstance(java.lang.String procId) throws BFMClientException
serviceRequest
this method should not be required.
procId
- The Process instance.Tamap objects.- Throws:
- RemoteException - Wrapped around any exception thrown.
- See Also:
- getAllAdocEvents,
getAllPossibleBusinessEvents,
com.ibm.epic.bfm.ejb.base.Tamap
public java.util.Vector findTamapsByUser(java.lang.String user) throws BFMClientException
serviceRequest
methods the Adoc query methods should be used.
user
- The user Id.Tamap objects.- Throws:
- RemoteException - Wrapped around any exception thrown.
- See Also:
- getAllAdocEvents,
getAllPossibleBusinessEvents,
com.ibm.epic.bfm.ejb.base.Tamap
public java.lang.Object getAdoc(java.lang.Object adocKey, java.lang.String adocType) throws BFMClientException
key
for the adocType. The key
object passed
in must be the key object for the Solution Adoc. A runtime exception will be thrown if it is otherwise.key
- The primary key of the particular solution adoc e.g RFQAdocKeyadocType
- The adoc Type. e.g. RFQpublic com.ibm.b2bi.im.bfm.client.AdocDetails getAdoc(java.lang.String adocId) throws BFMClientException
AdocDetails
object for the given adoc instance.adocId
- The adoc IdAdocDetails Object.- Throws:
- RemoteException - The exception description.
- See Also:
com.ibm.epic.bfm.ejb.base.AdocDetails
public java.lang.String getAdocFromTaskId(java.lang.String taskId) throws BFMClientException
taskId
- Task ID.public java.util.Vector getAdocs(java.lang.String adocType, java.lang.String user, java.lang.String state) throws BFMClientException
AdocDetails
for given adocType or user or a state or
any combination of the above three.adocType
- Adoc Type.user
- Adoc ownerstate
- Adoc StateAdocDetails
objects.com.ibm.epic.bfm.ejb.base.AdocDetails
public java.util.Vector getAdocsByFilter(java.lang.String adocType, java.lang.String user, java.lang.String state, java.util.Hashtable filterParams) throws BFMClientException
boolean filter (Hashtable filterParams)
method
on the solution Adoc. The filter
method should return a true
or false
, based on which the
Adoc is selected or not selected. This typically allows for Adoc selection based on referenced business object attributes.
A null
can be passed for any/all of the Adoc attributes type, owner or state.
adocType
- The Adoc Type.user
- The Adoc ownerstate
- The Adoc State,Hashtable
- filter parameters as name-value pairsAdocDetails
objects.com.ibm.epic.bfm.ejb.base.AdocDetails
public java.util.Vector getAdocsByFilter(java.lang.String adocType, java.util.Hashtable filterParams) throws BFMClientException
boolean filter (Hashtable filterParams)
method
on the solution Adoc. The filter
method should return a true
or false
, based on which the
Adoc is selected or not selected. This typically allows for Adoc selection based on referenced business object attributes.adocType
- Adoc Type.Hashtable
- filter parameters as name-value pairsAdocDetails
objects.com.ibm.epic.bfm.ejb.base.AdocDetails
public java.util.Vector getAllAdocEvents(java.lang.String adocType, java.lang.String state, java.lang.String role, java.lang.String user) throws BFMClientException
null needs to be specified
if the particular attribute is insignificant.
- Parameters:
adocType
- An Adoc Type. Provide null
if unknown.state
- An Adoc State. Provide null
if unknown.role
- The Role of the interacting user. Provide null
if unknown.user
- The name of the user. Provide null
if unknown.- Returns:
- Vector A Vector of
AdocEvents
. - Throws:
- RemoteException - The exception description.
- See Also:
com.ibm.epic.bfm.ejb.base.AdocEvents
public java.util.Vector getAllPossibleBusinessEvents(java.lang.String adocId, java.lang.String role, java.lang.String user) throws BFMClientException
adocId
- An Adoc Instance identifier.role
- The Role of the interacting user. Provide null
if unknown.user
- The name of the user. Provide null
if unknown.String
.public java.util.Vector getArchivedAdocs(java.lang.String adocType, java.lang.String startDateTimeStr, java.lang.String endDateTimeStr) throws BFMClientException
adocType
- An Adoc Type. Provide null
if unknown.startDateTime
- Provide in the format [MM:DD:YY] HH:MM AM/PM
eg. 4/12/01 1:40 AM, 1:00 PM (1:00 PM today) or null
endDateTimeStr
- Provide in the format [MM:DD:YY] HH:MM AM/PM
eg. 4/12/01 1:40 AM, 1:00 PM (1:00 PM today) or null
AdocDetails
.com.ibm.epic.bfm.ejb.base.AdocDetails
public java.util.Vector getEventListForAdoc(java.lang.String adocId, java.lang.String role) throws BFMClientException
adocId
- An Adoc Instance identifier.role
- The Role of the interacting user. Provide null
if unknown.String
.public java.util.Vector getEventListForTask(java.lang.String taskId, java.lang.String role) throws BFMClientException
taskId
- An Activity Instance identifier.role
- The Role of the interacting user. Provide null
if unknown.String
.public java.util.Vector getInboxList(java.lang.String user) throws BFMClientException
public com.ibm.b2bi.im.bfm.client.Tamap getProcDetails(java.lang.String taskId) throws BFMClientException
public java.util.Vector getWorklist(java.lang.String user) throws BFMClientException
public java.util.Hashtable incomingEpicMessage(com.ibm.b2bi.im.bfm.client.EpicMessage em) throws BFMClientException
EpicMessage
) to raise an event
on an Adoc instance using the serviceRequest
method.EpicMessage
- A full formed message as an EpicMessage.serviceRequest
method.public java.util.Hashtable incomingEpicMessage(java.lang.String bodyCategory, java.lang.String bodyType, java.lang.String corrId, java.lang.String message) throws BFMClientException
EpicMessage
) to raise an event
on an Adoc instance using the serviceRequest
method.bodyCategory
- The Body Category of the message. This is mapped to an Adoc TypebodyType
- The Body Type of the message. This is mapped to the event to be raised on the Adoc.corrId
- The correlation Id of the message. This is assumed to be the Adoc Id.message
- The message itself in a stringified form.serviceRequest
method.public void initialize() throws BFMClientException
public java.util.Hashtable invoke(java.lang.String commandId, java.util.Hashtable _context, java.util.Hashtable _inputList) throws BFMClientException
commandId
- The command Id, as defined in the command.xml_context
- Hashtable of context info_inputList
- Hashtable of input infopublic void remove()
public void removeAdoc(java.lang.String strkey) throws BFMClientException
key
- The primary key for the Adoc object.adocType
- The adoc Typepublic com.ibm.b2bi.im.bfm.client.AdocDetails resolveDocument(java.lang.String taskId) throws BFMClientException
public java.lang.Object reviveAdoc(java.lang.String adocId) throws BFMClientException
AdocDetails
. If a revive (Hashtable solutionAttributes)
is implemented
on the Solution Adoc, all business attributes that were archived are passed onto this method for reinitializinf the referenced business
objects.
For more information please read the Adoc Life Cycle Management section of the PBS Developer Guide.AdocDetails
- The adoc structure holding the base adoc attributescom.ibm.epic.bfm.ejb.base.AdocDetails
,
archiveAdocspublic java.util.Hashtable serviceRequest(java.lang.String request, java.util.Hashtable context, java.util.Hashtable input, java.lang.String adocId, java.lang.String user) throws BFMClientException
request
- The Event.context
- The context information.input
- The input information.adocId
- The adoc Id.public void setServerString(java.lang.String serverString)
public java.util.Hashtable taskServiceRequest(java.lang.String request, java.util.Hashtable context, java.util.Hashtable input, java.lang.String taskId) throws BFMClientException
request
- The Event.context
- The context information.input
- The input information.taskId
- The task Id.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |