Interface OrganizationSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface OrganizationSearch
extends OsidSearch

The search interface for governing organization searches.

Method Summary

Modifier and Type	Method	Description
OrganizationSearchRecord	getOrganizationSearchRecord(Type organizationSearchRecordType)	Gets the record corresponding to the given organization search record Type .
void	orderOrganizationResults(OrganizationSearchOrder organizationSearchOrder)	Specify an ordering to the search results.
void	searchAmongOrganizations(IdList organizationIds)	Execute this search among the given list of organizations.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongOrganizations

void searchAmongOrganizations(IdList organizationIds)

Execute this search among the given list of organizations.

Parameters:

organizationIds - list of organizations

Throws:

NullArgumentException - organizationIds is null

Compliance:

mandatory - This method must be implemented.

orderOrganizationResults

void orderOrganizationResults(OrganizationSearchOrder organizationSearchOrder)

Specify an ordering to the search results.

Parameters:

organizationSearchOrder - organization search order

Throws:

NullArgumentException - organizationSearchOrder is null

UnsupportedException - organizationSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getOrganizationSearchRecord

OrganizationSearchRecord getOrganizationSearchRecord(Type organizationSearchRecordType)
                                              throws OperationFailedException

Gets the record corresponding to the given organization search record Type . This method is used to retrieve an object implementing the requested record.

Parameters:

organizationSearchRecordType - an organization search record type

Returns:

the organization search record

Throws:

NullArgumentException - organizationSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(organizationSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.