public interface ProjectSearch extends OsidSearch
The search interface for governing project searches.
Modifier and Type | Method and Description |
---|---|
ProjectSearchRecord |
getProjectSearchRecord(Type projectSearchRecordType)
Gets the search record corresponding to the given project search
record
Type. |
void |
orderProjectResults(ProjectSearchOrder projectSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongProjects(IdList ProjectIds)
Execute this search among the given list of projects.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongProjects(IdList ProjectIds)
ProjectIds
- list of projectsNullArgumentException
- ProjectIds
is
null
mandatory
- This method must be implemented. void orderProjectResults(ProjectSearchOrder projectSearchOrder)
projectSearchOrder
- project search orderNullArgumentException
- projectSearchOrder
is null
UnsupportedException
- projectSearchOrder
is not of this servicemandatory
- This method must be implemented. ProjectSearchRecord getProjectSearchRecord(Type projectSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object
implementing the requested record.projectSearchRecordType
- a project search record typeNullArgumentException
- projectSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(projectSearchRecordType)
is false
mandatory
- This method must be implemented.