Interface CredentialEntrySearchSession

All Superinterfaces:

AutoCloseable, Closeable, CredentialEntryQuerySession, OsidSession, OsidSession

public interface CredentialEntrySearchSession
extends CredentialEntryQuerySession

This session provides methods for searching among CredentialEntries . The search query is constructed using the CredentialEntryQuery .

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

This session defines views that offer differing behaviors for searching.

• federated course catalog view: searches include credential entries in course catalogs of which this course catalog is an ancestor in the course catalog hierarchy
• isolated course catalog view: searches are restricted to courses in this course catalog

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

Method Summary

Modifier and Type	Method	Description
CredentialEntrySearchResults	getCredentialEntriesBySearch(CredentialEntryQuery credentialEntryQuery, CredentialEntrySearch credentialEntrySearch)	Gets the search results matching the given search query using the given search.
CredentialEntryQuery	getCredentialEntryQueryFromInspector(CredentialEntryQueryInspector credentialEntryQueryInspector)	Gets a credential entry query from an inspector.
CredentialEntrySearch	getCredentialEntrySearch()	Gets a credential entry search.
CredentialEntrySearchOrder	getCredentialEntrySearchOrder()	Gets a credential entry search order.

Methods inherited from interface Closeable

close

Methods inherited from interface CredentialEntryQuerySession

canSearchCredentialEntries, getCourseCatalog, getCourseCatalogId, getCredentialEntriesByQuery, getCredentialEntryQuery, useFederatedCourseCatalogView, useIsolatedCourseCatalogView

Modifier and Type	Method	Description
boolean	canSearchCredentialEntries()	Tests if this user can perform CredentialEntry searches.
CourseCatalog	getCourseCatalog()	Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId()	Gets the CourseCatalog Id associated with this session.
CredentialEntryList	getCredentialEntriesByQuery(CredentialEntryQuery credentialEntryQuery)	Gets a list of CredentialEntries matching the given credential entry query.
CredentialEntryQuery	getCredentialEntryQuery()	Gets a credential entry query.
void	useFederatedCourseCatalogView()	Federates the view for methods in this session.
void	useIsolatedCourseCatalogView()	Isolates the view for methods in this session.

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

getCredentialEntrySearch

CredentialEntrySearch getCredentialEntrySearch()

Gets a credential entry search.

Returns:

the credential entry search

Compliance:

mandatory - This method must be implemented.

getCredentialEntrySearchOrder

CredentialEntrySearchOrder getCredentialEntrySearchOrder()

Gets a credential entry search order. The CredentialEntrySearchOrder is supplied to a CredentialEntrySearch to specify the ordering of results.

Returns:

the credential entry search order

Compliance:

mandatory - This method must be implemented.

getCredentialEntriesBySearch

CredentialEntrySearchResults getCredentialEntriesBySearch(CredentialEntryQuery credentialEntryQuery,
 CredentialEntrySearch credentialEntrySearch)
                                                   throws OperationFailedException,
PermissionDeniedException

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

Parameters:

credentialEntryQuery - the credential entry query

credentialEntrySearch - the credential entry search

Returns:

the credential entry search results

Throws:

NullArgumentException - credentialEntryQuery or credentialEntrySearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - credentialEntryQuery or CredentialEntrySearch is not of this service

Compliance:

mandatory - This method must be implemented.

getCredentialEntryQueryFromInspector

CredentialEntryQuery getCredentialEntryQueryFromInspector(CredentialEntryQueryInspector credentialEntryQueryInspector)

Gets a credential entry query from an inspector. The inspector is available from a CredentialEntrySearchResults .

Parameters:

credentialEntryQueryInspector - a credential entry query inspector

Returns:

the credential entry query

Throws:

NullArgumentException - credentialEntryQueryInspector is null

UnsupportedException - credentialEntryQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.