com.nitido.nimx.nuggets.wcap
Class CompStatus

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

public class CompStatus
extends java.lang.Object

The possible status for calendars from the iPlanet Calendar Server.

This object is defined based on iPlanet Calendar Server Programmer's Reference and RFC 2445.

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:

• CONFIRMED
• CANCELLED
• TENTATIVE
• NEEDS_ACTION
• COMPLETED
• IN_PROCESS
• DRAFT
• FINAL

In addition to these predefined values, this class also declared the associated integer value as constants. These integer constants would be extremely useful when you need to write a switch-case block for handling the events/todos based on their status.

Field Summary

static CompStatus	CANCELLED The predefined CompStatus value that indicates the component has been cancelled.
static CompStatus	COMPLETED The predefined CompStatus value that indicates the todo has already completed.
static CompStatus	CONFIRMED The predefined CompStatus value that indicates the event has been confirmed.
static CompStatus	DRAFT The predefined CompStatus value that indicates the component is still a draft only.
static CompStatus	FINAL The predefined CompStatus value that indicates the component is still final version.
static CompStatus	IN_PROCESS The predefined CompStatus value that indicates the todo is still in process.
static int	INT_CANCELLED The integer value of CANCELLED.
static int	INT_COMPLETED The integer value of COMPLETED.
static int	INT_CONFIRMED The integer value of CONFIRMED.
static int	INT_DRAFT The integer value of DRAFT.
static int	INT_FINAL The integer value of FINAL.
static int	INT_IN_PROCESS The integer value of IN_PROCESS.
static int	INT_NEEDS_ACTION The integer value of NEEDS_ACTION.
static int	INT_TENTATIVE The integer value of TENTATIVE.
static CompStatus	NEEDS_ACTION The predefined CompStatus value that indicates the todo requires further actions.
static java.lang.String	STR_CANCELLED The string value of CANCELLED.
static java.lang.String	STR_COMPLETED The string value of COMPLETED.
static java.lang.String	STR_CONFIRMED The string value of CONFIRMED.
static java.lang.String	STR_DRAFT The string value of DRAFT.
static java.lang.String	STR_FINAL The string value of FINAL.
static java.lang.String	STR_IN_PROCESS The string value of "IN_PROCESS".
static java.lang.String	STR_IN_PROCESS2 The string value of "IN-PROCESS".
static java.lang.String	STR_NEEDS_ACTION The string value of "NEEDS_ACTION".
static java.lang.String	STR_NEEDS_ACTION2 The string value of "NEEDS-ACTION".
static java.lang.String	STR_TENTATIVE The string value of TENTATIVE.
static CompStatus	TENTATIVE The predefined CompStatus value that indicates the event is only tentative.

Method Summary

static CompStatus	convertFromInt(int inValue) Convert an integer value into a suitable CompStatus object.
static CompStatus	convertFromString(java.lang.String inStr) Convert an integer String into a suitable CompStatus object.
static CompStatus	convertFromWcap30String(java.lang.String inStr) This method converts a Calendar Server 6.0 result for the STATUS tag into a CompStatus object.
boolean	equals(java.lang.Object inObj) Override the default java.lang.Object's equal command.
int	getIntValue() Return the integer value of the CompStatus.
java.lang.String	getStringValue() Return the string representation of the CompStatus.
java.lang.String	toString() Override the default toString() method.
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

INT_CONFIRMED

public static final int INT_CONFIRMED

The integer value of CONFIRMED. (WCAP Value = 0)

See Also:

Constant Field Values

INT_CANCELLED

public static final int INT_CANCELLED

The integer value of CANCELLED. (WCAP Value = 1)

See Also:

Constant Field Values

INT_TENTATIVE

public static final int INT_TENTATIVE

The integer value of TENTATIVE. (WCAP Value = 2)

See Also:

Constant Field Values

INT_NEEDS_ACTION

public static final int INT_NEEDS_ACTION

The integer value of NEEDS_ACTION. (WCAP Value = 3)

See Also:

Constant Field Values

INT_COMPLETED

public static final int INT_COMPLETED

The integer value of COMPLETED. (WCAP Value = 4)

See Also:

Constant Field Values

INT_IN_PROCESS

public static final int INT_IN_PROCESS

The integer value of IN_PROCESS. (WCAP Value = 5)

See Also:

Constant Field Values

INT_DRAFT

public static final int INT_DRAFT

