Interface OrganizationSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OrganizationQuerySession, OsidSession, OsidSession

public interface OrganizationSearchSession
extends OrganizationQuerySession

This session provides methods for searching Organization objects. The search query is constructed using the OrganizationQuery . The organization record Type also specifies the record for the organization query.

getOrganizationsByQuery() is the basic search method and returns a list of Organization elements. A more advanced search may be performed with getOrganizationsBySearch() . It accepts an OrganizationSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getOrganizationsBySearch() returns an OrganizationSearchResults that can be used to access the resulting OrganizationList or be used to perform a search within the result set through OrganizationSearch .

This session defines views that offer differing behaviors for searching.

• federated realm view: searches include organizations in realms of which this realm is an ancestor in the realm hierarchy
• isolated realm view: searches are restricted to organizations in this realm

Organizations may have a query record indicated by their respective record types. The query record is accessed via the OrganizationQuery . The returns in this session may not be cast directly to these interfaces.

Method Summary

Modifier and Type	Method	Description
OrganizationQuery	getOrganizationQueryFromInspector(OrganizationQueryInspector organizationQueryInspector)	Gets an organization query from an inspector.
OrganizationSearchResults	getOrganizationsBySearch(OrganizationQuery organizationQuery, OrganizationSearch organizationSearch)	Gets the search results matching the given search.
OrganizationSearch	getOrganizationSearch()	Gets an organization search.
OrganizationSearchOrder	getOrganizationSearchOrder()	Gets an organization search order.

Methods inherited from interface Closeable

close

Methods inherited from interface OrganizationQuerySession

canSearchOrganizations, getOrganizationQuery, getOrganizationsByQuery, getRealm, getRealmId, useFederatedRealmView, useIsolatedRealmView

Modifier and Type	Method	Description
boolean	canSearchOrganizations()	Tests if this user can perform Organization searches.
OrganizationQuery	getOrganizationQuery()	Gets an organization query.
OrganizationList	getOrganizationsByQuery(OrganizationQuery organizationQuery)	Gets a list of organizations matching the given organization query.
Realm	getRealm()	Gets the Realm associated with this session.
Id	getRealmId()	Gets the Realm Id associated with this session.
void	useFederatedRealmView()	Federates the view for methods in this session.
void	useIsolatedRealmView()	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

getOrganizationSearch

OrganizationSearch getOrganizationSearch()

Gets an organization search.

Returns:

the organization search

Compliance:

mandatory - This method must be implemented.

getOrganizationSearchOrder

OrganizationSearchOrder getOrganizationSearchOrder()

Gets an organization search order. The OrganizationSearchOrder is supplied to an OrganizationSearch to specify the ordering of results.

Returns:

the organization search order

Compliance:

mandatory - This method must be implemented.

getOrganizationsBySearch

OrganizationSearchResults getOrganizationsBySearch(OrganizationQuery organizationQuery,
 OrganizationSearch organizationSearch)
                                            throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search.

Parameters:

organizationQuery - the organization query

organizationSearch - the organization search

Returns:

the search results

Throws:

NullArgumentException - organizationQuery or organizationSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - organizationQuery or organizationSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getOrganizationQueryFromInspector

OrganizationQuery getOrganizationQueryFromInspector(OrganizationQueryInspector organizationQueryInspector)

Gets an organization query from an inspector. The inspector is available from an OrganizationSearchResults .

Parameters:

organizationQueryInspector - an organization query inspector

Returns:

the organization query

Throws:

NullArgumentException - organizationQueryInspector is null

UnsupportedException - organizationQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.