OSID Specifications

calendaring package

Version 3.0.0

Release Candidate Preview

calendaring package

Version 3.0.0

Release Candidate Preview

Interface | osid.calendaring.Duration | ||
---|---|---|---|

Implements | `osid.OsidPrimitive` | ||

Description |
The While a | ||

Method | getCalendarType | ||

Description |
Gets the calendar type. | ||

Return | `osid.type.Type` | the calendar type | |

Compliance | `mandatory` | This method must be implemented. | |

Method | getTimeType | ||

Description |
Gets the time type. | ||

Return | `osid.type.Type` | the time type | |

Compliance | `mandatory` | This method must be implemented. | |

Method | getAeons | ||

Description |
Gets the number of aeons. An aeon is 1B years. | ||

Return | `decimal` | the number of aeons | |

Compliance | `mandatory` | This method must be implemented. | |

Method | getEpochs | ||

Description |
Gets the number of epochs. An epoch is 1M years. | ||

Return | `decimal` | the number of epochs | |

Compliance | `mandatory` | This method must be implemented. | |

Method | getMillennia | ||

Description |
Gets the number of millennia. A millennium is 1,000 years. | ||

Return | `decimal` | the number of millennia | |

Compliance | `mandatory` | This method must be implemented. | |

Method | getCenturies | ||

Description |
Gets the number of centuries. | ||

Return | `decimal` | the number of centuries | |

Compliance | `mandatory` | This method must be implemented. | |

Method | getScores | ||

Description |
Gets the number of scores. | ||

Return | `decimal` | the number of scores | |

Compliance | `mandatory` | This method must be implemented. | |

Method | getBluemoons | ||

Description |
Gets the number of blue moons. | ||

Return | `decimal` | the number of blue moons | |

Compliance | `mandatory` | This method must be implemented. | |

Method | getYears | ||

Description |
Gets the number of years. | ||

Return | `decimal` | the number of years | |

Compliance | `mandatory` | This method must be implemented. | |

Method | getMonths | ||

Description |
Gets the number of months. | ||

Return | `decimal` | the number of months | |

Compliance | `mandatory` | This method must be implemented. | |

Method | getWeeks | ||

Description |
Gets the number of weeks. | ||

Return | `decimal` | the number of weeks | |

Compliance | `mandatory` | This method must be implemented. | |

Method | getDays | ||

Description |
Gets the number of days. | ||

Return | `decimal` | the number of days | |

Compliance | `mandatory` | This method must be implemented. | |

Method | getHours | ||

Description |
Gets the number of hours. | ||

Return | `decimal` | the number of hours | |

Compliance | `mandatory` | This method must be implemented. | |

Method | getMinutes | ||

Description |
Gets the number of minutes. | ||

Return | `decimal` | the number of minutes | |

Compliance | `mandatory` | This method must be implemented. | |

Method | getSeconds | ||

Description |
Gets the number of seconds. | ||

Return | `decimal` | the number of seconds | |

Compliance | `mandatory` | This method must be implemented. | |

Method | getMilliseconds | ||

Description |
Gets the number of milliseconds. A millisecond is one thousandth of a second. | ||

Return | `decimal` | the number of milliseconds | |

Compliance | `mandatory` | This method must be implemented. | |

Method | getMicroseconds | ||

Description |
Gets the number of microseconds. A microsecond is one millionth of a second. | ||

Return | `decimal` | the number of micrseconds | |

Compliance | `mandatory` | This method must be implemented. | |

Method | getNanoseconds | ||

Description |
Gets the number of nanoseconds. A nanosecond is one billionth of a second. | ||

Return | `decimal` | the number of nanoseconds | |

Compliance | `mandatory` | This method must be implemented. | |

Method | getPicoseconds | ||

Description |
Gets the number of picoseconds. A picosecond is one trillionth of a second. | ||

Return | `decimal` | the number of picoseconds | |

Compliance | `mandatory` | This method must be implemented. | |

Method | getFemtoseconds | ||

