org.osid.authentication

Interface AgencySearchSession

All Superinterfaces:

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

public interface AgencySearchSession
extends AgencyQuerySession

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

getAgenciesByQuery() is the basic search method and returns a list of Agency objects.A more advanced search may be performed with getAgenciesBySearch(). It accepts a AgencySearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getAgenciesBySearch() returns a AgencySearchResults that can be used to access the resulting AgencyList or be used to perform a search within the result set through AgencySearch.

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

Method Summary

Methods

Modifier and Type	Method and Description
AgencySearchResults	getAgenciesBySearch(AgencyQuery agencyQuery, AgencySearch agencySearch) Gets the search results matching the given search query using the given search.
AgencyQuery	getAgencyQueryFromInspector(AgencyQueryInspector agencyQueryInspector) Gets an agency query from an inspector.
AgencySearch	getAgencySearch() Gets an agency search.
AgencySearchOrder	getAgencySearchOrder() Gets an agency search order.

Methods inherited from interface org.osid.authentication.AgencyQuerySession

canSearchAgencies, getAgenciesByQuery, getAgencyQuery

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

getAgencySearch

AgencySearch getAgencySearch()

Gets an agency search.

Returns:

an agency search

Compliance:

mandatory - This method must be implemented.

getAgencySearchOrder

AgencySearchOrder getAgencySearchOrder()

Gets an agency search order. The AgencySearchOrder is supplied to a AgencySearch to specify the ordering of results.

Returns:

the agency search order

Compliance:

mandatory - This method must be implemented.

getAgenciesBySearch

AgencySearchResults getAgenciesBySearch(AgencyQuery agencyQuery,
                                      AgencySearch agencySearch)
                                        throws OperationFailedException,
                                               PermissionDeniedException

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

Parameters:

agencyQuery - the agency query

agencySearch - the agency search

Returns:

the search results

Throws:

NullArgumentException - agencyQuery or agencySearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - agencyQuery or agencySearch is not of this service

Compliance:

mandatory - This method must be implemented.

getAgencyQueryFromInspector

AgencyQuery getAgencyQueryFromInspector(AgencyQueryInspector agencyQueryInspector)

Gets an agency query from an inspector. The inspector is available from an AgencySearchResults.

Parameters:

agencyQueryInspector - an agency query inspector

Returns:

the agency query

Throws:

NullArgumentException - agencyQueryInspector is null

UnsupportedException - agencyQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.