OSID Logo
OSID Specifications
resource package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resource.ResourceQuerySession
Implementsosid.OsidSession
Description

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

This session defines views that offer differing behaviors for searching.

  • federated bin view: searches include resources in bins of which this bin is a ancestor in the bin hierarchy
  • isolated bin view: searches are restricted to resources in this bin

Resources may have a resource record indicated by their respective record types. The resource query record is accessed via the ResourceQuery.

MethodgetBinId
Description

Gets the Bin Id associated with this session.

Returnosid.id.Idthe Bin Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetBin
Description

Gets the Bin associated with this session.

Returnosid.resource.Binthe Bin associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchResources
Description

Tests if this user can perform Resource 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.
MethoduseFederatedBinView
Description

Federates the view for methods in this session. A federated view will include resources in bins which are children of this bin in the bin hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedBinView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this bin only.

CompliancemandatoryThis method is must be implemented.
MethodgetResourceQuery
Description

Gets a resource query. The returned query will not have an extension query.

Returnosid.resource.ResourceQuerythe resource query
CompliancemandatoryThis method must be implemented.
MethodgetResourcesByQuery
Description

Gets a list of Resources matching the given resource query.

Parametersosid.resource.ResourceQueryresourceQuerythe resource query
Returnosid.resource.ResourceListthe returned ResourceList
ErrorsNULL_ARGUMENT resourceQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED resourceQuery is not of this service
CompliancemandatoryThis method must be implemented.