Interface | osid.OsidEnabler | ||
---|---|---|---|
Implements | osid.OsidRule | ||
osid.Temporal | |||
Description |
The managed
In the case where an For example, An An | ||
Method | isEffectiveBySchedule | ||
Description |
Tests if the effectiveness of the enabler is governed
by a | ||
Return | boolean | true if the enabler is governed by schedule, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getScheduleId | ||
Description |
Gets the schedule | ||
Return | osid.id.Id | the schedule Id | |
Errors | ILLEGAL_STATE | isEffectiveBySchedule() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getSchedule | ||
Description |
Gets the schedule. | ||
Return | osid.calendaring.Schedule | the schedule | |
Errors | ILLEGAL_STATE | isEffectiveBySchedule() is false | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | isEffectiveByEvent | ||
Description |
Tests if the effectiveness of the enabler is governed
by an | ||
Return | boolean | true if the enabler is governed by an event, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getEventId | ||
Description |
Gets the event | ||
Return | osid.id.Id | the event Id | |
Errors | ILLEGAL_STATE | isEffectiveByEvent() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getEvent | ||
Description |
Gets the event. | ||
Return | osid.calendaring.Event | the event | |
Errors | ILLEGAL_STATE | isEffectiveByEvent() is false | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | isEffectiveByCyclicEvent | ||
Description |
Tests if the effectiveness of the enabler is governed
by a | ||
Return | boolean | true if the enabler is governed by a cyclic event,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCyclicEventId | ||
Description |
Gets the cyclic event | ||
Return | osid.id.Id | the cyclic event Id | |
Errors | ILLEGAL_STATE | isEffectiveByCyclicEvent() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getCyclicEvent | ||
Description |
Gets the cyclic event. | ||
Return | osid.calendaring.cycle.CyclicEvent | the cyclic event | |
Errors | ILLEGAL_STATE | isEffectiveByCyclicEvent() is false | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | isEffectiveForDemographic | ||
Description |
Tests if the effectiveness of the enabler applies to a demographic resource. | ||
Return | boolean | true if the rule apples to a demographic. false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getDemographicId | ||
Description |
Gets the demographic resource | ||
Return | osid.id.Id | the resource Id | |
Errors | ILLEGAL_STATE | isEffectiveForDemographic() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | getDemographic | ||
Description |
Gets the demographic resource. | ||
Return | osid.resource.Resource | the resource representing the demographic | |
Errors | ILLEGAL_STATE | isEffectiveForDemographic() is false | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. |