Interface | osid.calendaring.Event | ||
---|---|---|---|
Implements | osid.OsidObject | ||
osid.Temporal | |||
osid.Containable | |||
Description |
An | ||
Method | isImplicit | ||
Description |
Tests if this event is implicit. An implicit event is one that is generated from an offset or recurring series. | ||
Return | boolean | true if this event is implicit, false if
explicitly defined | |
Compliance | mandatory | This method must be implemented. | |
Method | isInRecurringSeries | ||
Description |
Tests if this event is an implclit event part of a
recurring event. If true, | ||
Return | boolean | true if this event is part of a recurring series,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | isSupersedingEvent | ||
Description |
Tests if this event is a superseding event. If true,
| ||
Return | boolean | true if this event is superseding event, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | isOffsetEvent | ||
Description |
Tests if this event is an event calculated from an
offset. If true, | ||
Return | boolean | true if this event is an offset event, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getDuration | ||
Description |
Gets the duration of the event. | ||
Parameters | osid.calendaring.DateTimeResolution | units | the units of the duration |
Return | osid.calendaring.Duration | the duration | |
Errors | NULL_ARGUMENT | units is null | |
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 | getEventRecord | ||
Description |
Gets the event record corresponding to the given | ||
Parameters | osid.type.Type | eventRecordType | the type of the record to retrieve |
Return | osid.calendaring.records.EventRecord | the event record | |
Errors | NULL_ARGUMENT | eventRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(eventRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |