OSID Logo
OSID Specifications
inquiry package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inquiry.InquestLookupSession
Implementsosid.OsidSession
Description

This session provides methods for retrieving Inquest objects.

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

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. For example, a browsing application may only need to examine the Inquests it can access, without breaking execution. However, an assessment may only be useful if all Inquests referenced by it are available, and a test-taking application may sacrifice some interoperability for the sake of precision.

MethodcanLookupInquests
Description

Tests if this user can perform Inquest 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 opt not to offer lookup operations to unauthorized users.

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

A complete view of the Inquest 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.
MethodgetInquest
Description

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

Parametersosid.id.IdinquestId Id of the Inquest
Returnosid.inquiry.Inquestthe inquest
ErrorsNOT_FOUND inquestId not found
NULL_ARGUMENT inquestId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetInquestsByIds
Description

Gets an InquestList corresponding to the given IdList. In plenary mode, the returned list contains all of the inquests 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 Inquests may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListinquestIdsthe list of Ids to retrieve
Returnosid.inquiry.InquestListthe returned Inquest list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT inquestIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetInquestsByGenusType
Description

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

Parametersosid.type.TypeinquestGenusTypean inquest genus type
Returnosid.inquiry.InquestListthe returned Inquest list
ErrorsNULL_ARGUMENT inquestGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetInquestsByParentGenusType
Description

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

Parametersosid.type.TypeinquestGenusTypean inquest genus type
Returnosid.inquiry.InquestListthe returned Inquest list
ErrorsNULL_ARGUMENT inquestGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetInquestsByRecordType
Description

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

Parametersosid.type.TypeinquestRecordTypean inquest record type
Returnosid.inquiry.InquestListthe returned Inquest list
ErrorsNULL_ARGUMENT inquestRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetInquestsByProvider
Description

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

Parametersosid.id.IdresourceIda resource Id
Returnosid.inquiry.InquestListthe returned Inquest list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetInquests
Description

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

Returnosid.inquiry.InquestLista list of Inquests
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.