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

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

This session defines views that offer differing behaviors for searching.

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

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

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
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchAuthorizationEnablers
Description

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

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

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedVaultView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodgetAuthorizationEnablerQuery
Description

Gets an authorization enabler query.

Returnosid.authorization.rules.AuthorizationEnablerQuerythe authorization enabler query
CompliancemandatoryThis method must be implemented.
MethodgetAuthorizationEnablersByQuery
Description

Gets a list of AuthorizationEnablers matching the given search.

Parametersosid.authorization.rules.AuthorizationEnablerQueryauthorizationEnablerQuerythe search query
Returnosid.authorization.rules.AuthorizationEnablerListthe returned AuthorizationEnablerList
ErrorsNULL_ARGUMENT authorizationEnablerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED authorizationEnablerQuery is not of this service
CompliancemandatoryThis method must be implemented.