com.nitido.nimx.nuggets.wcap
Class WcapModifier

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

public class WcapModifier
extends java.lang.Object

The possible modifier options available when modifying/deleting an Event or a ToDo.

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

The available options are:

• THIS_INSTANCE
• THIS_AND_FUTURE
• THIS_AND_PRIOR
• THIS_AND_ALL

The chapter "WCAP Commands" of the iPlanet Calendar Server Programming Guide contains more information on the modifier.

Field Summary

static java.lang.String	STR_THIS_AND_ALL
static java.lang.String	STR_THIS_AND_FUTURE
static java.lang.String	STR_THIS_INSTANCE
static java.lang.String	STR_THIS_PRIOR
static WcapModifier	THIS_AND_ALL Predefined modifier value of "THIS_AND_ALL".
static WcapModifier	THIS_AND_FUTURE Predefined modifier value of "THIS_AND_FUTURE".
static WcapModifier	THIS_AND_PRIOR Predefined modifier value of "THIS_AND_PRIOR".
static WcapModifier	THIS_INSTANCE Predefined modifier value of "THIS_INSTANCE".

Method Summary

static WcapModifier	convertFromString(java.lang.String value) Convert a string to the corresponding modifier object.
boolean	equals(java.lang.Object inObj) Override the default java.lang.Object's equal command.
java.lang.String	getValue() Return an internal representation of the modifier value.
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

STR_THIS_INSTANCE

public static final java.lang.String STR_THIS_INSTANCE

See Also:

Constant Field Values

STR_THIS_AND_FUTURE

public static final java.lang.String STR_THIS_AND_FUTURE

See Also:

Constant Field Values

STR_THIS_PRIOR

public static final java.lang.String STR_THIS_PRIOR

See Also:

Constant Field Values

STR_THIS_AND_ALL

public static final java.lang.String STR_THIS_AND_ALL

See Also:

Constant Field Values

THIS_INSTANCE

public static final WcapModifier THIS_INSTANCE

Predefined modifier value of "THIS_INSTANCE". It tells the iCS to apply the change to this instance of event/todo only.

THIS_AND_FUTURE

public static final WcapModifier THIS_AND_FUTURE

Predefined modifier value of "THIS_AND_FUTURE". It tells the iCS to apply the change to the current and later recurrences of the event/todo.

THIS_AND_PRIOR

public static final WcapModifier THIS_AND_PRIOR

Predefined modifier value of "THIS_AND_PRIOR". It tells the iCS to apply the change to the current and earlier instances of the event/todo.

THIS_AND_ALL

public static final WcapModifier THIS_AND_ALL

Predefined modifier value of "THIS_AND_ALL". It tells the iCS to apply the change to the current and earlier instances of the event/todo. CAUTION Early testing with iCS v5.0p4 has discovered that when using with this modifier, the deletion would not occur unless you are acting on the first event/todo of the series of recurrence. However, we haven't confirm whether this is still the case for iCS v5.1.

Method Detail

convertFromString

public static WcapModifier convertFromString(java.lang.String value)
                                      throws java.lang.IllegalArgumentException

Convert a string to the corresponding modifier object.

Parameters:

value - A value of modifier internal represetnation. The valid choices are "1", "2", "3" and "4".

Throws:

java.lang.IllegalArgumentException

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

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

getValue

public java.lang.String getValue()

Return an internal representation of the modifier value. The values that it can return are:

1. "1" = THIS_INSTANCE
2. "2" = THIS_AND_FUTURE
3. "3" = THIS_AND_PRIOR
4. "4" = THIS_AND_ALL