public interface GradebookColumnSearch extends OsidSearch
GradebookColumnSearch
defines the interface for
specifying grading search options.
Modifier and Type | Method and Description |
---|---|
GradebookColumnSearchRecord |
getGradebookColumnSearchRecord(Type gradebookColumnSearchRecordType)
Gets the gradebook column search record corresponding to the given
gradebook column search record
Type. |
void |
orderGradebookColumnResults(GradebookColumnSearchOrder gradebookColumnSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongGradebookColumns(IdList gradebookColumnIds)
Execute this search among the given list of gradebook columns.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongGradebookColumns(IdList gradebookColumnIds)
gradebookColumnIds
- list of gradebook columnsNullArgumentException
- gradebookColumnIds
is null
mandatory
- This method must be implemented. void orderGradebookColumnResults(GradebookColumnSearchOrder gradebookColumnSearchOrder)
gradebookColumnSearchOrder
- gradebook column search orderNullArgumentException
-
gradebookColumnSearchOrder
is null
UnsupportedException
-
gradebookColumnSearchOrder
is not of this servicemandatory
- This method must be implemented. GradebookColumnSearchRecord getGradebookColumnSearchRecord(Type gradebookColumnSearchRecordType) throws OperationFailedException
Type.
This method is
used to retrieve an object implementing the requested record.gradebookColumnSearchRecordType
- a gradebook column search
record typeNullArgumentException
-
gradebookColumnSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(gradebookColumnSearchRecordType)
is
false
mandatory
- This method must be implemented.