OSID Logo
OSID Specifications
rules check package
Version 3.0.0
Release Candidate Preview
Interfaceosid.rules.check.AgendaLookupSession
Implementsosid.OsidSession
Description

This session provides methods for retrieving Agenda 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
  • isolated engine view: All agenda methods in this session operate, retrieve and pertain to agendas defined explicitly in the current engine. Using an isolated view is useful for managing Agendas with the AgendaAdminSession.
  • federated engine view: All agenda methods in this session operate, retrieve and pertain to all agendas defined in this engine and any other agendas implicitly available in this engine through engine inheritence.

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 useFederatedEngineView() and useIsolatedEngineView() behave as a radio group and one should be selected before invoking any lookup methods.

MethodgetEngineId
Description

Gets the Engine Id associated with this session.

Returnosid.id.Idthe Engine Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetEngine
Description

Gets the Engine associated with this session.

Returnosid.rules.Enginethe engine
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupAgendas
Description

Tests if this user can perform Agenda 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.
MethoduseComparativeAgendaView
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.
MethodusePlenaryAgendaView
Description

A complete view of the Agenda 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.
MethoduseFederatedEngineView
Description

Federates the view for methods in this session. A federated view will include agendas in engines which are children of this engine in the engine hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedEngineView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this engine only.

CompliancemandatoryThis method is must be implemented.
MethodgetAgenda
Description

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

Parametersosid.id.IdagendaId Id of the Agenda
Returnosid.rules.check.Agendathe agenda
ErrorsNOT_FOUND agendaId not found
NULL_ARGUMENT agendaId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetAgendasByIds
Description

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

Parametersosid.id.IdListagendaIdsthe list of Ids to retrieve
Returnosid.rules.check.AgendaListthe returned Agenda list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT agendaIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAgendasByGenusType
Description

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

Parametersosid.type.TypeagendaGenusTypean agenda genus type
Returnosid.rules.check.AgendaListthe returned Agenda list
ErrorsNULL_ARGUMENT agendaGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAgendasByParentGenusType
Description

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

Parametersosid.type.TypeagendaGenusTypean agenda genus type
Returnosid.rules.check.AgendaListthe returned Agenda list
ErrorsNULL_ARGUMENT agendaGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAgendasByRecordType
Description

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

Parametersosid.type.TypeagendaRecordTypean agenda record type
Returnosid.rules.check.AgendaListthe returned Agenda list
ErrorsNULL_ARGUMENT agendaRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAgendas
Description

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

Returnosid.rules.check.AgendaLista list of Agendas
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.