public interface ProfileItemSearch extends OsidSearch
ProfileItemSearch
defines the interface for specifying
profile item search options.
Modifier and Type | Method and Description |
---|---|
ProfileItemSearchRecord |
getProfileItemSearchRecord(Type profileItemSearchRecordType)
Gets the profile item search record corresponding to the given profile
item search record
Type. |
void |
orderProfileItemResults(ProfileItemSearchOrder profileItemSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongProfileItems(IdList profileItemIds)
Execute this search among the given list of profile items.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongProfileItems(IdList profileItemIds)
profileItemIds
- list of profile items.NullArgumentException
- profileItemIds
is null
mandatory
- This method must be implemented. void orderProfileItemResults(ProfileItemSearchOrder profileItemSearchOrder)
profileItemSearchOrder
- profile item search orderNullArgumentException
- profileItemSearchOrder
is null
UnsupportedException
- profileItemSearchOrder
is not of this servicemandatory
- This method must be implemented. ProfileItemSearchRecord getProfileItemSearchRecord(Type profileItemSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.profileItemSearchRecordType
- a profile item search record typeNullArgumentException
-
profileItemSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(profileItemSearchRecordType)
is
false
mandatory
- This method must be implemented.