OSID Logo
OSID Specifications
checklist package
Version 3.0.0
Release Candidate Preview
Interfaceosid.checklist.ChecklistLookupSession
Implementsosid.OsidSession
Description

This session provides methods for retrieving Checklist objects. The Checklist represents a collection of todos.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
MethodcanLookupChecklists
Description

Tests if this user can perform Checklist lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeChecklistView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryChecklistView
Description

A complete view of the Checklist returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethodgetChecklist
Description

Gets the Checklist specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Checklist may have a different Id than requested, such as the case where a duplicate Id was assigned to a Checklist and retained for compatibility.

Parametersosid.id.IdchecklistId Id of the Checklist
Returnosid.checklist.Checklistthe checklist
ErrorsNOT_FOUND checklistId not found
NULL_ARGUMENT checklistId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetChecklistsByIds
Description

Gets a ChecklistList corresponding to the given IdList. In plenary mode, the returned list contains all of the checklists specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Checklists may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListchecklistIdsthe list of Ids to retrieve
Returnosid.checklist.ChecklistListthe returned Checklist list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT checklistIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetChecklistsByGenusType
Description

Gets a ChecklistList corresponding to the given checklist genus Type which does not include checklists of genus types derived from the specified Type. In plenary mode, the returned list contains all known checklists or an error results. Otherwise, the returned list may contain only those checklists that are accessible through this session.

Parametersosid.type.TypechecklistGenusTypea checklist genus type
Returnosid.checklist.ChecklistListthe returned Checklist list
ErrorsNULL_ARGUMENT checklistGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetChecklistsByParentGenusType
Description

Gets a ChecklistList corresponding to the given checklist genus Type and include any additional checklists with genus types derived from the specified Type. In plenary mode, the returned list contains all known checklists or an error results. Otherwise, the returned list may contain only those checklists that are accessible through this session.

Parametersosid.type.TypechecklistGenusTypea checklist genus type
Returnosid.checklist.ChecklistListthe returned Checklist list
ErrorsNULL_ARGUMENT checklistGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetChecklistsByRecordType
Description

Gets a ChecklistList containing the given checklist record Type. In plenary mode, the returned list contains all known checklists or an error results. Otherwise, the returned list may contain only those checklists that are accessible through this session.

Parametersosid.type.TypechecklistRecordTypea checklist record type
Returnosid.checklist.ChecklistListthe returned Checklist list
ErrorsNULL_ARGUMENT checklistRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetChecklistsByProvider
Description

Gets a ChecklistList from the given provider. In plenary mode, the returned list contains all known checklists or an error results. Otherwise, the returned list may contain only those checklists that are accessible through this session.

Parametersosid.id.IdresourceIda provider Id
Returnosid.checklist.ChecklistListthe returned Checklist list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetChecklists
Description

Gets all Checklists. In plenary mode, the returned list contains all known checklists or an error results. Otherwise, the returned list may contain only those checklists that are accessible through this session.

Returnosid.checklist.ChecklistLista list of Checklists
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.