OSID Logo
OSID Specifications
offering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.ParticipantSmartCatalogueSession
Implementsosid.OsidSession
Description

This session manages queries and sequencing to create "smart" dynamic catalogs. A ParticipantQuery can be retrieved from this session and mapped to this Catalogue to create a virtual collection of Participants. The participants may be sequenced using the ParticipantSearchOrder from this session.

This Catalogue has a default query that matches any participant and a default search order that specifies no sequencing. The queries may be examined using a ParticipantQueryInspector. The query may be modified by converting the inspector back to a ParticipantQuery.

MethodgetCatalogueId
Description

Gets the Catalogue Id associated with this session.

Returnosid.id.Idthe Catalogue Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCatalogue
Description

Gets the Catalogue associated with this session.

Returnosid.offering.Cataloguethe Catalogue associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageSmartCatalogues
Description

Tests if this user can manage smart catalogues. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.

Returnboolean false if smart catalogue management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetParticipantQuery
Description

Gets a participant query.

Returnosid.offering.ParticipantQuerythe participant query
CompliancemandatoryThis method must be implemented.
MethodgetParticipantSearchOrder
Description

Gets a participant search order.

Returnosid.offering.ParticipantSearchOrderthe participant search order
CompliancemandatoryThis method must be implemented.
MethodapplyParticipantQuery
Description

Applies a participant query to this catalogue.

Parametersosid.offering.ParticipantQueryparticipantQuerythe participant query
ErrorsNULL_ARGUMENT participantQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED participantQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectParticipantQuery
Description

Gets a participant query inspector for this catalogue.

Returnosid.offering.ParticipantQueryInspectorthe participant query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyParticipantSequencing
Description

Applies a participant search order to this catalogue.

Parametersosid.offering.ParticipantSearchOrderparticipantSearchOrderthe participant search order
ErrorsNULL_ARGUMENT participantSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED participantSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetParticipantQueryFromInspector
Description

Gets a participant query from an inspector.

Parametersosid.offering.ParticipantQueryInspectorparticipantQueryInspectora query inspector
Returnosid.offering.ParticipantQuerythe participant query
ErrorsNULL_ARGUMENT participantQueryInspector is null
UNSUPPORTED participantQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.