com.nitido.nimx.nuggets.wcap
Class ParticipateStatus

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

public class ParticipateStatus
extends java.lang.Object

The possible status for the attendee's participation status. Calendar server allow a user to invite another user on the same server to attend a meeting. That user can accept or decline the invitation by setting the ParticipateStatus field of its Attendee entries For more details, please refer to iPlanet Calendar Server programming guide and RFC 2445.

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:

• ACCEPTED
• DECLINED
• NEEDS_ACTION

Field Summary

static ParticipateStatus	ACCEPTED Predefined value for accepting an invitation.
static ParticipateStatus	DECLINED Predefined value for declining an invitation.
static ParticipateStatus	NEEDS_ACTION Predefined value for needing further action.
static java.lang.String	STR_ACCEPTED The actual string value of ACCEPTED (as defined by RFC 2445 and WCAP).
static java.lang.String	STR_DECLINED The actual string value of DECLINED (as defined by RFC 2445 and WCAP).
static java.lang.String	STR_NEEDS_ACTION The actual string value of NEEDS_ACTION (as defined by RFC 2445 and WCAP).

Method Summary

static ParticipateStatus	convertFromString(java.lang.String inStr) This is used to convert a string into a ParticipateStatus.
boolean	equals(ParticipateStatus inObj) Override the default java.lang.Object's equal command.
java.lang.String	getStringValue() Return the string value of the participation status.

Methods inherited from class java.lang.Object

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

Field Detail

STR_ACCEPTED

public static final java.lang.String STR_ACCEPTED

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

See Also:

Constant Field Values

STR_DECLINED

public static final java.lang.String STR_DECLINED

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

See Also:

Constant Field Values

STR_NEEDS_ACTION

public static final java.lang.String STR_NEEDS_ACTION

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

See Also:

Constant Field Values

ACCEPTED

public static final ParticipateStatus ACCEPTED

Predefined value for accepting an invitation.

DECLINED

public static final ParticipateStatus DECLINED

Predefined value for declining an invitation.

NEEDS_ACTION

public static final ParticipateStatus NEEDS_ACTION

Predefined value for needing further action. This is the default value before the attendee has replied.

Method Detail

getStringValue

public java.lang.String getStringValue()

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

equals

public boolean equals(ParticipateStatus 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.

convertFromString

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

This is used to convert a string into a ParticipateStatus. This method will perform an 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.