# XQilla Simple API Documentation

# ATDateOrDerived Class Reference

`#include <ATDateOrDerived.hpp>`

Inheritance diagram for ATDateOrDerived:
[legend]

List of all members.

## Public Types

typedef RefCountPointer< const ATDateOrDerived > | Ptr

## Public Member Functions

virtual const XMLCh * | getPrimitiveTypeName () const =0
virtual const XMLCh * | getTypeURI () const =0
virtual const XMLCh * | getTypeName () const =0
virtual const XMLCh * | asString (const DynamicContext *context) const =0
virtual bool | equals (const AnyAtomicType::Ptr &target, const DynamicContext *context) const =0
virtual int | compare (const ATDateOrDerived::Ptr &other, const DynamicContext *context) const =0
| Returns less than 0 if this is less that other, 0 if they are the same, and greater than 0 otherwise.
virtual ATDecimalOrDerived::Ptr | getYears (const DynamicContext *context) const =0
| Returns an integer representing the year component of this object.
virtual ATDecimalOrDerived::Ptr | getMonths (const DynamicContext *context) const =0
| Returns an integer representing the month component of this object.
virtual ATDecimalOrDerived::Ptr | getDays (const DynamicContext *context) const =0
| Returns an integer representing the day component of this object.
virtual const Timezone::Ptr & | getTimezone () const =0
| Returns a timezone object representing the timezone component of this object.
virtual bool | hasTimezone () const =0
| Returns true if the timezone is defined for this object, false otherwise.
virtual ATDateOrDerived::Ptr | setTimezone (const Timezone::Ptr &timezone, const DynamicContext *context) const =0
| Setter for timezone.
virtual ATDateOrDerived::Ptr | addTimezone (const ATDurationOrDerived::Ptr &timezone, const DynamicContext *context) const =0
| Returns an ATDateOrDerived with a timezone added to it.
virtual ATDateOrDerived::Ptr | addYearMonthDuration (const ATDurationOrDerived::Ptr &yearMonth, const DynamicContext *context) const =0
| Returns a date with the given yearMonthDuration added to it.
virtual ATDateOrDerived::Ptr | addDayTimeDuration (const ATDurationOrDerived::Ptr &dayTime, const DynamicContext *context) const =0
| Returns a date with the given dayTimeDuration added to it.
virtual ATDateOrDerived::Ptr | subtractYearMonthDuration (const ATDurationOrDerived::Ptr &yearMonth, const DynamicContext *context) const =0
| Returns a date with the given yearMonthDuration subtracted from it.
virtual ATDateOrDerived::Ptr | subtractDayTimeDuration (const ATDurationOrDerived::Ptr &dayTime, const DynamicContext *context) const =0
| Returns a date with the given dayTimeDuration subtracted from it.
virtual ATDurationOrDerived::Ptr | subtractDate (const ATDateOrDerived::Ptr &date, const DynamicContext *context) const =0
| Returns a dayTimeDuration corresponding to the difference between this and the given ATDateOrDerived*.
virtual AnyAtomicType::AtomicObjectType | getPrimitiveTypeIndex () const =0

## Member Typedef Documentation

typedef RefCountPointer<const ATDateOrDerived> ATDateOrDerived::Ptr

Reimplemented from DateOrTimeType.

## Member Function Documentation

virtual ATDateOrDerived::Ptr ATDateOrDerived::addDayTimeDuration | ( | const ATDurationOrDerived::Ptr & | dayTime,
|  | const DynamicContext * | context |
| ) |  |  | const`[pure virtual]`

Returns a date with the given dayTimeDuration added to it.

virtual ATDateOrDerived::Ptr ATDateOrDerived::addTimezone | ( | const ATDurationOrDerived::Ptr & | timezone,
|  | const DynamicContext * | context |
| ) |  |  | const`[pure virtual]`

Returns an ATDateOrDerived with a timezone added to it.

