Interface | osid.calendaring.rules.OffsetEventEnablerLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
Generally, the comparative view should be used for most
applications as it permits operation even if there is data
that cannot be accessed. The methods | ||
Method | getCalendarId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Calendar Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCalendar | ||
Description |
Gets the | ||
Return | osid.calendaring.Calendar | the calendar | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupOffsetEventEnablers | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeOffsetEventEnablerView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryOffsetEventEnablerView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedCalendarView | ||
Description |
Federates the view for methods in this session. A federated view will include offset event enablers in calendars which are children of this calendar in the calendar hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedCalendarView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this calendar only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useActiveOffsetEventEnablerView | ||
Description |
Only active offset event enablers are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyStatusOffsetEventEnablerView | ||
Description |
All active and inactive offset event enablers are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getOffsetEventEnabler | ||
Description |
Gets the In active mode, offset event enablers are returned that are currently active. In any status mode, active and inactive offset event enablers are returned. | ||
Parameters | osid.id.Id | offsetEventEnablerId | Id of the OffsetEventEnabler |
Return | osid.calendaring.rules.OffsetEventEnabler | the offset event enabler | |
Errors | NOT_FOUND | offsetEventEnablerId not found | |
NULL_ARGUMENT | offsetEventEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getOffsetEventEnablersByIds | ||
Description |
Gets an In active mode, offset event enablers are returned that are currently active. In any status mode, active and inactive offset event enablers are returned. | ||
Parameters | osid.id.IdList | offsetEventEnablerIds | the list of Ids to retrieve |
Return | osid.calendaring.rules.OffsetEventEnablerList | the returned OffsetEventEnabler list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | offsetEventEnablerIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOffsetEventEnablersByGenusType | ||
Description |
Gets an In active mode, offset event enablers are returned that are currently active. In any status mode, active and inactive offset event enablers are returned. | ||
Parameters | osid.type.Type | offsetEventEnablerGenusType | an offset event enabler genus type |
Return | osid.calendaring.rules.OffsetEventEnablerList | the returned OffsetEventEnabler list | |
Errors | NULL_ARGUMENT | offsetEventEnablerGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOffsetEventEnablersByParentGenusType | ||
Description |
Gets an In active mode, offset event enablers are returned that are currently active. In any status mode, active and inactive offset event enablers are returned. | ||
Parameters | osid.type.Type | offsetEventEnablerGenusType | an offset event enabler genus type |
Return | osid.calendaring.rules.OffsetEventEnablerList | the returned OffsetEventEnabler list | |
Errors | NULL_ARGUMENT | offsetEventEnablerGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOffsetEventEnablersByRecordType | ||
Description |
Gets an In active mode, offset event enablers are returned that are currently active. In any status mode, active and inactive offset event enablers are returned. | ||
Parameters | osid.type.Type | offsetEventEnablerRecordType | an offset event enabler record type |
Return | osid.calendaring.rules.OffsetEventEnablerList | the returned OffsetEventEnabler list | |
Errors | NULL_ARGUMENT | ofsetEventEnablerRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOffsetEventEnablersOnDate | ||
Description |
Gets an In active mode, offset event enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive offset event enablers are returned. | ||
Parameters | osid.calendaring.DateTime | from | a start date |
osid.calendaring.DateTime | to | an end date | |
Return | osid.calendaring.rules.OffsetEventEnablerList | the returned OffsetEventEnabler list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOffsetEventEnablersOnDateWithAgent | ||
Description |
Gets an In active mode, offset event enablers are returned that are currently active. In any status mode, active and inactive offset event enablers are returned. | ||
Parameters | osid.id.Id | agentId | an agent Id |
osid.calendaring.DateTime | from | a start date | |
osid.calendaring.DateTime | to | an end date | |
Return | osid.calendaring.rules.OffsetEventEnablerList | the returned OffsetEventEnabler list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | agent, from, or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOffsetEventEnablers | ||
Description |
Gets all In plenary mode, the returned list contains all known offset event enablers or an error results. Otherwise, the returned list may contain only those offset event enablers that are accessible through this session. In active mode, offset event enablers are returned that are currently active. In any status mode, active and inactive offset event enablers are returned. | ||
Return | osid.calendaring.rules.OffsetEventEnablerList | the returned OffsetEventEnabler list | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |