Interface | osid.OsidEnablerForm | ||
---|---|---|---|
Implements | osid.OsidRuleForm | ||
osid.OsidTemporalForm | |||
Description |
This form is used to create and update enablers. | ||
Method | getScheduleMetadata | ||
Description |
Gets the metadata for an associated schedule. | ||
Return | osid.Metadata | metadata for the schedule | |
Compliance | mandatory | This method must be implemented. | |
Method | setSchedule | ||
Description |
Sets a schedule. | ||
Parameters | osid.id.Id | scheduleId | the new schedule |
Errors | INVALID_ARGUMENT | scheduleId is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | scheduleId is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearSchedule | ||
Description |
Removes the schedule. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getEventMetadata | ||
Description |
Gets the metadata for an associated event. | ||
Return | osid.Metadata | metadata for the event | |
Compliance | mandatory | This method must be implemented. | |
Method | setEvent | ||
Description |
Sets an event. | ||
Parameters | osid.id.Id | eventId | the new event |
Errors | INVALID_ARGUMENT | eventId is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | eventId is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearEvent | ||
Description |
Removes the event. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getCyclicEventMetadata | ||
Description |
Gets the metadata for the cyclic event. | ||
Return | osid.Metadata | metadata for the cyclic event | |
Compliance | mandatory | This method must be implemented. | |
Method | setCyclicEvent | ||
Description |
Sets the cyclic event. | ||
Parameters | osid.id.Id | cyclicEventId | the new cyclic event |
Errors | INVALID_ARGUMENT | cyclicEventId is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | cyclicEventId is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearCyclicEvent | ||
Description |
Removes the cyclic event. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getDemographicMetadata | ||
Description |
Gets the metadata for an associated demographic. | ||
Return | osid.Metadata | metadata for the resource. | |
Compliance | mandatory | This method must be implemented. | |
Method | setDemographic | ||
Description |
Sets a resource demographic. | ||
Parameters | osid.id.Id | resourceId | the new resource |
Errors | INVALID_ARGUMENT | resourceId is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | resourceId is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearDemographic | ||
Description |
Removes the resource demographic. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. |