com.alarmpoint.servicemanager
Enum ServiceManagerQueryOperator

java.lang.Object
  extended by java.lang.Enum<ServiceManagerQueryOperator>
      extended by com.alarmpoint.servicemanager.ServiceManagerQueryOperator
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<ServiceManagerQueryOperator>

public enum ServiceManagerQueryOperator
extends java.lang.Enum<ServiceManagerQueryOperator>

Used to define how to search on a specific field

Author:
bneate

Enum Constant Summary
BEGINS_WITH
           
EQUALS
           
LIKE
           
NOT_EQUALS
           
 
Method Summary
 java.lang.String getFormattedName()
          Returns the enum value formatted so it is suitable to be displayed on the web ui
 java.lang.String getOperator()
          Returns a string with the operators to insert into the Service Manager query
 java.lang.String getShortName()
          Returns the enum value formatted so it is suitable to be displayed on the mobile gateway
static ServiceManagerQueryOperator valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static ServiceManagerQueryOperator[] 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

LIKE

public static final ServiceManagerQueryOperator LIKE

EQUALS

public static final ServiceManagerQueryOperator EQUALS

NOT_EQUALS

public static final ServiceManagerQueryOperator NOT_EQUALS

BEGINS_WITH

public static final ServiceManagerQueryOperator BEGINS_WITH
Method Detail

values

public static ServiceManagerQueryOperator[] 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 (ServiceManagerQueryOperator c : ServiceManagerQueryOperator.values())
    System.out.println(c);

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

valueOf

public static ServiceManagerQueryOperator 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

getOperator

public java.lang.String getOperator()
Returns a string with the operators to insert into the Service Manager query

Returns:
query operator

getShortName

public java.lang.String getShortName()
Returns the enum value formatted so it is suitable to be displayed on the mobile gateway

Returns:
the short display value for the enum

getFormattedName

public java.lang.String getFormattedName()
Returns the enum value formatted so it is suitable to be displayed on the web ui

Returns:
The enum in a readable format