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

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

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

MethodcanSearchFoundries
Description

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

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

Gets a foundry query.

Returnosid.resourcing.FoundryQuerythe foundry query
CompliancemandatoryThis method must be implemented.
MethodgetFoundriesByQuery
Description

Gets a list of Foundries matching the given foundry query.

Parametersosid.resourcing.FoundryQueryfoundryQuerythe foundry query query
Returnosid.resourcing.FoundryListthe returned FoundryList
ErrorsNULL_ARGUMENT foundryQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED foundryQuery is not of this service
CompliancemandatoryThis method must be implemented.