Interface CredentialSearchSession

All Superinterfaces:

AutoCloseable, Closeable, CredentialQuerySession, OsidSession, OsidSession

public interface CredentialSearchSession
extends CredentialQuerySession

This session provides methods for searching among Credentials . The search query is constructed using the CredentialQuery .

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

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Modifier and Type	Method	Description
CredentialQuery	getCredentialQueryFromInspector(CredentialQueryInspector credentialQueryInspector)	Gets a credential query from an inspector.
CredentialSearchResults	getCredentialsBySearch(CredentialQuery credentialQuery, CredentialSearch credentialSearch)	Gets the search results matching the given search query using the given search.
CredentialSearch	getCredentialSearch()	Gets a credential search.
CredentialSearchOrder	getCredentialSearchOrder()	Gets a credential search order.

Methods inherited from interface Closeable

close

Methods inherited from interface CredentialQuerySession

canSearchCredentials, getCourseCatalog, getCourseCatalogId, getCredentialQuery, getCredentialsByQuery, useFederatedCourseCatalogView, useIsolatedCourseCatalogView

Modifier and Type	Method	Description
boolean	canSearchCredentials()	Tests if this user can perform Credential searches.
CourseCatalog	getCourseCatalog()	Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId()	Gets the CourseCatalog Id associated with this session.
CredentialQuery	getCredentialQuery()	Gets a credential query.
CredentialList	getCredentialsByQuery(CredentialQuery credentialQuery)	Gets a list of Credentials matching the given credential 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

getCredentialSearch

CredentialSearch getCredentialSearch()

Gets a credential search.

Returns:

the credential search

Compliance:

mandatory - This method must be implemented.

getCredentialSearchOrder

CredentialSearchOrder getCredentialSearchOrder()

Gets a credential search order. The CredentialSearchOrder is supplied to a CredentialSearch to specify the ordering of results.

Returns:

the credential search order

Compliance:

mandatory - This method must be implemented.

getCredentialsBySearch

CredentialSearchResults getCredentialsBySearch(CredentialQuery credentialQuery,
 CredentialSearch credentialSearch)
                                        throws OperationFailedException,
PermissionDeniedException

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

Parameters:

credentialQuery - the credential query

credentialSearch - the credential search

Returns:

the credential search results

Throws:

NullArgumentException - credentialQuery or credentialSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - credentialQuery or credentialSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getCredentialQueryFromInspector

CredentialQuery getCredentialQueryFromInspector(CredentialQueryInspector credentialQueryInspector)

Gets a credential query from an inspector. The inspector is available from a CredentialSearchResults .

Parameters:

credentialQueryInspector - a credential query inspector

Returns:

the credential query

Throws:

NullArgumentException - credentialQueryInspector is null

UnsupportedException - credentialQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.