SearchParameter (SIH-Adagio :: Core 3.5.6 API)

Object
- SearchParameter

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CriteriaSearchParameter
```
public class SearchParameter
extends Object
implements Serializable
```
Represents a generic search parameter that can be used with property searches.

See Also:
PropertySearch, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`EMPTY_COMPARATOR` 14
`static int`	`EQUAL_COMPARATOR` 2
`static int`	`GREATER_THAN_COMPARATOR` 4
`static int`	`GREATER_THAN_OR_EQUAL_COMPARATOR` 3
`static int`	`IN_COMPARATOR` 7
`static int`	`INSENSITIVE_LIKE_COMPARATOR` 1
`static int`	`LESS_THAN_COMPARATOR` 6
`static int`	`LESS_THAN_OR_EQUAL_COMPARATOR` 5
`static int`	`LIKE_COMPARATOR` 0
`static int`	`MATCH_ANYWHERE` 0
`static int`	`MATCH_END` 2
`static int`	`MATCH_EXACT` 3
`static int`	`MATCH_START` 1
`static int`	`NOT_EMPTY_COMPARATOR` 15
`static int`	`NOT_EQUAL_COMPARATOR` 8
`static int`	`NOT_IN_COMPARATOR` 11
`static int`	`NOT_INSENSITIVE_LIKE_COMPARATOR` 13
`static int`	`NOT_LIKE_COMPARATOR` 12
`static int`	`NOT_NULL_COMPARATOR` 9
`static int`	`NULL_COMPARATOR` 10
`static int`	`ORDER_ASC` Ascending order
`static int`	`ORDER_DESC` Descending order
`static int`	`ORDER_UNSET` Order unset

Constructor Summary

Constructors
Constructor and Description
`SearchParameter(SearchParameter otherBean)` Copies constructor from other SearchParameter
`SearchParameter(String nameIn, int comparatorIn)` Constructor taking name and comparator properties.
`SearchParameter(String nameIn, Object valueIn)` Constructor taking name and value properties.
`SearchParameter(String nameIn, Object valueIn, int comparatorIn)` Constructor taking name, value and comparator properties.
`SearchParameter(String nameIn, Object valueIn, int comparatorIn, int matchIn)` Constructor taking name, value, comparator and order properties.
`SearchParameter(String nameIn, Object valueIn, int comparatorIn, int matchIn, int orderIn)` Constructor taking name, value, comparator, order and match properties.
`SearchParameter(String nameIn, Object valueIn, int comparatorIn, int matchIn, int orderIn, boolean searchIfNullIn)` Constructor taking all properties.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`getComparator()`
`int`	`getMatch()` Gets the match attribute which controls how parameter values are matched (anywhere, start, end or exact).
`String`	`getName()` The parameter name in dot notation (i.e. person.firstNAme).
`int`	`getOrder()` Order attribute to control if parameter is used in order by clause.
`Object`	`getValue()` The value of the parameter.
`boolean`	`isSearchIfNull()` Whether this parameter will be included in the search even if it is `null`.
`void`	`setComparator(int comparatorIn)`
`void`	`setMatch(int matchIn)` Sets the match mode attribute which controls how parameter values are matched (anywhere, start, end or exact).
`void`	`setName(String nameIn)`
`void`	`setOrder(int orderIn)`
`void`	`setSearchIfNull(boolean searchIfNullIn)` Defines whether parameter will be included in the search even if it is `null`.
`void`	`setValue(Object valueIn)`

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LIKE_COMPARATOR
```
public static final int LIKE_COMPARATOR
```
    0
    
    See Also:
    Constant Field Values
  - INSENSITIVE_LIKE_COMPARATOR
```
public static final int INSENSITIVE_LIKE_COMPARATOR
```
    1
    
    See Also:
    Constant Field Values
  - EQUAL_COMPARATOR