virtual ATDateOrDerived::Ptr ATDateOrDerived::addYearMonthDuration | ( | const ATDurationOrDerived::Ptr & | yearMonth,
|  | const DynamicContext * | context |
| ) |  |  | const`[pure virtual]`

Returns a date with the given yearMonthDuration added to it.

virtual const XMLCh* ATDateOrDerived::asString | ( | const DynamicContext * | context | ) | const`[pure virtual]`

Implements AnyAtomicType.

virtual int ATDateOrDerived::compare | ( | const ATDateOrDerived::Ptr & | other,
|  | const DynamicContext * | context |
| ) |  |  | const`[pure virtual]`

Returns less than 0 if this is less that other, 0 if they are the same, and greater than 0 otherwise.

virtual bool ATDateOrDerived::equals | ( | const AnyAtomicType::Ptr & | target,
|  | const DynamicContext * | context |
| ) |  |  | const`[pure virtual]`

Implements AnyAtomicType.

virtual ATDecimalOrDerived::Ptr ATDateOrDerived::getDays | ( | const DynamicContext * | context | ) | const`[pure virtual]`

Returns an integer representing the day component of this object.

virtual ATDecimalOrDerived::Ptr ATDateOrDerived::getMonths | ( | const DynamicContext * | context | ) | const`[pure virtual]`

Returns an integer representing the month component of this object.

virtual AnyAtomicType::AtomicObjectType ATDateOrDerived::getPrimitiveTypeIndex | ( |  | ) | const`[pure virtual]`

Implements AnyAtomicType.

virtual const XMLCh* ATDateOrDerived::getPrimitiveTypeName | ( |  | ) | const`[pure virtual]`

Implements AnyAtomicType.

virtual const Timezone::Ptr& ATDateOrDerived::getTimezone | ( |  | ) | const`[pure virtual]`

Returns a timezone object representing the timezone component of this object.

virtual const XMLCh* ATDateOrDerived::getTypeName | ( |  | ) | const`[pure virtual]`

Implements AnyAtomicType.

virtual const XMLCh* ATDateOrDerived::getTypeURI | ( |  | ) | const`[pure virtual]`

Implements AnyAtomicType.

virtual ATDecimalOrDerived::Ptr ATDateOrDerived::getYears | ( | const DynamicContext * | context | ) | const`[pure virtual]`

Returns an integer representing the year component of this object.

virtual bool ATDateOrDerived::hasTimezone | ( |  | ) | const`[pure virtual]`

Returns true if the timezone is defined for this object, false otherwise.

Implements DateOrTimeType.

virtual ATDateOrDerived::Ptr ATDateOrDerived::setTimezone | ( | const Timezone::Ptr & | timezone,
|  | const DynamicContext * | context |
| ) |  |  | const`[pure virtual]`

Setter for timezone.

Overrides the current timezone. (Not to be confused with addTimezone().

virtual ATDurationOrDerived::Ptr ATDateOrDerived::subtractDate | ( | const ATDateOrDerived::Ptr & | date,
|  | const DynamicContext * | context |
| ) |  |  | const`[pure virtual]`

Returns a dayTimeDuration corresponding to the difference between this and the given ATDateOrDerived*.

virtual ATDateOrDerived::Ptr ATDateOrDerived::subtractDayTimeDuration | ( | const ATDurationOrDerived::Ptr & | dayTime,
|  | const DynamicContext * | context |
| ) |  |  | const`[pure virtual]`

Returns a date with the given dayTimeDuration subtracted from it.

virtual ATDateOrDerived::Ptr ATDateOrDerived::subtractYearMonthDuration | ( | const ATDurationOrDerived::Ptr & | yearMonth,
|  | const DynamicContext * | context |
| ) |  |  | const`[pure virtual]`

Returns a date with the given yearMonthDuration subtracted from it.

The documentation for this class was generated from the following file:

- ATDateOrDerived.hpp