Avaya Conferencing Provider API

com.avaya.conferencing.api.acp.control
Enum ConferencingObjectQueue.Purposes

java.lang.Object
  extended by java.lang.Enum<ConferencingObjectQueue.Purposes>
      extended by com.avaya.conferencing.api.acp.control.ConferencingObjectQueue.Purposes
All Implemented Interfaces:
ConferencingObjectQueue.Purpose, java.io.Serializable, java.lang.Comparable<ConferencingObjectQueue.Purposes>
Enclosing interface:
ConferencingObjectQueue<Q extends ConferencingObjectQueue<Q,E>,E extends ConferencingObject<E>>

public static enum ConferencingObjectQueue.Purposes
extends java.lang.Enum<ConferencingObjectQueue.Purposes>
implements ConferencingObjectQueue.Purpose

Well known purposes.

Since:
5.1.0.0.34

Enum Constant Summary
CONNECTIONS_ASSIST_REQUIRED
          The queue contains ConferencingObjects (typically EndPoints) that are connecting to the ConferencingProvider and
CONNECTIONS_PENDING
          The queue contains ConferencingObjects (typically EndPoints) that are connecting to the ConferencingProvider and are still being processed.
HELP_REQUESTS
          The queue contains ConferencingObjects that have requested help.
QA_QUESTIONS
          The queue contains EndPoints that have questions.
 
Method Summary
 Filter<ConferencingObjectQueue<? extends ConferencingObjectQueue<?,?>,? extends ConferencingObject<?>>> filter()
          A filter for this type of purpose.
static ConferencingObjectQueue.Purposes valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static ConferencingObjectQueue.Purposes[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

HELP_REQUESTS

public static final ConferencingObjectQueue.Purposes HELP_REQUESTS
The queue contains ConferencingObjects that have requested help.

See Also:
Verb.REQUEST_HELP, RequestHelp

CONNECTIONS_PENDING

public static final ConferencingObjectQueue.Purposes CONNECTIONS_PENDING
The queue contains ConferencingObjects (typically EndPoints) that are connecting to the ConferencingProvider and are still being processed.


CONNECTIONS_ASSIST_REQUIRED

public static final ConferencingObjectQueue.Purposes CONNECTIONS_ASSIST_REQUIRED
The queue contains ConferencingObjects (typically EndPoints) that are connecting to the ConferencingProvider and


QA_QUESTIONS

public static final ConferencingObjectQueue.Purposes QA_QUESTIONS
The queue contains EndPoints that have questions.

See Also:
States.QA_HAS_QUESTION, States.QA_MODE, Verb.QA_MODE_START, Verb.QA_NEXT_QUESTION
Method Detail

values

public static ConferencingObjectQueue.Purposes[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (ConferencingObjectQueue.Purposes c : ConferencingObjectQueue.Purposes.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static ConferencingObjectQueue.Purposes valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

filter

public Filter<ConferencingObjectQueue<? extends ConferencingObjectQueue<?,?>,? extends ConferencingObject<?>>> filter()
A filter for this type of purpose.

Specified by:
filter in interface ConferencingObjectQueue.Purpose
Returns:
a filter for this type of purpose.

Avaya Conferencing Provider API

Copyright © 2008-2009 Avaya. All Rights Reserved.