Interface OrganizationSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface OrganizationSearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Modifier and Type	Method	Description
OrganizationQueryInspector	getOrganizationQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
OrganizationList	getOrganizations()	Gets the organization list resulting from a search.
OrganizationSearchResultsRecord	getOrganizationSearchResultsRecord(Type organizationSearchRecordType)	Gets the record corresponding to the given organization search record Type .

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getOrganizations

OrganizationList getOrganizations()

Gets the organization list resulting from a search.

Returns:

the organization list

Throws:

IllegalStateException - the list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getOrganizationQueryInspector

OrganizationQueryInspector getOrganizationQueryInspector()

Gets the inspector for the query to examine the terms used in the search.

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getOrganizationSearchResultsRecord

OrganizationSearchResultsRecord getOrganizationSearchResultsRecord(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 results record

Throws:

NullArgumentException - organizationSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(organizationSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.