|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Represents a queue, defined as
a script object of type Interaction Queue
in the Configuration Layer.
Changes in the queue's state, and in associated interactions, can generate events.
Your application can listen for these events and update its state accordingly.
You can track changes by adding a QILQueueListener
to this queue. Call the
addQueueListener()
method. The QILQueueListener
gets
QILQueueEvent
events if the queue changes.
If the queue status is active, you can change this queue's monitoring status by calling the startMonitoring()
and stopMonitoring()
methods.
If this queue's monitoring status is MONITORED
:
QILQueueEvent
events with the QILQueueListener
:
QILQueueMonitorStatusEvent
events for queue data changes.
QILQueueContentChangedEvent
events if interactions are added or removed.
QILInteractionListener
and add it to this queue. Call the addInteractionListener(QILInteractionListener)
method.
isMonitored()
,
QILQueueEvent
,
QILQueueListener
,
QILInteractionEvent
,
QILInteractionListener
Method Summary | |
void |
addInteractionListener(QILInteractionListener listener)
Adds a QILInteractionListener to the listener list
for interaction events. |
void |
addQueueListener(QILQueueListener listener)
Adds a QILQueueListener to the listener list
for queue events. |
QILQueryAsyncResult |
asyncGetInteractionsByQuery(QILInteractionQueryBySQL query,
boolean shouldLock)
Asynchronously retrieves a collection of interactions according to the given SQL criteria. |
java.util.Map |
getAnnex()
Returns the queue's properties specified in the Configuration Layer. |
java.lang.String |
getID()
Returns the queue ID. |
QILInteractionList |
getInteractionsByQuery(QILInteractionQueryBySQL query,
boolean shouldLock)
Retrieves a collection of interactions according to the given SQL criteria. |
QILQueueStatus |
getStatus()
Deprecated. as of 7.2.007.00 |
boolean |
isMonitored()
Checks if this queue is being monitored. |
void |
releaseInteractionsList(QILInteractionList list)
Releases the interactions list created by a call to the getInteractionsByQuery(QILInteractionQueryBySQL, boolean) method. |
void |
removeInteractionListener(QILInteractionListener listener)
Removes a QILInteractionListener from the listener list
for interaction events. |
void |
removeQueueListener(QILQueueListener listener)
Removes a QILQueueListener from the listener list
for queue events. |
void |
startMonitoring()
Starts monitoring this queue. |
void |
stopMonitoring()
Stops monitoring this queue. |
Method Detail |
public java.lang.String getID()
This ID corresponds to the queue name defined in the Configuration Layer.
QILFactory.getQueue(java.lang.String)
public java.util.Map getAnnex()
Map
of properties, where the key is a String
for a section name,
and the value is a second-level Map
of options.
Map
, the key is a String
for
an option name and
the value is a String
for the corresponding option value.public QILQueueStatus getStatus()
public void startMonitoring() throws QILRequestFailedException
QILRequestFailedException
- exception thrown if the request failed. To get
specific reasons for this error, see the subclasses of QILRequestFailedException
.public void stopMonitoring() throws QILQueueNotMonitoredException, QILRequestFailedException
QILQueueNotMonitoredException
- exception thrown if the startMonitoring()
method
has not previously been issued on this queue.
QILRequestFailedException
- exception thrown if the request failed. To get
specific reasons for this error, see the subclasses of QILRequestFailedException
.public boolean isMonitored()
true
if the queue is being monitored, otherwise false
.public void addQueueListener(QILQueueListener listener)
QILQueueListener
to the listener list
for queue events.
Use this listener to track queue changes:
QILQueueMonitorStatusEvent
events.QILQueueContentChangedEvent
events.
listener
- the listener to be added.QILQueueEvent
public void removeQueueListener(QILQueueListener listener)
QILQueueListener
from the listener list
for queue events.
listener
- the listener to be removed.public void addInteractionListener(QILInteractionListener listener)
QILInteractionListener
to the listener list
for interaction events.
Use this listener to monitor interaction activity on this queue.
If an interaction's status changes,
the added listener gets a QILInteractionEvent
with the related
QILInteraction
interface.
listener
- the listener to be added.QILInteraction
public void removeInteractionListener(QILInteractionListener listener)
QILInteractionListener
from the listener list
for interaction events.
listener
- the listener to be removed.public QILInteractionList getInteractionsByQuery(QILInteractionQueryBySQL query, boolean shouldLock) throws QILRequestFailedException
query
- the SQL query.shouldLock
- true if the returned interactions should be locked.
QILMaxNumberOfSnapshotsException
- exception thrown if your application reaches the allowed maximum number of snapshots (configured in the Interaction Server)
QILNoInteractionFromIxnServer
- exception thrown if the Interaction Server returns no interaction.
QILRequestFailedException
QILFactory.getOperationalMode()
public QILQueryAsyncResult asyncGetInteractionsByQuery(QILInteractionQueryBySQL query, boolean shouldLock) throws QILRequestFailedException
getInteractionsByQuery()
.
After you call this method, it immediatly returns.
query
- the SQL query.shouldLock
- true if the returned interactions should be locked.
QILQueryAsyncResult
to use for waiting until the operation completes.
QILRequestFailedException
public void releaseInteractionsList(QILInteractionList list) throws QILRequestFailedException
getInteractionsByQuery(QILInteractionQueryBySQL, boolean)
method.
This method also unlocks the interactions if they were locked.
Genesys recommends releasing lists as soon as you are finished with them to avoid tying up Interaction Server resources.
list
- the list to be released.
QILRequestFailedException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |