Interface EndpointSearchSession

All Superinterfaces:

AutoCloseable, Closeable, EndpointQuerySession, OsidSession, OsidSession

public interface EndpointSearchSession
extends EndpointQuerySession

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

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

Endpoints may have a endpoint query record indicated by their respective record types. The endpoint query record is accessed via the EndpointQuery.

Method Summary

Modifier and Type	Method	Description
EndpointQuery	getEndpointQueryFromInspector(EndpointQueryInspector endpointQueryInspector)	Gets a endpoint query from an inspector.
EndpointSearchResults	getEndpointsBySearch(EndpointQuery endpointQuery, EndpointSearch endpointSearch)	Gets the search results matching the given search query using the given search.
EndpointSearch	getEndpointSearch()	Gets a endpoint search.
EndpointSearchOrder	getEndpointSearchOrder()	Gets a endpoint search order.

Methods inherited from interface Closeable

close

Methods inherited from interface EndpointQuerySession

canSearchEndpoints, getEndpointQuery, getEndpointsByQuery

Modifier and Type	Method	Description
boolean	canSearchEndpoints()	Tests if this user can perform Endpoint searches.
EndpointQuery	getEndpointQuery()	Gets a endpoint query.
EndpointList	getEndpointsByQuery(EndpointQuery endpointQuery)	Gets a list of Endpoints matching the given endpoint query.

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

getEndpointSearch

EndpointSearch getEndpointSearch()

Gets a endpoint search.

Returns:

the endpoint search

Compliance:

mandatory - This method must be implemented.

getEndpointSearchOrder

EndpointSearchOrder getEndpointSearchOrder()

Gets a endpoint search order. The EndpointSearchOrder is supplied to a EndpointSearch to specify the ordering of results.

Returns:

the endpoint search order

Compliance:

mandatory - This method must be implemented.

getEndpointsBySearch

EndpointSearchResults getEndpointsBySearch(EndpointQuery endpointQuery,
 EndpointSearch endpointSearch)
                                    throws OperationFailedException,
PermissionDeniedException

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

Parameters:

endpointQuery - the endpoint query

endpointSearch - the endpoint search

Returns:

the endpoint search results

Throws:

NullArgumentException - endpointQuery or endpointSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - endpointQuery or endpointSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getEndpointQueryFromInspector

EndpointQuery getEndpointQueryFromInspector(EndpointQueryInspector endpointQueryInspector)

Gets a endpoint query from an inspector. The inspector is available from a EndpointSearchResults.

Parameters:

endpointQueryInspector - a endpoint query inspector

Returns:

the endpoint query

Throws:

NullArgumentException - endpointQueryInspector is null

UnsupportedException - endpointQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.