Top Description Inners Fields Constructors Methods
net.fortuna.ical4j.model.property

public Class RequestStatus

extends Property
Class Inheritance
Imports
net.fortuna.ical4j.model.Content, .ParameterList, .Property, .PropertyFactory, net.fortuna.ical4j.validate.PropertyValidator, .ValidationException, .ValidationResult

$Id$

Created: [Apr 6, 2004]

Defines a REQUEST-STATUS iCalendar component property.

Author
benf

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final String
CLIENT_ERROR

Client error status.

private String
private String
public static final String
PRELIM_SUCCESS

Preliminary success status.

public static final String
SCHEDULING_ERROR

Scheduling error status.

private static final long
private String
public static final String
SUCCESS

Success status.

Inherited from net.fortuna.ical4j.model.Property:
ACKNOWLEDGEDACTIONATTACHATTENDEEBUSYTYPECALENDAR_ADDRESSCALSCALECATEGORIESCLASSCOMMENTCOMPLETEDCONTACTCOUNTRYCREATEDDESCRIPTIONDTENDDTSTAMPDTSTARTDUEDURATIONEXDATEEXPERIMENTAL_PREFIXEXRULEEXTENDED_ADDRESSFREEBUSYGEOLAST_MODIFIEDLOCALITYLOCATIONLOCATION_TYPEMETHODNAMEORGANIZERPARTICIPANT_TYPEPERCENT_COMPLETEPOSTALCODEPRIORITYPRODIDPROXIMITYRDATERECURRENCE_IDREGIONRELATED_TOREPEATREQUEST_STATUSRESOURCE_TYPERESOURCESRRULESEQUENCESTATUSSTREET_ADDRESSSTRUCTURED_DATASTYLED_DESCRIPTIONSUMMARYTELTRANSPTRIGGERTZIDTZID_ALIAS_OFTZNAMETZOFFSETFROMTZOFFSETTOTZUNTILTZURLUIDURLVERSIONXML

Constructor Summary

AccessConstructor and Description
public
RequestStatus()

Default constructor.

public
RequestStatus(final ParameterList
a list of parameters for this component
aList
,
final String
a value string for this component
aValue
)

public
RequestStatus(final String
a string representation of a status code
aStatusCode
,
final String
a description
aDescription
,
final String
a string representation of extension data
data
)

public
RequestStatus(final ParameterList
a list of parameters for this component
aList
,
final String
a string representation of a status code
aStatusCode
,
final String
a description
aDescription
,
final String
a string representation of extension data
data
)

Method Summary

Modifier and TypeMethod and Description
public final String

Returns:

Returns the description.
getDescription
()

public final String

Returns:

Returns the exData.
getExData
()

public final String

Returns:

Returns the statusCode.
getStatusCode
()

public final String
protected PropertyFactory<RequestStatus>
newFactory()

Implements abstract net.fortuna.ical4j.model.Property.newFactory.

Returns a new property factory used to create deep copies.

public final void
setDescription(final String
The description to set.
description
)

public final void
setExData(final String
The exData to set.
exData
)

public final void
setStatusCode(final String
The statusCode to set.
statusCode
)

public final void
setValue(final String
a string representation of the property value
aValue
)

Implements abstract net.fortuna.ical4j.model.Property.setValue.

Sets the current value of the property.

public ValidationResult
validate()

Implements abstract net.fortuna.ical4j.model.Property.validate.

Perform validation on a property.

Inherited from net.fortuna.ical4j.model.Property:
addcompareTocopyequalsgetFluentTargetgetNamegetParametergetParametergetParameterListgetParametersgetPrefixgetRequiredParametergetRequiredParameterhashCoderemoveremoveAllreplacesetParameterssetPrefixtoString

Field Detail

CLIENT_ERRORback to summary
public static final String CLIENT_ERROR

Client error status.

descriptionback to summary
private String description
exDataback to summary
private String exData
PRELIM_SUCCESSback to summary
public static final String PRELIM_SUCCESS

Preliminary success status.

