org.osid.authorization.rules

Interface AuthorizationEnablerSearchSession

All Superinterfaces:

AuthorizationEnablerQuerySession, java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface AuthorizationEnablerSearchSession
extends AuthorizationEnablerQuerySession

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

getAuthorizationEnablersByQuery() is the basic search method and returns a list of AuthorizationEnablers. A more advanced search may be performed with getAuthorizationEnablersBySearch(). It accepts an AuthorizationEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getAuthorizationEnablersBySearch() returns an AuthorizationEnablerSearchResults that can be used to access the resulting AuthorizationEnablerList or be used to perform a search within the result set through AuthorizationEnablerSearch.

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

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

Method Summary

Methods

Modifier and Type	Method and Description
AuthorizationEnablerQuery	getAuthorizationEnablerQueryFromInspector(AuthorizationEnablerQueryInspector authorizationEnablerQueryInspector) Gets an authorization enabler query from an inspector.
AuthorizationEnablerSearchResults	getAuthorizationEnablersBySearch(AuthorizationEnablerQuery authorizationEnablerQuery, AuthorizationEnablerSearch authorizationEnablerSearch) Gets the search results matching the given search query using the given search.
AuthorizationEnablerSearch	getAuthorizationEnablerSearch() Gets an authorization enabler search.
AuthorizationEnablerSearchOrder	getAuthorizationEnablerSearchOrder() Gets an authorization enabler search order.

Methods inherited from interface org.osid.authorization.rules.AuthorizationEnablerQuerySession

canSearchAuthorizationEnablers, getAuthorizationEnablerQuery, getAuthorizationEnablersByQuery, getVault, getVaultId, useFederatedVaultView, useIsolatedVaultView

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getAuthorizationEnablerSearch

AuthorizationEnablerSearch getAuthorizationEnablerSearch()

Gets an authorization enabler search.

Returns:

the authorization enabler search

Compliance:

mandatory - This method must be implemented.

getAuthorizationEnablerSearchOrder

AuthorizationEnablerSearchOrder getAuthorizationEnablerSearchOrder()

Gets an authorization enabler search order. The AuthorizationEnablerSearchOrder is supplied to an AuthorizationEnablerSearch to specify the ordering of results.

Returns:

the authorization enabler search order

Compliance:

mandatory - This method must be implemented.

getAuthorizationEnablersBySearch

AuthorizationEnablerSearchResults getAuthorizationEnablersBySearch(AuthorizationEnablerQuery authorizationEnablerQuery,
                                                                 AuthorizationEnablerSearch authorizationEnablerSearch)
                                                                   throws OperationFailedException,
                                                                          PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

authorizationEnablerQuery - the authorization enabler query

authorizationEnablerSearch - the authorization enabler search

Returns:

the returned search results

Throws:

NullArgumentException - authorizationEnablerQuery or authorizationEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - authorizationEnablerQuery or authorizationEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getAuthorizationEnablerQueryFromInspector

AuthorizationEnablerQuery getAuthorizationEnablerQueryFromInspector(AuthorizationEnablerQueryInspector authorizationEnablerQueryInspector)

Gets an authorization enabler query from an inspector. The inspector is available from an AuthorizationEnablerSearchResults.

Parameters:

authorizationEnablerQueryInspector - an authorization enabler query inspector

Returns:

the authorization enabler query

Throws:

NullArgumentException - authorizationEnablerQueryInspector is null

UnsupportedException - authorizationEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.