Interface | osid.calendaring.SupersedingEventForm | ||
---|---|---|---|
Implements | osid.OsidRuleForm | ||
Description |
This is the form for creating and updating | ||
Method | getSupersededDateMetadata | ||
Description |
Gets the metadata to superseding an event within a recurring series by date. | ||
Return | osid.Metadata | metadata for a superseded date | |
Compliance | mandatory | This method must be implemented. | |
Method | setSupersededDate | ||
Description |
Sets the superseded date. | ||
Parameters | osid.calendaring.DateTime | date | the new superseded date |
Errors | INVALID_ARGUMENT | date is invalid | |
NO_ACCESS | date cannot be modified | ||
NULL_ARGUMENT | date is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearSupersededDate | ||
Description |
Clears the superseded date. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getSupersededEventPositionMetadata | ||
Description |
Gets the metadata to superseding an event within a recurring series by date. | ||
Return | osid.Metadata | metadata for a superseded date | |
Compliance | mandatory | This method must be implemented. | |
Method | setSupersededEventPosition | ||
Description |
Sets the superseded position. A negative number counts from the end of the series. | ||
Parameters | integer | position | the new superseded position |
Errors | INVALID_ARGUMENT | position is invalid | |
NO_ACCESS | position cannot be modified | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearSupersededEventPosition | ||
Description |
Clears the superseded position. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getSupersedingEventFormRecord | ||
Description |
Gets the | ||
Parameters | osid.type.Type | supersedingEventRecordType | the superseding event record type |
Return | osid.calendaring.records.SupersedingEventFormRecord | the superseding event form record | |
Errors | NULL_ARGUMENT | supersedingEventRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(supersedingEventRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |