Interface | osid.calendaring.OffsetEventForm | ||
---|---|---|---|
Implements | osid.OsidRuleForm | ||
Description |
This is the form for creating and updating | ||
Method | getFixedStartTimeMetadata | ||
Description |
Gets the metadata for the fixed start time. | ||
Return | osid.Metadata | metadata for the fixed start time | |
Compliance | mandatory | This method must be implemented. | |
Method | setFixedStartTime | ||
Description |
Sets the fixed start time. | ||
Parameters | osid.calendaring.DateTime | date | the fixed start time |
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 | clearFixedStartTime | ||
Description |
Clears the fixed start time. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getStartReferenceEventMetadata | ||
Description |
Gets the metadata for the starting reference event. | ||
Return | osid.Metadata | metadata for the starting reference event | |
Compliance | mandatory | This method must be implemented. | |
Method | setStartReferenceEvent | ||
Description |
Sets the fixed start time. | ||
Parameters | osid.id.Id | eventId | the start reference event Id |
Errors | INVALID_ARGUMENT | eventId is invalid | |
NO_ACCESS | eventId cannot be modified | ||
NULL_ARGUMENT | eventId is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearStartReferenceEvent | ||
Description |
Clears the start reference event. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getFixedStartOffsetMetadata | ||
Description |
Gets the metadata for the fixed start offset. | ||
Return | osid.Metadata | metadata for the fixed start offset | |
Compliance | mandatory | This method must be implemented. | |
Method | setFixedStartOffset | ||
Description |
Sets the fixed start offset. | ||
Parameters | osid.calendaring.Duration | offset | the fixed offset |
Errors | INVALID_ARGUMENT | offset is invalid | |
NO_ACCESS | offset cannot be modified | ||
NULL_ARGUMENT | offset is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearFixedStartOffset | ||
Description |
Clears the fixed start offset. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getRelativeWeekdayStartOffsetMetadata | ||
Description |
Gets the metadata for the relative weekday offset. | ||
Return | osid.Metadata | metadata for the relative weekday offset | |
Compliance | mandatory | This method must be implemented. | |
Method | setRelativeWeekdayStartOffset | ||
Description |
Sets the relative weekday offset as the nth weekday from the relative event. | ||
Parameters | integer | offset | the week offset |
Errors | INVALID_ARGUMENT | offset is invalid | |
NO_ACCESS | offset cannot be modified | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearRelativeWeekdayStartOffset | ||
Description |
Clears the relative weekday offset. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getRelativeStartWeekdayMetadata | ||
Description |
Gets the metadata for the relative weekday. | ||
Return | osid.Metadata | metadata for the relative weekday | |
Compliance | mandatory | This method must be implemented. | |
Method | setRelativeStartWeekday | ||
Description |
Sets the relative weekday. | ||
Parameters | cardinal | weekday | the weekday |
Errors | INVALID_ARGUMENT | weekday is invalid | |
NO_ACCESS | weekday cannot be modified | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearRelativeStartWeekday | ||
Description |
Clears the relative start weekday. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getFixedDurationMetadata | ||
Description |
Gets the metadata for the fixed duration. | ||
Return | osid.Metadata | metadata for the fixed duration | |
Compliance | mandatory | This method must be implemented. | |
Method | setFixedDuration | ||
Description |
Sets the fixed duration. | ||
Parameters | osid.calendaring.Duration | duration | the fixed duration |
Errors | INVALID_ARGUMENT | duration is invalid | |
NO_ACCESS | duration cannot be modified | ||
NULL_ARGUMENT | duration is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearFixedDuration | ||
Description |
Clears the fixed duration. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getEndReferenceEventMetadata | ||
Description |
Gets the metadata for the ending reference event. | ||
Return | osid.Metadata | metadata for the ending reference event | |
Compliance | mandatory | This method must be implemented. | |
Method | setEndReferenceEvent | ||
Description |
Sets the fixed end time. | ||
Parameters | osid.id.Id | eventId | the end reference event Id |
Errors | INVALID_ARGUMENT | eventId is invalid | |
NO_ACCESS | eventId cannot be modified | ||
NULL_ARGUMENT | eventId is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearEndReferenceEvent | ||
Description |
Clears the ending reference event. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getFixedEndOffsetMetadata | ||
Description |
Gets the metadata for the fixed end offset. | ||
Return | osid.Metadata | metadata for the fixed end offset | |
Compliance | mandatory | This method must be implemented. | |
Method | setFixedEndOffset | ||
Description |
Sets the fixed end offset. | ||
Parameters | osid.calendaring.Duration | offset | the fixed offset |
Errors | INVALID_ARGUMENT | offset is invalid | |
NO_ACCESS | offset cannot be modified | ||
NULL_ARGUMENT | offset is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearFixedEndOffset | ||
Description |
Clears the fixed end offset. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getRelativeWeekdayEndOffsetMetadata | ||
Description |
Gets the metadata for the relative weekday offset. | ||
Return | osid.Metadata | metadata for the relative weekday offset | |
Compliance | mandatory | This method must be implemented. | |
Method | setRelativeWeekdayEndOffset | ||
Description |
Sets the relative weekday offset as the nth weekday from the relative event. | ||
Parameters | integer | offset | the week offset |
Errors | INVALID_ARGUMENT | offset is invalid | |
NO_ACCESS | offset cannot be modified | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearRelativeWeekdayEndOffset | ||
Description |
Clears the relative weekday offset. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getRelativeEndWeekdayMetadata | ||
Description |
Gets the metadata for the relative weekday. | ||
Return | osid.Metadata | metadata for the relative weekday | |
Compliance | mandatory | This method must be implemented. | |
Method | setRelativeEndWeekday | ||
Description |
Sets the relative weekday. | ||
Parameters | cardinal | weekday | the weekday |
Errors | INVALID_ARGUMENT | weekday is invalid | |
NO_ACCESS | weekday cannot be modified | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearRelativeEndWeekday | ||
Description |
Clears the relative end weekday. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getLocationDescriptionMetadata | ||
Description |
Gets the metadata for a location description. | ||
Return | osid.Metadata | metadata for the location description | |
Compliance | mandatory | This method must be implemented. | |
Method | setLocationDescription | ||
Description |
Sets the location description. | ||
Parameters | string | location | the new location description |
Errors | INVALID_ARGUMENT | location is invalid | |
NO_ACCESS | location cannot be modified | ||
NULL_ARGUMENT | location is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearLocationDescription | ||
Description |
Clears the location description. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getLocationMetadata | ||
Description |
Gets the metadata for a location. | ||
Return | osid.Metadata | metadata for the location | |
Compliance | mandatory | This method must be implemented. | |
Method | setLocation | ||
Description |
Sets the location. | ||
Parameters | osid.id.Id | locationId | the new location |
Errors | INVALID_ARGUMENT | locationId is invalid | |
NO_ACCESS | locationId cannot be modified | ||
NULL_ARGUMENT | locationId is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearLocation | ||
Description |
Clears the location. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getSponsorMetadata | ||
Description |
Gets the metadata for a sponsor. | ||
Return | osid.Metadata | metadata for the sponsor | |
Compliance | mandatory | This method must be implemented. | |
Method | setSponsors | ||
Description |
Sets the sponsors. | ||
Parameters | osid.id.Id[] | sponsorIds | the new sponsor |
Errors | INVALID_ARGUMENT | sponsorIds is invalid | |
NO_ACCESS | sponsorIds cannot be modified | ||
NULL_ARGUMENT | sponsorIds is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearSponsors | ||
Description |
Clears the sponsors. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getOffsetEventFormRecord | ||
Description |
Gets the | ||
Parameters | osid.type.Type | offsetEventRecordType | the offset event record type |
Return | osid.calendaring.records.OffsetEventFormRecord | the offset event form 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. |