org.osid.resourcing.rules

Interface AvailabilityEnablerSearchSession

All Superinterfaces:

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

public interface AvailabilityEnablerSearchSession
extends AvailabilityEnablerQuerySession

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

getAvailabilityEnablersByQuery() is the basic search method and returns a list of AvailabilityEnablers. A more advanced search may be performed with getAvailabilityEnablersBySearch(). It accepts an AvailabilityEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as resourcing. getAvailabilityEnablersBySearch() returns an AvailabilityEnablerSearchResults that can be used to access the resulting AvailabilityEnablerList or be used to perform a search within the result set through AvailabilityEnablerSearch.

This session defines views that offer differing behaviors for searching.

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

AvailabilityEnablers may have an availability enabler query record indicated by their respective record types. The availability enabler record query is accessed via the AvailabilityEnablerQuery.

Method Summary

Methods

Modifier and Type	Method and Description
AvailabilityEnablerQuery	getAvailabilityEnablerQueryFromInspector(AvailabilityEnablerQueryInspector availabilityEnablerQueryInspector) Gets an availability enabler query from an inspector.
AvailabilityEnablerSearchResults	getAvailabilityEnablersBySearch(AvailabilityEnablerQuery availabilityEnablerQuery, AvailabilityEnablerSearch availabilityEnablerSearch) Gets the search results matching the given search query using the given search.
AvailabilityEnablerSearch	getAvailabilityEnablerSearch() Gets an availability enabler search.
AvailabilityEnablerSearchOrder	getAvailabilityEnablerSearchOrder() Gets an availability enabler search order.

Methods inherited from interface org.osid.resourcing.rules.AvailabilityEnablerQuerySession

canSearchAvailabilityEnablers, getAvailabilityEnablerQuery, getAvailabilityEnablersByQuery, getFoundry, getFoundryId, useFederatedFoundryView, useIsolatedFoundryView

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

getAvailabilityEnablerSearch

AvailabilityEnablerSearch getAvailabilityEnablerSearch()

Gets an availability enabler search.

Returns:

the availability enabler search.

Compliance:

mandatory - This method must be implemented.

getAvailabilityEnablerSearchOrder

AvailabilityEnablerSearchOrder getAvailabilityEnablerSearchOrder()

Gets an availability enabler search order. The AvailabilityEnablerSearchOrder is supplied to an AvailabilityEnablerSearch to specify the ordering of results.

Returns:

the availability enabler search order

Compliance:

mandatory - This method must be implemented.

getAvailabilityEnablersBySearch

AvailabilityEnablerSearchResults getAvailabilityEnablersBySearch(AvailabilityEnablerQuery availabilityEnablerQuery,
                                                               AvailabilityEnablerSearch availabilityEnablerSearch)
                                                                 throws OperationFailedException,
                                                                        PermissionDeniedException

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

Parameters:

availabilityEnablerQuery - the availability enabler query

availabilityEnablerSearch - the availability enabler search

Returns:

the returned search results

Throws:

NullArgumentException - availabilityEnablerQuery or availabilityEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - availabilityEnablerQuery or availabilityEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getAvailabilityEnablerQueryFromInspector

AvailabilityEnablerQuery getAvailabilityEnablerQueryFromInspector(AvailabilityEnablerQueryInspector availabilityEnablerQueryInspector)

Gets an availability enabler query from an inspector. The inspector is available from an AvailabilityEnablerSearchResults.

Parameters:

availabilityEnablerQueryInspector - an availability enabler query inspector

Returns:

the availability enabler query

Throws:

NullArgumentException - availabilityEnablerQueryInspector is null

UnsupportedException - availabilityEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.