Public Member Functions

org.exolab.castor.types.TimePeriod Class Reference

Inheritance diagram for org.exolab.castor.types.TimePeriod:
org.exolab.castor.types.RecurringDuration org.exolab.castor.types.RecurringDurationBase org.exolab.castor.types.Century org.exolab.castor.types.Month org.exolab.castor.types.Year

List of all members.

Public Member Functions

 TimePeriod ()
 TimePeriod (String duration)
void setFields (String str) throws ParseException
void setPeriod (TimeDuration period) throws OperationNotSupportedException

Detailed Description

Describe an XML schema TimePeriod.

The time period type is derived from recurringDuration by setting up the facet:

Author:
Arnaud Blandin
Version:
Revision:
1.1.1.1
See also:
RecurringDuration

Constructor & Destructor Documentation

org.exolab.castor.types.TimePeriod.TimePeriod (  ) 
org.exolab.castor.types.TimePeriod.TimePeriod ( String  duration  ) 

returns a TimePeriod with the duration facet set up

Parameters:
duration the String value of the duration facet
Returns:
a TimePeriod the duration facet set up

Member Function Documentation

void org.exolab.castor.types.TimePeriod.setFields ( String  str  )  throws ParseException

parse a string to set the fields of a TimePeriod

Parameters:
str the string to parse

References org.exolab.castor.types.RecurringDurationBase.isNegative(), org.exolab.castor.types.RecurringDurationBase.isUTC(), org.exolab.castor.types.RecurringDuration.setCentury(), org.exolab.castor.types.RecurringDuration.setDay(), org.exolab.castor.types.RecurringDurationBase.setHour(), org.exolab.castor.types.RecurringDurationBase.setMinute(), org.exolab.castor.types.RecurringDuration.setMonth(), org.exolab.castor.types.RecurringDurationBase.setNegative(), org.exolab.castor.types.RecurringDurationBase.setSecond(), org.exolab.castor.types.RecurringDuration.setYear(), org.exolab.castor.types.RecurringDurationBase.setZone(), and org.exolab.castor.types.RecurringDurationBase.setZoneNegative().

Referenced by org.exolab.castor.types.TimePeriodDescriptor.TimePeriodFieldHandler.setValue().

void org.exolab.castor.types.TimePeriod.setPeriod ( TimeDuration  period  )  throws OperationNotSupportedException

set the period facet for this recurringDuration

Parameters:
period the period to set
Exceptions:
OperationNotSupportedException this exception is thrown when changing the value of the period facet is not allowed

Reimplemented from org.exolab.castor.types.RecurringDurationBase.

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Properties
Generated on Thu Jan 12 2012 23:15:50 for ACS-10.0 Java API by  doxygen 1.7.0