The integer value of DRAFT. (WCAP Value = 6)

See Also:

Constant Field Values

INT_FINAL

public static final int INT_FINAL

The integer value of FINAL. (WCAP Value = 7)

See Also:

Constant Field Values

STR_CONFIRMED

public static final java.lang.String STR_CONFIRMED

The string value of CONFIRMED.

See Also:

Constant Field Values

STR_CANCELLED

public static final java.lang.String STR_CANCELLED

The string value of CANCELLED.

See Also:

Constant Field Values

STR_TENTATIVE

public static final java.lang.String STR_TENTATIVE

The string value of TENTATIVE.

See Also:

Constant Field Values

STR_NEEDS_ACTION

public static final java.lang.String STR_NEEDS_ACTION

The string value of "NEEDS_ACTION".

See Also:

Constant Field Values

STR_NEEDS_ACTION2

public static final java.lang.String STR_NEEDS_ACTION2

The string value of "NEEDS-ACTION".

See Also:

Constant Field Values

STR_COMPLETED

public static final java.lang.String STR_COMPLETED

The string value of COMPLETED.

See Also:

Constant Field Values

STR_IN_PROCESS

public static final java.lang.String STR_IN_PROCESS

The string value of "IN_PROCESS".

See Also:

Constant Field Values

STR_IN_PROCESS2

public static final java.lang.String STR_IN_PROCESS2

The string value of "IN-PROCESS".

See Also:

Constant Field Values

STR_DRAFT

public static final java.lang.String STR_DRAFT

The string value of DRAFT.

See Also:

Constant Field Values

STR_FINAL

public static final java.lang.String STR_FINAL

The string value of FINAL.

See Also:

Constant Field Values

CONFIRMED

public static final CompStatus CONFIRMED

The predefined CompStatus value that indicates the event has been confirmed.

This value is the default for a normal event or all the required attendees have accepted the invitation.

CANCELLED

public static final CompStatus CANCELLED

The predefined CompStatus value that indicates the component has been cancelled.

This value can appear in Event or ToDo.

TENTATIVE

public static final CompStatus TENTATIVE

The predefined CompStatus value that indicates the event is only tentative.

This value usually appears on an Event that still waits for attendees to confirm the attendance.

NEEDS_ACTION

public static final CompStatus NEEDS_ACTION

The predefined CompStatus value that indicates the todo requires further actions.

This value is used by ToDo components to indicate the ToDo task has not been completed.

COMPLETED

public static final CompStatus COMPLETED

The predefined CompStatus value that indicates the todo has already completed.

This value is used by ToDo components to indicate the ToDo task has been completed.

IN_PROCESS

public static final CompStatus IN_PROCESS

The predefined CompStatus value that indicates the todo is still in process.

When a new ToDo is created, the default status is usually NEEDS_ACTION. It may change to IN_PROCESS if the ToDo has been partially completed.

DRAFT

public static final CompStatus DRAFT

The predefined CompStatus value that indicates the component is still a draft only.

Currently, this is not used by iCS yet. (According to RFC 2445, this is designed for Journals.)

FINAL

public static final CompStatus FINAL

The predefined CompStatus value that indicates the component is still final version.

Currently, this is not used by iCS yet. (According to RFC 2445, this is designed for Journals.)

Method Detail

getIntValue

public int getIntValue()

Return the integer value of the CompStatus.

getStringValue

public java.lang.String getStringValue()

Return the string representation of the CompStatus. This method is mainly used for debugging or formatting the display.

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

convertFromInt

public static CompStatus convertFromInt(int inValue)

Convert an integer value into a suitable CompStatus object. If the specified value is invalid or not supported, a null object will be returned. The supported values are declared as "public final int" constants of this class. Al of these constants have names starts with "INT_".

convertFromString

public static CompStatus convertFromString(java.lang.String inStr)

Convert an integer String into a suitable CompStatus object. If the specified value is invalid or not supported, a null object will be returned.

For example, convertFromString( "1" ) will return the object CompStatus.CANCELLED

convertFromWcap30String

public static CompStatus convertFromWcap30String(java.lang.String inStr)

This method converts a Calendar Server 6.0 result for the STATUS tag into a CompStatus object. In this version of calendar server, the status is in the full descriptive string instead of the the integer that we have passed to it when the ToDo/Event is stored.

toString

public java.lang.String toString()

Override the default toString() method. This method will invoke getStringValue().

Overrides:

toString in class java.lang.Object