public interface ProfileSearch extends OsidSearch
The interface for governing profile searches.
Modifier and Type | Method and Description |
---|---|
ProfileSearchRecord |
getProfileSearchRecord(Type profileSearchRecordType)
Gets the profile search record corresponding to the given profile
search record
Type. |
void |
orderProfileResults(ProfileSearchOrder profileSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongProfiles(IdList profileIds)
Execute this search among the given list of profiles.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongProfiles(IdList profileIds)
profileIds
- list of profilesNullArgumentException
- profileIds
is
null
mandatory
- This method must be implemented. void orderProfileResults(ProfileSearchOrder profileSearchOrder)
profileSearchOrder
- profile search orderNullArgumentException
- profileSearchOrder
is null
UnsupportedException
- profileSearchOrder
is not of this servicemandatory
- This method must be implemented. ProfileSearchRecord getProfileSearchRecord(Type profileSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.profileSearchRecordType
- a profile search record typeNullArgumentException
- profileSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(profileSearchRecordType)
is false
mandatory
- This method must be implemented.