Avaya Conferencing Provider API

com.avaya.conferencing.api.acp.control
Class Filters

java.lang.Object
  extended by com.avaya.conferencing.api.acp.control.Filters

public final class Filters
extends java.lang.Object

Static class containing helper implementations of Filters.

Since:
5.1.0.0.29

Method Summary
static
<T> Filter<T>
allOf(Filter<? super T>... filters)
          Returns a Filter that returns only those ConferencingObject instances that match all of the supplied filters.
static
<T> Filter<T>
anyOf(Filter<? super T>... filters)
          Returns a Filter that returns only those ConferencingObject instances that match at least one of the supplied filters.
static Filter<Conference> conferenceConfereeCode(java.lang.String... codes)
          Returns a Filter that returns only those Conference instances that have at least one of the specified conferee codes.
static Filter<Conference> conferenceModeratorCode(java.lang.String... codes)
          Returns a Filter that returns only those Conference instances that have at least one of the specified moderator codes.
static Filter<Conference> conferenceParticipantCode(java.lang.String... codes)
          Returns a Filter that returns only those Conference instances that have at least one of the specified participant (i.e.
static
<S extends ConferencingObject<S>>
Filter<ConferencingObjectContainer<? extends ConferencingObjectContainer<?>>>
contains(Reference<S> ref)
          Returns a Filter that matches only those ConferencingObjectContainer instances that contain the specified Referenced child.
static
<T> Filter<T>
not(Filter<T> filter)
          Returns a filter that returns the methods that would not be returned by the supplied filter.
static Filter<ConferencingObject<? extends ConferencingObject<?>>> propertiesEqual(java.util.Map<java.lang.String,java.lang.Object> query)
          Returns a Filter that returns only those ConferencingObject instances that have all the specified properties with the specified values.
static Filter<ConferencingObject<? extends ConferencingObject<?>>> propertyEquals(java.lang.String name, java.lang.Object... values)
          Returns a Filter that returns only those ConferencingObject instances that have the specified property with any of the specified values.
static Filter<ConferencingObject<? extends ConferencingObject<?>>> propertyEquals(java.lang.String name, java.lang.Object value)
          Returns a Filter that returns only those ConferencingObject instances that have the specified property with the specified value.
static Filter<ConferencingObject<? extends ConferencingObject<?>>> propertyNotEqual(java.lang.String name, java.lang.Object... values)
          Returns a Filter that returns only those ConferencingObject instances that have the specified property without any of the specified values.
static Filter<ConferencingObject<? extends ConferencingObject<?>>> propertyNotEqual(java.lang.String name, java.lang.Object value)
          Returns a Filter that returns only those ConferencingObject instances that have the specified property not equal to the specified value.
static Filter<ConferencingObject<? extends ConferencingObject<?>>> stateExcludesAll(State... states)
          Returns a Filter that returns only those ConferencingObject instances that do not have any of the specified States.
static Filter<ConferencingObject<? extends ConferencingObject<?>>> stateExcludesAny(State... states)
          Returns a Filter that returns only those ConferencingObject instances that do not have any of the specified States.
static Filter<ConferencingObject<? extends ConferencingObject<?>>> stateIncludesAll(State... states)
          Returns a Filter that returns only those ConferencingObject instances that have all the specified States.
static Filter<ConferencingObject<? extends ConferencingObject<?>>> stateIncludesAny(State... states)
          Returns a Filter that returns those ConferencingObject instances that have any of the specified States.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

stateIncludesAll

public static Filter<ConferencingObject<? extends ConferencingObject<?>>> stateIncludesAll(State... states)
Returns a Filter that returns only those ConferencingObject instances that have all the specified States.

Parameters:
states - The States that must be present.
Returns:
a Filter that returns only those ConferencingObject instances that have all the specified States.
Since:
5.1.0.0.33

stateIncludesAny

public static Filter<ConferencingObject<? extends ConferencingObject<?>>> stateIncludesAny(State... states)
Returns a Filter that returns those ConferencingObject instances that have any of the specified States.

Parameters:
states - The States of which at least one must be present.
Returns:
a Filter that returns those ConferencingObject instances that have at least one of the specified States.
Since:
5.1.0.0.33

contains

public static <S extends ConferencingObject<S>> Filter<ConferencingObjectContainer<? extends ConferencingObjectContainer<?>>> contains(Reference<S> ref)
Returns a Filter that matches only those ConferencingObjectContainer instances that contain the specified Referenced child.

Parameters:
ref - The Reference to the child ConferencingObject that we want the ConferencingObjectContainer to contain.
Returns:
a Filter that matches those ConferencingObjectContainers containing the Referenced child.
Since:
5.1.0.0.31

stateExcludesAny

public static Filter<ConferencingObject<? extends ConferencingObject<?>>> stateExcludesAny(State... states)
Returns a Filter that returns only those ConferencingObject instances that do not have any of the specified States.

Parameters:
states - The States that must be present.
Returns:
a Filter that returns only those ConferencingObject instances that do not have all of the specified States.
Since:
5.1.0.0.33

stateExcludesAll

public static Filter<ConferencingObject<? extends ConferencingObject<?>>> stateExcludesAll(State... states)
Returns a Filter that returns only those ConferencingObject instances that do not have any of the specified States.

Parameters:
states - The States that must be present.
Returns:
a Filter that returns only those ConferencingObject instances that do not have any of the specified States.
Since:
5.1.0.0.33

propertyNotEqual

public static Filter<ConferencingObject<? extends ConferencingObject<?>>> propertyNotEqual(java.lang.String name,
                                                                                           java.lang.Object value)
Returns a Filter that returns only those ConferencingObject instances that have the specified property not equal to the specified value.

Parameters:
name - The name of the property.
value - The value of the property.
Returns:
a Filter that returns only those ConferencingObject instances that have the specified property with the specified value.
Since:
5.1.0.0.29

propertyNotEqual

public static Filter<ConferencingObject<? extends ConferencingObject<?>>> propertyNotEqual(java.lang.String name,
                                                                                           java.lang.Object... values)
Returns a Filter that returns only those ConferencingObject instances that have the specified property without any of the specified values.

Parameters:
name - The name of the property.
values - The values the property may have.
Returns:
a Filter that returns only those ConferencingObject instances that have the specified property with any of the specified values.
Since:
5.1.0.0.29

propertyEquals

public static Filter<ConferencingObject<? extends ConferencingObject<?>>> propertyEquals(java.lang.String name,
                                                                                         java.lang.Object value)
Returns a Filter that returns only those ConferencingObject instances that have the specified property with the specified value.

Parameters:
name - The name of the property.
value - The value of the property.
Returns:
a Filter that returns only those ConferencingObject instances that have the specified property with the specified value.
Since:
5.1.0.0.29

propertiesEqual

public static Filter<ConferencingObject<? extends ConferencingObject<?>>> propertiesEqual(java.util.Map<java.lang.String,java.lang.Object> query)
Returns a Filter that returns only those ConferencingObject instances that have all the specified properties with the specified values.

Parameters:
query - The properties and their associated values as a Map.
Returns:
a Filter that returns only those ConferencingObject instances that have all the specified properties with the specified values.
Since:
5.1.0.0.29

propertyEquals

public static Filter<ConferencingObject<? extends ConferencingObject<?>>> propertyEquals(java.lang.String name,
                                                                                         java.lang.Object... values)
Returns a Filter that returns only those ConferencingObject instances that have the specified property with any of the specified values.

Parameters:
name - The name of the property.
values - The values the property may have.
Returns:
a Filter that returns only those ConferencingObject instances that have the specified property with any of the specified values.
Since:
5.1.0.0.29

not

public static <T> Filter<T> not(Filter<T> filter)
Returns a filter that returns the methods that would not be returned by the supplied filter.

Parameters:
filter - The filter to return the opposite of.
Returns:
A filter that is the opposite of the supplied filter.
Since:
5.1.0.0.33

anyOf

public static <T> Filter<T> anyOf(Filter<? super T>... filters)
Returns a Filter that returns only those ConferencingObject instances that match at least one of the supplied filters.

Parameters:
filters - The filters, at least one of which must match.
Returns:
a Filter that returns only those ConferencingObject instances that match at least one of the supplied filters.
Since:
5.1.0.0.29

allOf

public static <T> Filter<T> allOf(Filter<? super T>... filters)
Returns a Filter that returns only those ConferencingObject instances that match all of the supplied filters.

Parameters:
filters - The filters, all of which must match.
Returns:
a Filter that returns only those ConferencingObject instances that match all of the supplied filters.
Since:
5.1.0.0.33

conferenceParticipantCode

public static Filter<Conference> conferenceParticipantCode(java.lang.String... codes)
Returns a Filter that returns only those Conference instances that have at least one of the specified participant (i.e. the union of conferee and moderator) codes.

Parameters:
codes - The participant (i.e. the union of conferee and moderator) codes to match.
Returns:
a Filter that returns only those Conference instances that have at least one of the specified participant (i.e. the union of conferee and moderator) codes.
Since:
5.1.0.0.32

conferenceModeratorCode

public static Filter<Conference> conferenceModeratorCode(java.lang.String... codes)
Returns a Filter that returns only those Conference instances that have at least one of the specified moderator codes.

Parameters:
codes - The moderator codes to match.
Returns:
a Filter that returns only those Conference instances that have at least one of the specified moderator codes.
Since:
5.1.0.0.32

conferenceConfereeCode

public static Filter<Conference> conferenceConfereeCode(java.lang.String... codes)
Returns a Filter that returns only those Conference instances that have at least one of the specified conferee codes.

Parameters:
codes - The conferee codes to match.
Returns:
a Filter that returns only those Conference instances that have at least one of the specified conferee codes.
Since:
5.1.0.0.32

Avaya Conferencing Provider API

Copyright © 2008-2009 Avaya. All Rights Reserved.