Interface | osid.calendaring.rules.CommitmentEnablerLookupSession | ||
---|---|---|---|
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 | canLookupCommitmentEnablers | ||
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 | useComparativeCommitmentEnablerView | ||
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 | usePlenaryCommitmentEnablerView | ||
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 commitment 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 | useActiveCommitmentEnablerView | ||
Description |
Only active commitment enablers are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyStatusCommitmentEnablerView | ||
Description |
All active and inactive commitment enablers are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getCommitmentEnabler | ||
Description |
Gets the In active mode, commitment enablers are returned that are currently active. In any status mode, active and inactive commitment enablers are returned. | ||
Parameters | osid.id.Id | commitmentEnablerId | Id of the CommitmentEnabler |
Return | osid.calendaring.rules.CommitmentEnabler | the commitment enabler | |
Errors | NOT_FOUND | commitmentEnablerId not found | |
NULL_ARGUMENT | commitmentEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getCommitmentEnablersByIds | ||
Description |
Gets a In active mode, commitment enablers are returned that are currently active. In any status mode, active and inactive commitment enablers are returned. | ||
Parameters | osid.id.IdList | commitmentEnablerIds | the list of Ids to retrieve |
Return | osid.calendaring.rules.CommitmentEnablerList | the returned CommitmentEnabler list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | commitmentEnablerIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommitmentEnablersByGenusType | ||
Description |
Gets a In active mode, commitment enablers are returned that are currently active. In any status mode, active and inactive commitment enablers are returned. | ||
Parameters | osid.type.Type | commitmentEnablerGenusType | a commitment enabler genus type |
Return | osid.calendaring.rules.CommitmentEnablerList | the returned CommitmentEnabler list | |
Errors | NULL_ARGUMENT | commitmentEnablerGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommitmentEnablersByParentGenusType | ||
Description |
Gets a In active mode, commitment enablers are returned that are currently active. In any status mode, active and inactive commitment enablers are returned. | ||
Parameters | osid.type.Type | commitmentEnablerGenusType | a commitment enabler genus type |
Return | osid.calendaring.rules.CommitmentEnablerList | the returned CommitmentEnabler list | |
Errors | NULL_ARGUMENT | commitmentEnablerGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommitmentEnablersByRecordType | ||
Description |
Gets a In effective mode, commitments are returned that are currently effective. In any effective mode, effective commitments and those currently expired are returned. | ||
Parameters | osid.type.Type | commitmentEnablerRecordType | a commitment enabler record type |
Return | osid.calendaring.rules.CommitmentEnablerList | the returned CommitmentEnabler list | |
Errors | NULL_ARGUMENT | commitmentEnablerRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommitmentEnablersOnDate | ||
Description |
Gets a In active mode, commitment enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive commitment enablers are returned. | ||
Parameters | osid.calendaring.DateTime | from | a start date |
osid.calendaring.DateTime | to | an end date | |
Return | osid.calendaring.rules.CommitmentEnablerList | the returned CommitmentEnabler 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 | getCommitmentEnablersOnDateWithAgent | ||
Description |
Gets a In active mode, commitment enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive commitment 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.CommitmentEnablerList | the returned CommitmentEnabler 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 | getCommitmentEnablers | ||
Description |
Gets all In plenary mode, the returned list contains all known commitment enablers or an error results. Otherwise, the returned list may contain only those commitment enablers that are accessible through this session. In active mode, commitment enablers are returned that are currently active. In any status mode, active and inactive commitment enablers are returned. | ||
Return | osid.calendaring.rules.CommitmentEnablerList | the returned CommitmentEnabler list | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |