public interface CredentialEntrySearchOrder extends OsidRelationshipSearchOrder
An interface for specifying the ordering of search results.
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.
|
getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByEffective, orderByEndDate, orderByStartDate
void orderByStudent(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsStudentSearchOrder()
true
if a resource order is available,
false
otherwisemandatory
- This method must be implemented. ResourceSearchOrder getStudentSearchOrder()
UnimplementedException
-
supportsStudentSearchOrder()
is false
optional
- This method must be implemented if
supportsStudentSearchOrder()
is true.
void orderByCredential(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsCredentialSearchOrder()
true
if a credential order is available,
false
otherwisemandatory
- This method must be implemented. CredentialSearchOrder getCredentialSearchOrder()
UnimplementedException
-
supportsCredentialSearchOrder()
is false
optional
- This method must be implemented if
supportsCredentialSearchOrder()
is true.
void orderByDateAwarded(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByProgram(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsProgramSearchOrder()
true
if a program order is available,
false
otherwisemandatory
- This method must be implemented. ProgramSearchOrder getProgramSearchOrder()
UnimplementedException
-
supportsProgramSearchOrder()
is false
optional
- This method must be implemented if
supportsProgramSearchOrder()
is true.
CredentialEntrySearchOrderRecord getCredentialEntrySearchOrderRecord(Type credentialEntryRecordType) throws OperationFailedException
Type.
Multiple retrievals
return the same underlying object.credentialEntryRecordType
- a credential entry record typeNullArgumentException
-
credentialEntryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(credentialEntryRecordType)
is
false
mandatory
- This method must be implemented.