public interface ContactEnablerSearch extends OsidSearch
The search interface for governing contact enabler searches.
Modifier and Type | Method and Description |
---|---|
ContactEnablerSearchRecord |
getContactEnablerSearchRecord(Type contactEnablerSearchRecordType)
Gets the contact enabler search record corresponding to the given
contact enabler search record
Type. |
void |
orderContactEnablerResults(ContactEnablerSearchOrder contactEnablerSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongContactEnablers(IdList contactEnablerIds)
Execute this search among the given list of contact enablers.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongContactEnablers(IdList contactEnablerIds)
contactEnablerIds
- list of contact enablersNullArgumentException
- contactEnablerIds
is null
mandatory
- This method must be implemented. void orderContactEnablerResults(ContactEnablerSearchOrder contactEnablerSearchOrder)
contactEnablerSearchOrder
- contact enabler search orderNullArgumentException
-
contactEnablerSearchOrder
is null
UnsupportedException
- contactEnablerSearchOrder
is not of this servicemandatory
- This method must be implemented. ContactEnablerSearchRecord getContactEnablerSearchRecord(Type contactEnablerSearchRecordType) throws OperationFailedException
Type.
This method is used
to retrieve an object implementing the requested record.contactEnablerSearchRecordType
- a contact enabler search record
typeNullArgumentException
-
contactEnablerSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(contactEnablerSearchRecordType)
is
false
mandatory
- This method must be implemented.