```
public static final int EQUAL_COMPARATOR
```
    2
    
    See Also:
    Constant Field Values
  - GREATER_THAN_OR_EQUAL_COMPARATOR
```
public static final int GREATER_THAN_OR_EQUAL_COMPARATOR
```
    3
    
    See Also:
    Constant Field Values
  - GREATER_THAN_COMPARATOR
```
public static final int GREATER_THAN_COMPARATOR
```
    4
    
    See Also:
    Constant Field Values
  - LESS_THAN_OR_EQUAL_COMPARATOR
```
public static final int LESS_THAN_OR_EQUAL_COMPARATOR
```
    5
    
    See Also:
    Constant Field Values
  - LESS_THAN_COMPARATOR
```
public static final int LESS_THAN_COMPARATOR
```
    6
    
    See Also:
    Constant Field Values
  - IN_COMPARATOR
```
public static final int IN_COMPARATOR
```
    7
    
    See Also:
    Constant Field Values
  - NOT_EQUAL_COMPARATOR
```
public static final int NOT_EQUAL_COMPARATOR
```
    8
    
    See Also:
    Constant Field Values
  - NOT_NULL_COMPARATOR
```
public static final int NOT_NULL_COMPARATOR
```
    9
    
    See Also:
    Constant Field Values
  - NULL_COMPARATOR
```
public static final int NULL_COMPARATOR
```
    10
    
    See Also:
    Constant Field Values
  - NOT_IN_COMPARATOR
```
public static final int NOT_IN_COMPARATOR
```
    11
    
    See Also:
    Constant Field Values
  - NOT_LIKE_COMPARATOR
```
public static final int NOT_LIKE_COMPARATOR
```
    12
    
    See Also:
    Constant Field Values
  - NOT_INSENSITIVE_LIKE_COMPARATOR
```
public static final int NOT_INSENSITIVE_LIKE_COMPARATOR
```
    13
    
    See Also:
    Constant Field Values
  - EMPTY_COMPARATOR
```
public static final int EMPTY_COMPARATOR
```
    14
    
    See Also:
    Constant Field Values
  - NOT_EMPTY_COMPARATOR
```
public static final int NOT_EMPTY_COMPARATOR
```
    15
    
    See Also:
    Constant Field Values
  - ORDER_UNSET
```
public static final int ORDER_UNSET
```
    Order unset
    
    See Also:
    Constant Field Values
  - ORDER_ASC
```
public static final int ORDER_ASC
```
    Ascending order
    
    See Also:
    Constant Field Values
  - ORDER_DESC
```
public static final int ORDER_DESC
```
    Descending order
    
    See Also:
    Constant Field Values
  - MATCH_ANYWHERE
```
public static final int MATCH_ANYWHERE
```
    0
    
    See Also:
    Constant Field Values
  - MATCH_START
```
public static final int MATCH_START
```
    1
    
    See Also:
    Constant Field Values
  - MATCH_END
```
public static final int MATCH_END
```
    2
    
    See Also:
    Constant Field Values
  - MATCH_EXACT
```
public static final int MATCH_EXACT
```
    3
    
    See Also:
    Constant Field Values
- Constructor Detail
  - SearchParameter
```
public SearchParameter(String nameIn,
               Object valueIn)
```
    Constructor taking name and value properties.
    
    Parameters:
    nameIn -
    valueIn -
  - SearchParameter
```
public SearchParameter(String nameIn,
               int comparatorIn)
```
    Constructor taking name and comparator properties.
    
    Parameters:
    nameIn -
    comparatorIn -
  - SearchParameter
```
public SearchParameter(String nameIn,
               Object valueIn,
               int comparatorIn)
```
    Constructor taking name, value and comparator properties.
    
    Parameters:
    nameIn -
    valueIn -
    comparatorIn -
  - SearchParameter
