OSID Logo
OSID Specifications
contact rules package
Version 3.1.0
Interfaceosid.contact.rules.ContactEnablerList
Implementsosid.OsidList
Used Byosid.contact.rules.ContactEnablerAddressBookSession
osid.contact.rules.ContactEnablerLookupSession
osid.contact.rules.ContactEnablerQuerySession
osid.contact.rules.ContactEnablerRuleLookupSession
osid.contact.rules.ContactEnablerSearchResults
Description

Like all OsidLists, ContactEnablerList provides a means for accessing ContactEnabler elements sequentially either one at a time or many at a time. Examples:

while (cel.hasNext()) {
     ContactEnabler enabler = cel.getNextContactEnabler();
}
                
or
while (cel.hasNext()) {
     ContactEnabler[] enablers = cel.getNextContactEnablers(cel.available());
}
                
MethodgetNextContactEnabler
Description

Gets the next ContactEnabler in this list.

Returnosid.contact.rules.ContactEnabler the next ContactEnabler in this list. The hasNext() method should be used to test that a next ContactEnabler is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetNextContactEnablers
Description

Gets the next set of ContactEnabler elements in this list. The specified amount must be less than or equal to the return from available().

Parameterscardinaln the number of ContactEnabler elements requested which must be less than or equal to available()
Returnosid.contact.rules.ContactEnabler[] an array of ContactEnabler elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.