SCHEDULING_ERRORback to summary
public static final String SCHEDULING_ERROR

Scheduling error status.

serialVersionUIDback to summary
private static final long serialVersionUID

Hides net.fortuna.ical4j.model.Property.serialVersionUID.

statusCodeback to summary
private String statusCode
SUCCESSback to summary
public static final String SUCCESS

Success status.

Constructor Detail

RequestStatusback to summary
public RequestStatus()

Default constructor.

RequestStatusback to summary
public RequestStatus(final ParameterList aList, final String aValue)
Parameters
aList:ParameterList

a list of parameters for this component

aValue:String

a value string for this component

RequestStatusback to summary
public RequestStatus(final String aStatusCode, final String aDescription, final String data)
Parameters
aStatusCode:String

a string representation of a status code

aDescription:String

a description

data:String

a string representation of extension data

RequestStatusback to summary
public RequestStatus(final ParameterList aList, final String aStatusCode, final String aDescription, final String data)
Parameters
aList:ParameterList

a list of parameters for this component

aStatusCode:String

a string representation of a status code

aDescription:String

a description

data:String

a string representation of extension data

Method Detail

getDescriptionback to summary
public final String getDescription()
Returns:String

Returns the description.

getExDataback to summary
public final String getExData()
Returns:String

Returns the exData.

getStatusCodeback to summary
public final String getStatusCode()
Returns:String

Returns the statusCode.

getValueback to summary
public final String getValue()

Implements abstract net.fortuna.ical4j.model.Content.getValue.

Returns:String

Doc from net.fortuna.ical4j.model.Content.getValue.

the content value

Annotations
@Override
newFactoryback to summary
protected PropertyFactory<RequestStatus> newFactory()

Implements abstract net.fortuna.ical4j.model.Property.newFactory.

Doc from net.fortuna.ical4j.model.Property.newFactory.

Returns a new property factory used to create deep copies.

Returns:PropertyFactory<RequestStatus>

a property factory instance

Annotations
@Override
setDescriptionback to summary
public final void setDescription(final String description)
Parameters
description:String

The description to set.

setExDataback to summary
public final void setExData(final String exData)
Parameters
exData:String

The exData to set.

setStatusCodeback to summary
public final void setStatusCode(final String statusCode)
Parameters
statusCode:String

The statusCode to set.

setValueback to summary
public final void setValue(final String aValue)

Implements abstract net.fortuna.ical4j.model.Property.setValue.

Doc from net.fortuna.ical4j.model.Property.setValue.

Sets the current value of the property.

Parameters
aValue:String

a string representation of the property value

Annotations
@Override
validateback to summary
public ValidationResult validate() throws ValidationException

Implements abstract net.fortuna.ical4j.model.Property.validate.

Doc from net.fortuna.ical4j.model.Property.validate.

Perform validation on a property.

Annotations
@Override
Exceptions
ValidationException:
where the property is not in a valid state
net.fortuna.ical4j.model.property back to summary

public Class RequestStatus.Factory

extends Factory
implements PropertyFactory<RequestStatus>
Class Inheritance
All Implemented Interfaces
net.fortuna.ical4j.model.PropertyFactory, java.io.Serializable

Field Summary

Modifier and TypeField and Description
private static final long

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public RequestStatus
createProperty(final ParameterList
a list of property parameters
parameters
,
final String
a property value
value
)

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

public RequestStatus
Inherited from net.fortuna.ical4j.model.Content.Factory:
supports

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Constructor Detail

Factoryback to summary
public Factory()

Method Detail

createPropertyback to summary
public RequestStatus createProperty(final ParameterList parameters, final String value)

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

Parameters
parameters:ParameterList

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a list of property parameters

value:String

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a property value

Returns:RequestStatus

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a new instance of the specified property

Annotations
@Override
createPropertyback to summary
public RequestStatus createProperty()

Implements net.fortuna.ical4j.model.PropertyFactory.createProperty.

Returns:RequestStatus

Doc from net.fortuna.ical4j.model.PropertyFactory.createProperty.

a new instance of the specified property

Annotations
@Override