Interface AvailabilitySearchSession

All Superinterfaces:

AutoCloseable, AvailabilityQuerySession, Closeable, OsidSession, OsidSession

public interface AvailabilitySearchSession
extends AvailabilityQuerySession

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

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

This session defines views that offer differing behaviors for searching.

• federated foundry view: searches include availabilities in foundries of which this foundry is an ancestor in the foundry hierarchy
• isolated foundry view: searches are restricted to availabilities in this foundry

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

Method Summary

Modifier and Type	Method	Description
AvailabilitySearchResults	getAvailabilitiesBySearch(AvailabilityQuery availabilityQuery, AvailabilitySearch availabilitySearch)	Gets the search results matching the given search query using the given search.
AvailabilityQuery	getAvailabilityQueryFromInspector(AvailabilityQueryInspector availabilityQueryInspector)	Gets an availability query from an inspector.
AvailabilitySearch	getAvailabilitySearch()	Gets an availability search.
AvailabilitySearchOrder	getAvailabilitySearchOrder()	Gets an availability search order.

Methods inherited from interface AvailabilityQuerySession

canSearchAvailabilities, getAvailabilitiesByQuery, getAvailabilityQuery, getFoundry, getFoundryId, useFederatedFoundryView, useIsolatedFoundryView

Modifier and Type	Method	Description
boolean	canSearchAvailabilities()	Tests if this user can perform Availability lookups.
AvailabilityList	getAvailabilitiesByQuery(AvailabilityQuery availabilityQuery)	Gets a list of Availabilities matching the given availability query.
AvailabilityQuery	getAvailabilityQuery()	Gets an availability query.
Foundry	getFoundry()	Gets the Foundry associated with this session.
Id	getFoundryId()	Gets the Foundry Id associated with this session.
void	useFederatedFoundryView()	Federates the view for methods in this session.
void	useIsolatedFoundryView()	Isolates the view for methods in this session.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getAvailabilitySearch

AvailabilitySearch getAvailabilitySearch()

Gets an availability search.

Returns:

the availability search

Compliance:

mandatory - This method must be implemented.

getAvailabilitySearchOrder

AvailabilitySearchOrder getAvailabilitySearchOrder()

Gets an availability search order. The AvailabilitySearchOrder is supplied to an AvailabilitySearch to specify the ordering of results.

Returns:

the availability search order

Compliance:

mandatory - This method must be implemented.

getAvailabilitiesBySearch

AvailabilitySearchResults getAvailabilitiesBySearch(AvailabilityQuery availabilityQuery,
 AvailabilitySearch availabilitySearch)
                                             throws OperationFailedException,
PermissionDeniedException

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

Parameters:

availabilityQuery - the availability query

availabilitySearch - the availability search

Returns:

the returned search results

Throws:

NullArgumentException - availabilityQuery or availabilitySearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - availabilityQuery or availabilitySearch is not of this service

Compliance:

mandatory - This method must be implemented.

getAvailabilityQueryFromInspector

AvailabilityQuery getAvailabilityQueryFromInspector(AvailabilityQueryInspector availabilityQueryInspector)

Gets an availability query from an inspector. The inspector is available from an AvailabilitySearchResults .

Parameters:

availabilityQueryInspector - an availability query inspector

Returns:

the availability query

Throws:

NullArgumentException - availabilityQueryInspector is null

UnsupportedException - availabilityQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.