Interface | osid.calendaring.OffsetEvent | ||
---|---|---|---|
Implements | osid.OsidRule | ||
Description |
An Creating an | ||
Method | hasFixedStartTime | ||
Description |
Tests if this offset event is based on a fixed start time. | ||
Return | boolean | true if this offset is based on a fixed start time,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getFixedStartTime | ||
Description |
Gets the fixed start time for this event. | ||
Return | osid.calendaring.DateTime | the fixed start time | |
Errors | ILLEGAL_STATE | hasFixedStartIme() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getStartReferenceEventId | ||
Description |
Gets the | ||
Return | osid.id.Id | the relative event Id | |
Errors | ILLEGAL_STATE | hasFixedStartTime() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getStartReferenceEvent | ||
Description |
Gets the | ||
Return | osid.calendaring.Event | the relative event | |
Errors | ILLEGAL_STATE | hasFixedStartTime() is true | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | hasFixedStartOffset | ||
Description |
Tests if this offset start time based on a fixed period of time. | ||
Return | boolean | true if this offset is based on a fixed period of time,
false otherwise | |
Errors | ILLEGAL_STATE | hasFixedStartTime() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getFixedStartOffset | ||
Description |
Gets the fixed starting time offset. | ||
Return | osid.calendaring.Duration | the offset | |
Errors | ILLEGAL_STATE | hasFixedStartOffset() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | hasRelativeWeekdayStartOffset | ||
Description |
Tests if this starting time offset is a based on a relative weekday. | ||
Return | boolean | true if this offset is based on a relative weekday,
false otherwise | |
Errors | ILLEGAL_STATE | hasFixedStartOffset() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getRelativeWeekdayStartOffset | ||
Description |
Gets the starting offset as the nth weekday from the relative event. Zero is no offset. | ||
Return | integer | the offset | |
Errors | ILLEGAL_STATE | hasRelativeWeekdayStartOffset() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getRelativeStartWeekday | ||
Description |
Gets the starting weekday number. The weekday is based on the calendar type. On the Gregorian calendar, 0 is Sunday. | ||
Return | cardinal | the weekday number | |
Errors | ILLEGAL_STATE | hasRelativeWeekdayStartOffset() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | hasFixedDuration | ||
Description |
Tests if this offset event is based on a fixed duration. | ||
Return | boolean | true if this offset is based on a fixed duration,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getFixedDuration | ||
Description |
Gets the duration of the offset event. | ||
Parameters | osid.calendaring.DateTimeResolution | units | the units of the duration |
Return | osid.calendaring.Duration | the duration | |
Errors | ILLEGAL_STATE | hasFixedDuration() is false | |
NULL_ARGUMENT | units is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEndReferenceEventId | ||
Description |
Gets the | ||
Return | osid.id.Id | the relative event Id | |
Errors | ILLEGAL_STATE | hasFixedDuration() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getEndReferenceEvent | ||
Description |
Gets the | ||
Return | osid.calendaring.Event | the relative event | |
Errors | ILLEGAL_STATE | hasFixedDuration() is true | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | hasFixedEndOffset | ||
Description |
Tests if this offset end time based on a fixed period of time. | ||
Return | boolean | true if this offset is based on a fixed period of time,
false otherwise | |
Errors | ILLEGAL_STATE | hasFixedDuration() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getFixedEndOffset | ||
Description |
Gets the fixed ending time offset. | ||
Return | osid.calendaring.Duration | the offset | |
Errors | ILLEGAL_STATE | hasFixedEndOffset() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | hasRelativeWeekdayEndOffset | ||
Description |
Tests if this ending time offset is a based on a relative weekday. | ||
Return | boolean | true if this offset is based on a relative weekday,
false otherwise | |
Errors | ILLEGAL_STATE | hasFixedEndOffset() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getRelativeWeekdayEndOffset | ||
Description |
Gets the ending offset as the nth weekday from the relative event. Zero is no offset. | ||
Return | integer | the offset | |
Errors | ILLEGAL_STATE | hasRelativeWeekdayEndOffset() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getRelativeEndWeekday | ||
Description |
Gets the ending weekday number. The weekday is based on the calendar type. On the Gregorian calendar, 0 is Sunday. | ||
Return | cardinal | the weekday number | |
Errors | ILLEGAL_STATE | hasRelativeWeekdayEndOffset() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getLocationDescription | ||
Description |
Gets a descriptive location. | ||
Return | osid.locale.DisplayText | the location | |
Compliance | mandatory | This method must be implemented. | |
Method | hasLocation | ||
Description |
Tests if a location is associated with this event. | ||
Return | boolean | true if there is an associated location, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getLocationId | ||
Description |
Gets the location | ||
Return | osid.id.Id | a location Id | |
Errors | ILLEGAL_STATE | hasLocation() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getLocation | ||
Description |
Gets the | ||
Return | osid.mapping.Location | a location | |
Errors | ILLEGAL_STATE | hasLocation() is false | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | hasSponsors | ||
Description |
Tests if a sponsor is associated with this event. | ||
Return | boolean | true if there is an associated sponsor. false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getSponsorIds | ||
Description |
Gets the | ||
Return | osid.id.IdList | the sponsor Ids | |
Errors | ILLEGAL_STATE | hasSponsors() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getSponsors | ||
Description |
Gets the | ||
Return | osid.resource.ResourceList | the sponsors | |
Errors | ILLEGAL_STATE | hasSponsors() is false | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOffsetEventRecord | ||
Description |
Gets the offset event record corresponding to the given
| ||
Parameters | osid.type.Type | offsetEventRecordType | the type of the record to retrieve |
Return | osid.calendaring.records.OffsetEventRecord | the offset event record | |
Errors | NULL_ARGUMENT | offsetEventRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(offsetEventRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |