com.nitido.nimx.nuggets.wcap
Class SearchOption

java.lang.Object
  com.nitido.nimx.nuggets.wcap.SearchOption

public class SearchOption
extends java.lang.Object

The possible options that can be used when searching for calendar. It is used by WcapNugget.searchForCalendar().

This is a data object that act as a C style enum. It force the programmer to use a set of predefined values.

The available options are:

• CONTAINS
• BEGINS_WITH
• ENDS_WITH
• EXACT

Field Summary

static SearchOption	BEGINS_WITH Predefined value for searching for calendars that begin with the specified string.
static SearchOption	CONTAINS Predefined value for searching for calendars that contain the specified string.
static SearchOption	ENDS_WITH Predefined value for searching for calendars that end with the specified string.
static SearchOption	EXACT Predefined value for searching for calendars that exactly match the specified string.

Method Summary

boolean	equals(java.lang.Object inObj) Override the default java.lang.Object's equal command.
java.lang.String	toWcapQuery(WcapNugget nugget) Convert the component into a string that is used for constructing a WCAP query.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONTAINS

public static final SearchOption CONTAINS

Predefined value for searching for calendars that contain the specified string.

BEGINS_WITH

public static final SearchOption BEGINS_WITH

Predefined value for searching for calendars that begin with the specified string.

ENDS_WITH

public static final SearchOption ENDS_WITH

Predefined value for searching for calendars that end with the specified string.

EXACT

public static final SearchOption EXACT

Predefined value for searching for calendars that exactly match the specified string.

Method Detail

equals

public boolean equals(java.lang.Object inObj)

Override the default java.lang.Object's equal command. This will compares the content of the fields. In case of a vector or array field, it will compare the content of the field.

Overrides:

equals in class java.lang.Object

toWcapQuery

public java.lang.String toWcapQuery(WcapNugget nugget)
                             throws WcapException

Convert the component into a string that is used for constructing a WCAP query. This method is designed for internal use by the WcapNugget only.

Throws:

WcapException