org.osid.repository.rules

Interface CompositionEnablerSearchSession

All Superinterfaces:

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

public interface CompositionEnablerSearchSession
extends CompositionEnablerQuerySession

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

getCompositionEnablersByQuery() is the basic search method and returns a list of CompositionEnablers. A more advanced search may be performed with getCompositionEnablersBySearch(). It accepts a CompositionEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getCompositionEnablersBySearch() returns a CompositionEnablerSearchResults that can be used to access the resulting CompositionEnablerList or be used to perform a search within the result set through CompositionEnablerSearch.

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Methods

Modifier and Type	Method and Description
CompositionEnablerQuery	getCompositionEnablerQueryFromInspector(CompositionEnablerQueryInspector compositionEnablerQueryInspector) Gets a composition enabler query from an inspector.
CompositionEnablerSearchResults	getCompositionEnablersBySearch(CompositionEnablerQuery compositionEnablerQuery, CompositionEnablerSearch compositionEnablerSearch) Gets the search results matching the given search query using the given search.
CompositionEnablerSearch	getCompositionEnablerSearch() Gets a composition enabler search.
CompositionEnablerSearchOrder	getCompositionEnablerSearchOrder() Gets a composition enabler search order.

Methods inherited from interface org.osid.repository.rules.CompositionEnablerQuerySession

canSearchCompositionEnablers, getCompositionEnablerQuery, getCompositionEnablersByQuery, getRepository, getRepositoryId, useFederatedRepositoryView, useIsolatedRepositoryView

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

getCompositionEnablerSearch

CompositionEnablerSearch getCompositionEnablerSearch()

Gets a composition enabler search.

Returns:

the composition enabler search

Compliance:

mandatory - This method must be implemented.

getCompositionEnablerSearchOrder

CompositionEnablerSearchOrder getCompositionEnablerSearchOrder()

Gets a composition enabler search order. The CompositionEnablerSearchOrder is supplied to a CompositionEnablerSearch to specify the ordering of results.

Returns:

the composition enabler search order

Compliance:

mandatory - This method must be implemented.

getCompositionEnablersBySearch

CompositionEnablerSearchResults getCompositionEnablersBySearch(CompositionEnablerQuery compositionEnablerQuery,
                                                             CompositionEnablerSearch compositionEnablerSearch)
                                                               throws OperationFailedException,
                                                                      PermissionDeniedException

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

Parameters:

compositionEnablerQuery - the composition enabler query

compositionEnablerSearch - the composition enabler search

Returns:

the returned search results

Throws:

NullArgumentException - compositionEnablerQuery or compositionEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - compositionEnablerQuery or compositionEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getCompositionEnablerQueryFromInspector

CompositionEnablerQuery getCompositionEnablerQueryFromInspector(CompositionEnablerQueryInspector compositionEnablerQueryInspector)

Gets a composition enabler query from an inspector. The inspector is available from a CompositionEnablerSearchResults.

Parameters:

compositionEnablerQueryInspector - a composition enabler query inspector

Returns:

the composition enabler query

Throws:

NullArgumentException - compositionEnablerQueryInspector is null

UnsupportedException - compositionEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.