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

This session provides methods for querying Position objects. The search query is constructed using the PositionQuery.

This session defines views that offer differing behaviors for searching.

  • federated realm view: searches include positions in realms of which this realm is a ancestor in the realm hierarchy
  • isolated realm view: searches are restricted to positions in this realm

Positions may have a query record indicated by their respective record types. The query record is accessed via the PositionQuery. The returns in this session may not be cast directly to these interfaces.

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
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchPositions
Description

Tests if this user can perform Position searches. 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 wish not to offer search operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedRealmView
Description

Federates the view for methods in this session. A federated view will include positions in realms which are children of this realm in the realm hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedRealmView
Description

Isolates the view for methods in this session. An isolated view restricts searches to this realm only.

CompliancemandatoryThis method is must be implemented.
MethodgetPositionQuery
Description

Gets a position query.

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

Gets a list of positions matching the given position query.

Parametersosid.personnel.PositionQuerypositionQuerythe position query
Returnosid.personnel.PositionListthe returned PositionList
ErrorsNULL_ARGUMENT positionQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED positionQuery is not of this service
CompliancemandatoryThis method must be implemented.