|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Manages QIL interactions.
Method Summary | |
void |
leave(java.lang.String ixnId,
java.lang.String reasonDescription,
java.lang.String reasonSystemName)
Leaves the interaction. |
void |
lock(java.lang.String ixnId,
java.lang.String reasonDescription,
java.lang.String reasonSystemName)
Locks the interaction. |
void |
placeInQueue(java.lang.String ixnId,
java.lang.String queueID,
java.lang.String reasonDescription,
java.lang.String reasonSystemName)
Places the interaction in a specific queue. |
void |
pull(java.lang.String ixnId,
java.lang.String reasonDescription,
java.lang.String reasonSystemName)
Pulls the interaction. |
void |
removeProperties(java.lang.String ixnId,
java.util.Collection properties)
Removes a set of interaction properties. |
void |
removeProperty(java.lang.String ixnId,
java.lang.String propertyName)
Removes an interaction property. |
void |
setProperties(java.lang.String ixnId,
java.util.Map properties)
Sets new values for a set of properties. |
void |
setProperty(java.lang.String ixnId,
java.lang.String propertyName,
java.lang.Object propertyValue)
Sets a new value for the specified interaction property. |
void |
stopProcessing(java.lang.String ixnId,
java.lang.String reasonDescription,
java.lang.String reasonSystemName)
Stops the processing of the interaction and deletes it from the Interaction Server database). |
void |
unlock(java.lang.String ixnId,
java.lang.String reasonDescription,
java.lang.String reasonSystemName)
Unlocks a locked interaction. |
Method Detail |
public void pull(java.lang.String ixnId, java.lang.String reasonDescription, java.lang.String reasonSystemName) throws QILRequestFailedException
QILInteractionStatus.QUEUED
status.
placeInQueue()
,
setProperty()
,
or stopProcessing()
call on a particular interaction.
ixnId
- the interaction ID.reasonDescription
- the reason for pulling this interaction.reasonSystemName
- the system name reason for pulling this interaction.
QILRequestFailedException
- exception thrown if the request failed.
To get specific reasons for this error, see the subclasses of QILRequestFailedException.public void leave(java.lang.String ixnId, java.lang.String reasonDescription, java.lang.String reasonSystemName) throws QILRequestFailedException
ixnId
- the interaction ID.reasonDescription
- the reason for leaving this interaction.reasonSystemName
- the system name reason for leaving this interaction.
QILRequestFailedException
- exception thrown if the request failed.
To get specific reasons for this error, see the subclasses of QILRequestFailedException.pull(String, String, String)
public void lock(java.lang.String ixnId, java.lang.String reasonDescription, java.lang.String reasonSystemName) throws QILRequestFailedException
By locking an interaction, the supervisor temporarily stops the processing of this interaction.
This interaction becomes invisible from any view, and is not processed by the framework according
to the designed workflow. The supervisor can analyze the interaction and request the framework
to perform a specific action on this interaction.
The supervisor who locked this interaction is the unique person who can issue requests for this interaction.
Note: If the interaction is already locked, or if the interaction
is not in QILInteractionStatus.QUEUED
status, the interaction cannot be locked again.
ixnId
- the interaction ID.reasonDescription
- the reason for locking this interaction.reasonSystemName
- the system name reason for locking this interaction.
QILRequestFailedException
- exception thrown if the request failed.
To get specific reasons for this error, see the subclasses of QILRequestFailedException.unlock(String, String, String)
public void placeInQueue(java.lang.String ixnId, java.lang.String queueID, java.lang.String reasonDescription, java.lang.String reasonSystemName) throws QILRequestFailedException
pulled
this interaction.
The interaction is no longer pulled.
ixnId
- the ID of the interaction to be placed in a specific queue.queueID
- the ID of the queue into which the interaction is placed.reasonDescription
- the reason for placing this interaction into this queue.reasonSystemName
- the name of the system reason for placing this interaction into this queue.
QILRequestFailedException
- exception thrown if the request failed.
To get specific reasons for this error, see the subclasses of QILRequestFailedException.lock(String, String, String)
public void setProperty(java.lang.String ixnId, java.lang.String propertyName, java.lang.Object propertyValue) throws QILRequestFailedException
pull
this interaction before you call this method.
ixnId
- the ID of the interaction.propertyName
- the name of the property to be set.propertyValue
- the value to set.
QILRequestFailedException
- exception thrown if the request failed.
To get specific reasons for this error, see the subclasses of QILRequestFailedException.public void setProperties(java.lang.String ixnId, java.util.Map properties) throws QILRequestFailedException
pull
this interaction before you call this method.
ixnId
- the ID of the interaction.properties
- the map of the properties to be set.
QILRequestFailedException
- exception thrown if the request failed.
To get specific reasons for this error, see the subclasses of QILRequestFailedException.public void removeProperty(java.lang.String ixnId, java.lang.String propertyName) throws QILRequestFailedException
pull
this interaction before you call this method.
ixnId
- the ID of the interaction.propertyName
- the name of the property to be set.
QILRequestFailedException
- exception thrown if the request failed.
To get specific reasons for this error, see the subclasses of QILRequestFailedException.public void removeProperties(java.lang.String ixnId, java.util.Collection properties) throws QILRequestFailedException
ixnId
- the ID of the interaction.properties
- the names of the properties to be removed.
QILRequestFailedException
- exception thrown if the request failed.
To get specific reasons for this error, see the subclasses of QILRequestFailedException.public void stopProcessing(java.lang.String ixnId, java.lang.String reasonDescription, java.lang.String reasonSystemName) throws QILRequestFailedException
ixnId
- the ID of the interaction.reasonDescription
- the reason for stopping processing this interaction.reasonSystemName
- the system reason for stopping processing this interaction.
QILRequestFailedException
- exception thrown if the request failed.
To get specific reasons for this error, see the subclasses of QILRequestFailedException.public void unlock(java.lang.String ixnId, java.lang.String reasonDescription, java.lang.String reasonSystemName) throws QILRequestFailedException
locked
interaction.
After unlocking, the interaction becomes visible.
ixnId
- the ID of the interaction.reasonDescription
- the reason for unlocking this interaction.reasonSystemName
- the system reason for unlocking this interaction.
QILRequestFailedException
- exception thrown if the request failed.
To get specific reasons for this error, see the subclasses of QILRequestFailedException.lock(String, String, String)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |