public interface AuthorizationQuerySession extends OsidSession
This session provides methods for searching Authorization
objects. The search query is constructed using the
AuthorizationQuery.
This session defines views that offer differing behaviors for searching.
Vaults
of which this vault is a ancestor in the vault hierarchy Vault
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchAuthorizations()
Tests if this user can perform authorization searches.
|
AuthorizationQuery |
getAuthorizationQuery()
Gets an authorization query.
|
AuthorizationList |
getAuthorizationsByQuery(AuthorizationQuery authorizationQuery)
Gets a list of
Authorizations matching the given query. |
Vault |
getVault()
Gets the
Vault associated with this session. |
Id |
getVaultId()
Gets the
Vault Id associated with this
session. |
void |
useExplicitAuthorizationView()
Sets the view for methods in this session to explicit authorizations.
|
void |
useFederatedVaultView()
Federates the view for methods in this session.
|
void |
useImplicitAuthorizationView()
Sets the view for methods in this session to implicit authorizations.
|
void |
useIsolatedVaultView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getVaultId()
Vault
Id
associated with this
session. Vault Id
associated with this sessionmandatory
- This method must be implemented. Vault getVault() throws OperationFailedException, PermissionDeniedException
Vault
associated with this session. Vault
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchAuthorizations()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer search operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedVaultView()
mandatory
- This method is must be implemented. void useIsolatedVaultView()
mandatory
- This method is must be implemented. void useImplicitAuthorizationView()
Qualifier,
Function
or Resource
hierarchies. This method
is the opposite of explicitAut
mandatory
- This method is must be implemented. void useExplicitAuthorizationView()
implicitAuthorizationView().
mandatory
- This method is must be implemented. AuthorizationQuery getAuthorizationQuery()
mandatory
- This method must be implemented. AuthorizationList getAuthorizationsByQuery(AuthorizationQuery authorizationQuery) throws OperationFailedException, PermissionDeniedException
Authorizations
matching the given query.authorizationQuery
- the authorization query AuthorizationList
NullArgumentException
- authorizationQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- authorizationQuery
is not of this servicemandatory
- This method must be implemented.