OSID Logo
OSID Specifications
resourcing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.CommissionQuerySession
Implementsosid.OsidSession
Description

This session provides methods for searching among Commission objects. The search query is constructed using the CommissionQuery.

This session defines views that offer differing behaviors for searching.

  • federated foundry view: searches include commissions in foundries of which this foundry is an ancestor in the foundry hierarchy
  • isolated foundry view: searches are restricted to commissions in this foundry

Commissions may have a query record indicated by their respective record types. The query record is accessed via the CommissionQuery.

MethodgetFoundryId
Description

Gets the Foundry Id associated with this session.

Returnosid.id.Idthe Foundry Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetFoundry
Description

Gets the Foundry associated with this session.

Returnosid.resourcing.Foundrythe foundry
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchCommissions
Description

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

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

Federates the view for methods in this session. A federated view will include commissions in foundries which are children of this foundry in the foundry hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedFoundryView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodgetCommissionQuery
Description

Gets a commission query.

Returnosid.resourcing.CommissionQuerythe commission query
CompliancemandatoryThis method must be implemented.
MethodgetCommissionsByQuery
Description

Gets a list of Commissions matching the given commission query.

Parametersosid.resourcing.CommissionQuerycommissionQuerythe commission query
Returnosid.resourcing.CommissionListthe returned CommissionList
ErrorsNULL_ARGUMENT commissionQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED commissionQuery is not of this service
CompliancemandatoryThis method must be implemented.