Description |
Gets the number of femtoseconds. A femtosecond is one quadrillionth of a second. | ||

Return | `decimal` | the number of femtoseconds | |

Compliance | `mandatory` | This method must be implemented. | |

Method | getAttoseconds | ||

Description |
Gets the number of attoseconds. An attosecond is one quintillionth of a second. | ||

Return | `decimal` | the number of attoseconds | |

Compliance | `mandatory` | This method must be implemented. | |

Method | getZeptoseconds | ||

Description |
Gets the number of zeptoseconds. A zeptosecond is one sextillionth of a second. | ||

Return | `decimal` | the number of zeptoseconds | |

Compliance | `mandatory` | This method must be implemented. | |

Method | getYoctoseconds | ||

Description |
Gets the number of yoctoseconds. A yoctosecond is one septillionth of a second. This is getting quite small. | ||

Return | `decimal` | the number of yoctoseconds | |

Compliance | `mandatory` | This method must be implemented. | |

Method | getXoxxoseconds | ||

Description |
Gets the number of xoxxoseconds. A xoxxosecond is one octillionth of a second. We're going with Rudy Rucker here. | ||

Return | `decimal` | the number of xoxxoseconds | |

Compliance | `mandatory` | This method must be implemented. | |

Method | getWeebleseconds | ||

Description |
Gets the number of weebleseconds. A weeblesecond is one nonillionth of a second. | ||

Return | `decimal` | the number of weebleseconds | |

Compliance | `mandatory` | This method must be implemented. | |

Method | getVatoseconds | ||

Description |
Gets the number of vatoseconds. A vatosecond is one decillionth of a second. | ||

Return | `decimal` | the number of vatoseconds | |

Compliance | `mandatory` | This method must be implemented. | |

Method | getUndaseconds | ||

Description |
Gets the number of undaseconds. An undasecond is one unadecillionth of a second. | ||

Return | `decimal` | the number of undaseconds | |

Compliance | `mandatory` | This method must be implemented. | |

Method | getPlanckSeconds | ||

Description |
Gets the number of Planck sseconds. A Planck is 10 quattuordecillionths of a second. | ||

Return | `decimal` | the number of planck seconds | |

Compliance | `mandatory` | This method must be implemented. | |

Method | getGranularity | ||

Description |
Gets the granularity of this duration. The granularity indicates the resolution of the clock. More precision than what is specified in this method cannot be inferred from the available data. | ||

Return | `osid.calendaring.DateTimeResolution` | the time units | |

Compliance | `mandatory` | This method must be implemented. | |

Method | getGranularityMultiplier | ||

Description |
If the granularity of the time equals | ||

Return | `cardinal` | granularity multiplier | |

Compliance | `mandatory` | This method must be implemented. | |

Method | definesUncertainty | ||

Description |
Tests if uncertainty is defined for this time. | ||

Return | `boolean` | ` true ` if uncertainty is defined, ` false `
otherwise | |

Compliance | `mandatory` | This method must be implemented. | |

Method | getUncertaintyUnits | ||

Description |
Gets the units of the uncertainty. | ||

Return | `osid.calendaring.DateTimeResolution` | units of the uncertainty | |

Errors | ILLEGAL_STATE | ` definesUncertainty() ` is ` false ` | |

Compliance | `mandatory` | This method must be implemented. | |

Method | getUncertaintyMinus | ||

Description |
Gets the uncertainty of this time in the negative direction. | ||

Return | `cardinal` | the uncertainty under this value | |

Errors | ILLEGAL_STATE | ` definesUncertainty() ` is ` false ` | |

Compliance | `mandatory` | This method must be implemented. | |

Method | getUncertaintyPlus | ||

Description |
Gets the uncertainty of this time in the positive direction. | ||

Return | `cardinal` | the uncertainty over this value | |

Errors | ILLEGAL_STATE | ` definesUncertainty() ` is ` false ` | |

Compliance | `mandatory` | This method must be implemented. |