```
public SearchParameter(String nameIn,
               Object valueIn,
               int comparatorIn,
               int matchIn)
```
    Constructor taking name, value, comparator and order properties.
    
    Parameters:
    nameIn -
    valueIn -
    comparatorIn -
    matchIn -
  - SearchParameter
```
public SearchParameter(String nameIn,
               Object valueIn,
               int comparatorIn,
               int matchIn,
               int orderIn)
```
    Constructor taking name, value, comparator, order and match properties.
    
    Parameters:
    nameIn -
    valueIn -
    comparatorIn -
    matchIn -
    orderIn -
  - SearchParameter
```
public SearchParameter(String nameIn,
               Object valueIn,
               int comparatorIn,
               int matchIn,
               int orderIn,
               boolean searchIfNullIn)
```
    Constructor taking all properties.
    
    Parameters:
    nameIn -
    valueIn -
    comparatorIn -
    matchIn -
    orderIn -
    searchIfNullIn -
  - SearchParameter
```
public SearchParameter(SearchParameter otherBean)
```
    Copies constructor from other SearchParameter
    
    Parameters:
    otherBean -
- Method Detail
  - getName
```
public String getName()
```
    The parameter name in dot notation (i.e. person.firstNAme).
    
    Returns:
    name
  - setName
```
public void setName(String nameIn)
```
    Parameters:
    nameIn -
  - getValue
```
public Object getValue()
```
    The value of the parameter.
    
    Returns:
    value
  - setValue
```
public void setValue(Object valueIn)
```
    Parameters:
    valueIn -
  - getComparator
```
public int getComparator()
```
    Returns:
    comparator
  - setComparator
```
public void setComparator(int comparatorIn)
```
    Parameters:
    comparatorIn -
  - getOrder
```
public int getOrder()
```
    Order attribute to control if parameter is used in order by clause.
    
    Returns:
    order
  - setOrder
```
public void setOrder(int orderIn)
```
    Parameters:
    orderIn -
  - isSearchIfNull
```
public boolean isSearchIfNull()
```
    Whether this parameter will be included in the search even if it is null.
    
    Returns:
    true/false searchIfNull
  - setSearchIfNull
```
public void setSearchIfNull(boolean searchIfNullIn)
```
    Defines whether parameter will be included in the search even if it is null.
    
    Parameters:
    searchIfNullIn - true if the parameter should be included in the search even if it is null, false otherwise.
  - getMatch
```
public int getMatch()
```
    Gets the match attribute which controls how parameter values are matched (anywhere, start, end or exact).
    
    Returns:
    the match mode
  - setMatch
```
public void setMatch(int matchIn)
```
    Sets the match mode attribute which controls how parameter values are matched (anywhere, start, end or exact).
    
    Parameters:
    matchIn - the match mode

Class SearchParameter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

LIKE_COMPARATOR

INSENSITIVE_LIKE_COMPARATOR

EQUAL_COMPARATOR

GREATER_THAN_OR_EQUAL_COMPARATOR

GREATER_THAN_COMPARATOR

LESS_THAN_OR_EQUAL_COMPARATOR

LESS_THAN_COMPARATOR

IN_COMPARATOR

NOT_EQUAL_COMPARATOR

NOT_NULL_COMPARATOR

NULL_COMPARATOR

NOT_IN_COMPARATOR

NOT_LIKE_COMPARATOR

NOT_INSENSITIVE_LIKE_COMPARATOR

EMPTY_COMPARATOR

NOT_EMPTY_COMPARATOR

ORDER_UNSET

ORDER_ASC

ORDER_DESC

MATCH_ANYWHERE

MATCH_START

MATCH_END

MATCH_EXACT

Constructor Detail

SearchParameter

SearchParameter

SearchParameter

SearchParameter

SearchParameter

SearchParameter

SearchParameter

Method Detail

getName

setName

getValue

setValue

getComparator

setComparator

getOrder

setOrder

isSearchIfNull

setSearchIfNull

getMatch

setMatch