org.osid.assessment.authoring

Interface SequenceRuleSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidRuleSearchOrder, OsidSearchOrder, Suppliable

public interface SequenceRuleSearchOrder
extends OsidRuleSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
AssessmentPartSearchOrder	getAssessmentPartSearchOrder() Gets the assessment order.
AssessmentPartSearchOrder	getNextAssessmentPartSearchOrder() Gets the assessment order.
SequenceRuleSearchOrderRecord	getSequenceRuleSearchOrderRecord(Type sequenceRuleRecordType) Gets the sequence rule search order record corresponding to the given sequence rule record Type.
void	orderByAssessmentPart(SearchOrderStyle style) Specifies a preference for ordering the result set by the assessment part.
void	orderByCumulative(SearchOrderStyle style) Specifies a preference for ordering the result set by the cumulative.
void	orderByMaximumScore(SearchOrderStyle style) Specifies a preference for ordering the result set by the maximum score.
void	orderByMinimumScore(SearchOrderStyle style) Specifies a preference for ordering the result set by the minimum score.
void	orderByNextAssessmentPart(SearchOrderStyle style) Specifies a preference for ordering the result set by the assessment part.
boolean	supportsAssessmentPartSearchOrder() Tests if an assessment part search order is available.
boolean	supportsNextAssessmentPartSearchOrder() Tests if an assessment part search order is available.

Methods inherited from interface org.osid.OsidRuleSearchOrder

getRuleSearchOrder, orderByRule, supportsRuleSearchOrder

Methods inherited from interface org.osid.OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidOperableSearchOrder

orderByActive, orderByDisabled, orderByEnabled, orderByOperational

Method Detail

orderByAssessmentPart

void orderByAssessmentPart(SearchOrderStyle style)

Specifies a preference for ordering the result set by the assessment part.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsAssessmentPartSearchOrder

boolean supportsAssessmentPartSearchOrder()

Tests if an assessment part search order is available.

Returns:

true if an assessment part search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAssessmentPartSearchOrder

AssessmentPartSearchOrder getAssessmentPartSearchOrder()

Gets the assessment order.

Returns:

the assessment part search order

Throws:

UnimplementedException - supportsAssessmentPartSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsAssessmentPartSearchOrder() is true.

orderByNextAssessmentPart

void orderByNextAssessmentPart(SearchOrderStyle style)

Specifies a preference for ordering the result set by the assessment part.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsNextAssessmentPartSearchOrder

boolean supportsNextAssessmentPartSearchOrder()

Tests if an assessment part search order is available.

Returns:

true if an assessment part search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getNextAssessmentPartSearchOrder

AssessmentPartSearchOrder getNextAssessmentPartSearchOrder()

Gets the assessment order.

Returns:

the assessment part search order

Throws:

UnimplementedException - supportsNextAssessmentPartSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsNextAssessmentPartSearchOrder() is true.

orderByMinimumScore

void orderByMinimumScore(SearchOrderStyle style)

Specifies a preference for ordering the result set by the minimum score.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByMaximumScore

void orderByMaximumScore(SearchOrderStyle style)

Specifies a preference for ordering the result set by the maximum score.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByCumulative

void orderByCumulative(SearchOrderStyle style)

Specifies a preference for ordering the result set by the cumulative.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getSequenceRuleSearchOrderRecord

SequenceRuleSearchOrderRecord getSequenceRuleSearchOrderRecord(Type sequenceRuleRecordType)
                                                               throws OperationFailedException

Gets the sequence rule search order record corresponding to the given sequence rule record Type. Multiple retrievals return the same underlying object.

Parameters:

sequenceRuleRecordType - a sequence rule record type

Returns:

the sequence rule search order record

Throws:

NullArgumentException - sequenceRuleRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(sequenceRuleRecordType) is false

Compliance:

mandatory - This method must be implemented.