tv.amwa.maj.record
Interface DateStruct

All Known Implementing Classes:

DateStruct

public interface DateStruct

Specifies the date component of timestamp values that are specified according to Coordinated Universal Time (UTC). AAF dates represent dates with year, month and day of the month components.

Author:

Richard Cartwright

See Also:

DateStruct, TypeDefinitionRecord.DateStruct, TimeStamp, TimeStruct

Method Summary

byte	getDay() Returns the day of the month component of the date.
byte	getMonth() Returns the month component of the date, which is in the range 1 to 12.
short	getYear() Returns the year component of the date.
void	setDate(byte day, byte month, short year) Simultaneously set the components of date structure value with the given day, month and year.
void	setDay(byte day) Set the day of the month component of the date, in the range 1 to 31.
void	setMonth(byte month) Set the month component of the date, which is in the range 1 to 12.
void	setYear(short year) Sets the year component of the date, in the range -9999 to 9999.

Method Detail

setDate

void setDate(@UInt8
             byte day,
             @UInt8
             byte month,
             @Int16
             short year)
             throws IllegalArgumentException

Simultaneously set the components of date structure value with the given day, month and year.

Parameters:

day - Day of the month component of the date.

month - Month component of the date.

year - Year component of the date.

Throws:

IllegalArgumentException - One or more of the component values is outside the acceptable range for their values, or the specified date does not exist.

getDay

@UInt8
byte getDay()

Returns the day of the month component of the date.

Returns:

Day of the month component of the date.

setDay

void setDay(@UInt8
            byte day)
            throws IllegalArgumentException

Set the day of the month component of the date, in the range 1 to 31.

Parameters:

day - Day of the month component of the date.

Throws:

IllegalArgumentException - Provided day value is outside the acceptable range.

getMonth

@UInt8
byte getMonth()

Returns the month component of the date, which is in the range 1 to 12.

Returns:

Month component of the date.

setMonth

void setMonth(@UInt8
              byte month)
              throws IllegalArgumentException

Set the month component of the date, which is in the range 1 to 12.

Parameters:

month - Month component of the date.

Throws:

IllegalArgumentException - Provided month value is outside the acceptable range.

getYear

@Int16
short getYear()

Returns the year component of the date.

Returns:

Year part of the date.

setYear

void setYear(@Int16
             short year)
             throws IllegalArgumentException

Sets the year component of the date, in the range -9999 to 9999.

Parameters:

year - Year component of the date.

Throws:

IllegalArgumentException - Year is outside the acceptable range.