OSID Logo
OSID Specifications
personnel package
Version 3.0.0
Release Candidate Preview
Interfaceosid.personnel.PositionSmartRealmSession
Implementsosid.OsidSession
Description

This session manages queries and sequencing to create "smart" dynamic catalogs. A PositionQuery can be retrieved from this session and mapped to this Realm to create a virtual collection of Positions. The positions may be sequenced using the PositionSearchOrder from this session.

This Realm has a default query that matches any position and a default search order that specifies no sequencing. The queries may be examined using a PositionQueryInspector. The query may be modified by converting the inspector back to a PositionQuery.

MethodgetRealmId
Description

Gets the Realm Id associated with this session.

Returnosid.id.Idthe Realm Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetRealm
Description

Gets the Realm associated with this session.

Returnosid.personnel.Realmthe Realm associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageSmartRealms
Description

Tests if this user can manage smart realms. 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 realm management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetPositionQuery
Description

Gets a position query.

Returnosid.personnel.PositionQuerythe position query
CompliancemandatoryThis method must be implemented.
MethodgetPositionSearchOrder
Description

Gets a position search order.

Returnosid.personnel.PositionSearchOrderthe position search order
CompliancemandatoryThis method must be implemented.
MethodapplyPositionQuery
Description

Applies a position query to this realm.

Parametersosid.personnel.PositionQuerypositionQuerythe position query
ErrorsNULL_ARGUMENT positionQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED positionQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectPositionQuery
Description

Gets a position query inspector for this realm.

Returnosid.personnel.PositionQueryInspectorthe position query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyPositionSequencing
Description

Applies a position search order to this realm.

Parametersosid.personnel.PositionSearchOrderpositionSearchOrderthe position search order
ErrorsNULL_ARGUMENT positionSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED positionSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetPositionQueryFromInspector
Description

Gets a position query from an inspector.

Parametersosid.personnel.PositionQueryInspectorpositionQueryInspectora query inspector
Returnosid.personnel.PositionQuerythe position query
ErrorsNULL_ARGUMENT positionQueryInspector is null
UNSUPPORTED positionQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.