com.nitido.nimx.nuggets.wcap
Class RecurFreq

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

public class RecurFreq
extends java.lang.Object

The possible value for the freq field of a recurrence rule.

This is a data object that acts as a C style enum. It force the programmer to use a set of predefined values. These supported values are defined by the iCalendar proposed standard (RFC 2445).

The available options are:

• SECONDLY
• MINUTELY
• HOURLY
• DAILY
• WEEKLY
• MONTHLY
• YEARLY

This object provides the required field "freq" of the RecurRule object. It is used to indicate under what frequency (i.e. the base) of the recurrence. It must be specified for all recurrence rule under RFC 2445.

Field Summary

static RecurFreq	DAILY Predefined value for recurring on day base.
static RecurFreq	HOURLY Predefined value for recurring on hour base.
static RecurFreq	MINUTELY Predefined value for recurring on minute base.
static RecurFreq	MONTHLY Predefined value for recurring on month base.
static RecurFreq	SECONDLY Predefined value for recurring on second base.
static java.lang.String	STR_DAILY The actual string value of DAILY (as defined by RFC 2445 and WCAP).
static java.lang.String	STR_HOURLY The actual string value of HOURLY (as defined by RFC 2445 and WCAP).
static java.lang.String	STR_MINUTELY The actual string value of MINUTELY (as defined by RFC 2445 and WCAP).
static java.lang.String	STR_MONTHLY The actual string value of MONTHLY (as defined by RFC 2445 and WCAP).
static java.lang.String	STR_SECONDLY The actual string value of SECONDLY (as defined by RFC 2445 and WCAP).
static java.lang.String	STR_WEEKLY The actual string value of WEEKLY (as defined by RFC 2445 and WCAP).
static java.lang.String	STR_YEARLY The actual string value of YEARLY (as defined by RFC 2445 and WCAP).
static RecurFreq	WEEKLY Predefined value for recurring on week base.
static RecurFreq	YEARLY Predefined value for recurring on year base.

Method Summary

static RecurFreq	convertFromString(java.lang.String inStr) Convert a string into an instance of RecurFreq.
boolean	equals(java.lang.Object inObj) Override the default java.lang.Object's equal command.
java.lang.String	getStringValue() Return the string value of the recurrence frequency.
java.lang.String	toString() Display the object as a string.
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, wait, wait, wait

Field Detail

STR_SECONDLY

public static final java.lang.String STR_SECONDLY

The actual string value of SECONDLY (as defined by RFC 2445 and WCAP).

See Also:

Constant Field Values

STR_MINUTELY

public static final java.lang.String STR_MINUTELY

The actual string value of MINUTELY (as defined by RFC 2445 and WCAP).

See Also:

Constant Field Values

STR_HOURLY

public static final java.lang.String STR_HOURLY

The actual string value of HOURLY (as defined by RFC 2445 and WCAP).

See Also:

Constant Field Values

STR_DAILY

public static final java.lang.String STR_DAILY

The actual string value of DAILY (as defined by RFC 2445 and WCAP).

See Also:

Constant Field Values

STR_WEEKLY

public static final java.lang.String STR_WEEKLY

The actual string value of WEEKLY (as defined by RFC 2445 and WCAP).

See Also:

Constant Field Values

STR_MONTHLY

public static final java.lang.String STR_MONTHLY

The actual string value of MONTHLY (as defined by RFC 2445 and WCAP).

See Also:

Constant Field Values

STR_YEARLY

public static final java.lang.String STR_YEARLY

The actual string value of YEARLY (as defined by RFC 2445 and WCAP).

See Also:

Constant Field Values

SECONDLY

public static final RecurFreq SECONDLY

Predefined value for recurring on second base.

MINUTELY

public static final RecurFreq MINUTELY

Predefined value for recurring on minute base.

HOURLY

public static final RecurFreq HOURLY

Predefined value for recurring on hour base.

DAILY

public static final RecurFreq DAILY

Predefined value for recurring on day base.

WEEKLY

public static final RecurFreq WEEKLY

Predefined value for recurring on week base.

MONTHLY

public static final RecurFreq MONTHLY

Predefined value for recurring on month base.

YEARLY

public static final RecurFreq YEARLY

Predefined value for recurring on year base.

Method Detail

getStringValue

public java.lang.String getStringValue()

Return the string value of the recurrence frequency. This method is mainly for display or debugging only. A developer should use the method RecurFreq.equals( inObj ) whenever possible.

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

toString

public java.lang.String toString()

Display the object as a string. This method is mainly used for debugging.

Overrides:

toString in class java.lang.Object

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

convertFromString

public static RecurFreq convertFromString(java.lang.String inStr)
                                   throws InvalidParameterException

Convert a string into an instance of RecurFreq. this method will perform error check on the string validity (the check is case insensitive).

Parameters:

inStr - the participate status string.

Returns:

null object if inStr is null. Otherwise, it will return a ParticipateStatus instance if inStr contains a valid string.

Throws:

InvalidParameterException - if the inStr is not a valid participate status string.