public interface ProfileEntrySearch extends OsidSearch
ProfileEntrySearch
defines the interface for specifying
profile entry search options.
Modifier and Type | Method and Description |
---|---|
ProfileEntrySearchRecord |
getProfileEntrySearchRecord(Type profileENtrySearchRecordType)
Gets the profile entry record corresponding to the given profile entry
search record
Type. |
void |
orderProfileEntryResults(ProfileEntrySearchOrder profileEntrySearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongProfileEntries(IdList profileEntryIds)
Execute this search among the given list of profile entries.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongProfileEntries(IdList profileEntryIds)
profileEntryIds
- list of profile entriesNullArgumentException
- profileEntryIds
is null
mandatory
- This method must be implemented. void orderProfileEntryResults(ProfileEntrySearchOrder profileEntrySearchOrder)
profileEntrySearchOrder
- a profile entry search orderNullArgumentException
- profileEntrySearchOrder
is null
UnsupportedException
- profileEntrySearchOrder
is not of this servicemandatory
- This method must be implemented. ProfileEntrySearchRecord getProfileEntrySearchRecord(Type profileENtrySearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.profileENtrySearchRecordType
- a profile entry search record
typeNullArgumentException
-
profileEntrySearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(profileEntrySearchRecordType)
is
false
mandatory
- This method must be implemented.