OSID Logo
OSID Specifications
authorization package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authorization.FunctionQuerySession
Implementsosid.OsidSession
Description

This session provides methods for searching Function objects. The search query is constructed using the FunctionQuery. The function record Type also specifies the query record for the function query.

This session defines views that offer differing behaviors for searching.

  • federated vault view: searches include functions in vaults of which this vault is a ancestor in the vault hierarchy
  • isolated vault view: searches are restricted to functions in this vault

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

MethodgetVaultId
Description

Gets the Vault Id associated with this session.

Returnosid.id.Idthe Vault Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetVault
Description

Gets the Vault associated with this session.

Returnosid.authorization.Vaultthe Vault associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchFunctions
Description

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

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

Federates the view for methods in this session. A federated view will include functions in vaults which are children of this vault in the vault hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedVaultView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodgetFunctionQuery
Description

Gets a function query.

Returnosid.authorization.FunctionQuerythe function query
CompliancemandatoryThis method must be implemented.
MethodgetFunctionsByQuery
Description

Gets a list of Functions matching the given query.

Parametersosid.authorization.FunctionQueryfunctionQuerythe function query
Returnosid.authorization.FunctionListthe returned FunctionList
ErrorsNULL_ARGUMENT functionQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED functionQuery is not of this service
CompliancemandatoryThis method must be implemented.