org.osid.course.chronicle

Interface CredentialEntrySearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidRelationshipSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable

public interface CredentialEntrySearchOrder
extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
CredentialEntrySearchOrderRecord	getCredentialEntrySearchOrderRecord(Type credentialEntryRecordType) Gets the chronicle search order record corresponding to the given credential entry record Type.
CredentialSearchOrder	getCredentialSearchOrder() Gets the credential order.
ProgramSearchOrder	getProgramSearchOrder() Gets the program order.
ResourceSearchOrder	getStudentSearchOrder() Gets the resource order.
void	orderByCredential(SearchOrderStyle style) Specifies a preference for ordering the result set by the credential.
void	orderByDateAwarded(SearchOrderStyle style) Specifies a preference for ordering the result set by the award date.
void	orderByProgram(SearchOrderStyle style) Specifies a preference for ordering the result set by the program.
void	orderByStudent(SearchOrderStyle style) Specifies a preference for ordering the result set by the resource.
boolean	supportsCredentialSearchOrder() Tests if a credential order is available.
boolean	supportsProgramSearchOrder() Tests if a program order is available.
boolean	supportsStudentSearchOrder() Tests if a resource order is available.

Methods inherited from interface org.osid.OsidRelationshipSearchOrder

getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder

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.OsidTemporalSearchOrder

orderByEffective, orderByEndDate, orderByStartDate

Method Detail

orderByStudent

void orderByStudent(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsStudentSearchOrder

boolean supportsStudentSearchOrder()

Tests if a resource order is available.

Returns:

true if a resource order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getStudentSearchOrder

ResourceSearchOrder getStudentSearchOrder()

Gets the resource order.

Returns:

the resource search order

Throws:

UnimplementedException - supportsStudentSearchOrder() is false

Compliance:

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

orderByCredential

void orderByCredential(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsCredentialSearchOrder

boolean supportsCredentialSearchOrder()

Tests if a credential order is available.

Returns:

true if a credential order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCredentialSearchOrder

CredentialSearchOrder getCredentialSearchOrder()

Gets the credential order.

Returns:

the credential search order

Throws:

UnimplementedException - supportsCredentialSearchOrder() is false

Compliance:

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

orderByDateAwarded

void orderByDateAwarded(SearchOrderStyle style)

Specifies a preference for ordering the result set by the award date.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByProgram

void orderByProgram(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsProgramSearchOrder

boolean supportsProgramSearchOrder()

Tests if a program order is available.

Returns:

true if a program order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getProgramSearchOrder

ProgramSearchOrder getProgramSearchOrder()

Gets the program order.

Returns:

the program search order

Throws:

UnimplementedException - supportsProgramSearchOrder() is false

Compliance:

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

getCredentialEntrySearchOrderRecord

CredentialEntrySearchOrderRecord getCredentialEntrySearchOrderRecord(Type credentialEntryRecordType)
                                                                     throws OperationFailedException

Gets the chronicle search order record corresponding to the given credential entry record Type. Multiple retrievals return the same underlying object.

Parameters:

credentialEntryRecordType - a credential entry record type

Returns:

the credential entry search order record

Throws:

NullArgumentException - credentialEntryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(credentialEntryRecordType) is false

Compliance:

mandatory - This method must be implemented.