Public Member Functions | Static Public Member Functions | Static Public Attributes

cern.laser.client.services.selection.Filter Class Reference

Inheritance diagram for cern.laser.client.services.selection.Filter:
cern.laser.client.impl.services.selection.FilterImpl

List of all members.

Public Member Functions

abstract String getProperty ()
abstract void setProperty (String newProperty)
abstract String getOperator ()
abstract void setOperator (String newOperator)
abstract String getValue ()
abstract void setValue (String newValue)
abstract void validate () throws LaserException

Static Public Member Functions

static Filter create ()
static Filter create (String property, String operator, String value)

Static Public Attributes

static final String operators [] = FilterImpl.operators()
static final String properties [] = FilterImpl.properties()

Detailed Description

An alarm filter object. It defines a filtering criteria of the form property operator value, where property is an alarm property (fault family, ..., priority, building number, etc)

Member Function Documentation

static Filter cern.laser.client.services.selection.Filter.create (  )  [static]

Factory method. Create a filter instance.

Returns:
a new Filter instance
static Filter cern.laser.client.services.selection.Filter.create ( String  property,
String  operator,
String  value 
) [static]

Factory method. Create a filter instance given the parameters.

Parameters:
property the alarm property to filter against
operator the filtering operator to apply
value the value to filter
Returns:
a new Filter instance
abstract String cern.laser.client.services.selection.Filter.getOperator (  )  [pure virtual]

Accessor method.

Returns:
the filtering operator

Implemented in cern.laser.client.impl.services.selection.FilterImpl.

abstract String cern.laser.client.services.selection.Filter.getProperty (  )  [pure virtual]

Accessor method.

Returns:
the alarm property to filter against

Implemented in cern.laser.client.impl.services.selection.FilterImpl.

abstract String cern.laser.client.services.selection.Filter.getValue (  )  [pure virtual]

Accessor method.

Returns:
the value to filter

Implemented in cern.laser.client.impl.services.selection.FilterImpl.

abstract void cern.laser.client.services.selection.Filter.setOperator ( String  newOperator  )  [pure virtual]

Accessor method.

Parameters:
newOperator Accessor method.

Implemented in cern.laser.client.impl.services.selection.FilterImpl.

abstract void cern.laser.client.services.selection.Filter.setProperty ( String  newProperty  )  [pure virtual]

Accessor method.

Parameters:
newProperty the alarm property to filter against

Implemented in cern.laser.client.impl.services.selection.FilterImpl.

abstract void cern.laser.client.services.selection.Filter.setValue ( String  newValue  )  [pure virtual]

Accessor method.

Parameters:
newValue the value to filter

Implemented in cern.laser.client.impl.services.selection.FilterImpl.

abstract void cern.laser.client.services.selection.Filter.validate (  )  throws LaserException [pure virtual]

Validation method.

Exceptions:
LaserException if the filter is not valid

Implemented in cern.laser.client.impl.services.selection.FilterImpl.

Member Data Documentation

final String cern.laser.client.services.selection.Filter.operators[] = FilterImpl.operators() [static]

The predefined operators array.

final String cern.laser.client.services.selection.Filter.properties[] = FilterImpl.properties() [static]

The predefined properties array.

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Properties
Generated on Thu Jan 12 2012 23:15:30 for ACS-10.0 Java API by  doxygen 1.7.0