OSID Logo
OSID Specifications
repository rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.repository.rules.CompositionEnablerQuerySession
Implementsosid.OsidSession
Description

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

This session defines views that offer differing behaviors for searching.

  • federated repository view: searches include composition enablers in repositories of which this repository is an ancestor in the repository hierarchy
  • isolated repository view: searches are restricted to composition enablers in this repository

Composition enablers may have a query record indicated by their respective record types. The query record is accessed via the CompositionEnablerQuery.

MethodgetRepositoryId
Description

Gets the Repository Id associated with this session.

Returnosid.id.Idthe Repository Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetRepository
Description

Gets the Repository associated with this session.

Returnosid.repository.Repositorythe repository
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchCompositionEnablers
Description

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

Federates the view for methods in this session. A federated view will include composition enablers in repositories which are children of this repository in the repository hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedRepositoryView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodgetCompositionEnablerQuery
Description

Gets a composition enabler query.

Returnosid.repository.rules.CompositionEnablerQuerythe composition enabler query
CompliancemandatoryThis method must be implemented.
MethodgetCompositionEnablersByQuery
Description

Gets a list of CompositionEnablers matching the given composition enabler query.

Parametersosid.repository.rules.CompositionEnablerQuerycompositionEnablerQuerythe composition enabler query
Returnosid.repository.rules.CompositionEnablerListthe returned CompositionEnablerList
ErrorsNULL_ARGUMENT compositionEnablerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED compositionEnablerQuery is not of this service
CompliancemandatoryThis method must be implemented.