Interface SequenceRuleSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface SequenceRuleSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
SequenceRuleQueryInspector	getSequenceRuleQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
SequenceRuleList	getSequenceRules()	Gets the SequenceRuleList resulting from a search.
SequenceRuleSearchResultsRecord	getSequenceRuleSearchResultsRecord(Type sequenceRuleSearchRecordType)	Gets the sequence rule search results record corresponding to the given sequence rule search record Type .This method must be used to retrieve an object implementing the requested record.

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

getSequenceRules

SequenceRuleList getSequenceRules()

Gets the SequenceRuleList resulting from a search.

Returns:

the sequence rule list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getSequenceRuleQueryInspector

SequenceRuleQueryInspector getSequenceRuleQueryInspector()

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

Returns:

the sequence rule query inspector

Compliance:

mandatory - This method must be implemented.

getSequenceRuleSearchResultsRecord

SequenceRuleSearchResultsRecord getSequenceRuleSearchResultsRecord(Type sequenceRuleSearchRecordType)
                                                            throws OperationFailedException,
PermissionDeniedException

Gets the sequence rule search results record corresponding to the given sequence rule search record Type .This method must be used to retrieve an object implementing the requested record.

Parameters:

sequenceRuleSearchRecordType - a sequence rule search record type

Returns:

the sequence rule search results record

Throws:

NullArgumentException - sequenceRuleSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(sequenceRuleSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.