Interface | osid.checklist.ChecklistLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
| ||
Method | canLookupChecklists | ||
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 | useComparativeChecklistView | ||
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 | usePlenaryChecklistView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getChecklist | ||
Description |
Gets the | ||
Parameters | osid.id.Id | checklistId | Id of the Checklist |
Return | osid.checklist.Checklist | the checklist | |
Errors | NOT_FOUND | checklistId not found | |
NULL_ARGUMENT | checklistId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getChecklistsByIds | ||
Description |
Gets a | ||
Parameters | osid.id.IdList | checklistIds | the list of Ids to retrieve |
Return | osid.checklist.ChecklistList | the returned Checklist list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | checklistIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getChecklistsByGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | checklistGenusType | a checklist genus type |
Return | osid.checklist.ChecklistList | the returned Checklist list | |
Errors | NULL_ARGUMENT | checklistGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getChecklistsByParentGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | checklistGenusType | a checklist genus type |
Return | osid.checklist.ChecklistList | the returned Checklist list | |
Errors | NULL_ARGUMENT | checklistGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getChecklistsByRecordType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | checklistRecordType | a checklist record type |
Return | osid.checklist.ChecklistList | the returned Checklist list | |
Errors | NULL_ARGUMENT | checklistRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getChecklistsByProvider | ||
Description |
Gets a | ||
Parameters | osid.id.Id | resourceId | a provider Id |
Return | osid.checklist.ChecklistList | the returned Checklist list | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getChecklists | ||
Description |
Gets all | ||
Return | osid.checklist.ChecklistList | a list of Checklists | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |