Interface | osid.calendaring.ScheduleForm | ||
---|---|---|---|
Implements | osid.OsidObjectForm | ||
Description |
This is the form for creating and updating | ||
Method | getScheduleSlotMetadata | ||
Description |
Gets the metadata for the schedule slot. | ||
Return | osid.Metadata | metadata for the schedule slot | |
Compliance | mandatory | This method must be implemented. | |
Method | setScheduleSlot | ||
Description |
Sets the schedule slot. | ||
Parameters | osid.id.Id | scheduleSlotId | the new schedule slot Id |
Errors | INVALID_ARGUMENT | scheduleSlotId is invalid | |
NO_ACCESS | scheduleSlotId cannot be modified | ||
NULL_ARGUMENT | scheduleSlotId is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearScheduleSlot | ||
Description |
Clears the schedule slot. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getTimePeriodMetadata | ||
Description |
Gets the metadata for the time period. | ||
Return | osid.Metadata | metadata for the time period | |
Compliance | mandatory | This method must be implemented. | |
Method | setTimePeriod | ||
Description |
Sets the time period. | ||
Parameters | osid.id.Id | timePeriodId | the new time period Id |
Errors | INVALID_ARGUMENT | timePeriodId is invalid | |
NO_ACCESS | timePeriodId cannot be modified | ||
NULL_ARGUMENT | timePeriodId is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearTimePeriod | ||
Description |
Clears the time period. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getScheduleStartMetadata | ||
Description |
Gets the metadata for the schedule start date. | ||
Return | osid.Metadata | metadata for the schedule start | |
Compliance | mandatory | This method must be implemented. | |
Method | setScheduleStart | ||
Description |
Sets the schedule start date. This may be set in lieu of a time period to set a specific date range. | ||
Parameters | osid.calendaring.DateTime | start | the new start date |
Errors | INVALID_ARGUMENT | start is invalid | |
NO_ACCESS | start cannot be modified | ||
NULL_ARGUMENT | start is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearScheduleStart | ||
Description |
Clears the schedule start. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getScheduleEndMetadata | ||
Description |
Gets the metadata for the schedule end date. | ||
Return | osid.Metadata | metadata for the schedule end | |
Compliance | mandatory | This method must be implemented. | |
Method | setScheduleEnd | ||
Description |
Sets the schedule end date. This may be set in lieu of a time period to set a specific date range. | ||
Parameters | osid.calendaring.DateTime | start | the new end date |
Errors | INVALID_ARGUMENT | end is invalid | |
NO_ACCESS | end cannot be modified | ||
NULL_ARGUMENT | end is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearScheduleEnd | ||
Description |
Clears the schedule end. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getLimitMetadata | ||
Description |
Gets the metadata for the recurrence limit. | ||
Return | osid.Metadata | metadata for the limit | |
Compliance | mandatory | This method must be implemented. | |
Method | setLimit | ||
Description |
Sets the limit on the recurrences of a schedule. | ||
Parameters | cardinal | limit | the new limit |
Errors | INVALID_ARGUMENT | limit is invalid | |
NO_ACCESS | limit cannot be modified | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearLimit | ||
Description |
Clears the limit. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
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 | getScheduleFormRecord | ||
Description |
Gets the | ||
Parameters | osid.type.Type | scheduleRecordType | the schedule record type |
Return | osid.calendaring.records.ScheduleFormRecord | the schedule form record | |
Errors | NULL_ARGUMENT | scheduleRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(scheduleRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |