OSID Logo
OSID Specifications
hold rules package
Version 3.0.0
Interfaceosid.hold.rules.IssueConstrainerEnablerList
Implementsosid.OsidList
Used Byosid.hold.rules.IssueConstrainerEnablerLookupSession
osid.hold.rules.IssueConstrainerEnablerOublietteSession
osid.hold.rules.IssueConstrainerEnablerQuerySession
osid.hold.rules.IssueConstrainerEnablerRuleLookupSession
osid.hold.rules.IssueConstrainerEnablerSearchResults
Description

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

while (icel.hasNext()) {
     IssueConstrainerEnabler enabler = icel.getNextIssueConstrainerEnabler();
}

or

while (icel.hasNext()) {
     IssueConstrainerEnabler[] enablers = icel.getNextIssueConstrainerEnablers(icel.available());
}            
                
MethodgetNextIssueConstrainerEnabler
Description

Gets the next IssueConstrainerEnabler in this list.

Returnosid.hold.rules.IssueConstrainerEnablerthe next IssueConstrainerEnabler in this list. The hasNext() method should be used to test that a next IssueConstrainerEnabler is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextIssueConstrainerEnablers
Description

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

Parameterscardinalnthe number of IssueConstrainerEnabler elements requested which must be less than or equal to available()
Returnosid.hold.rules.IssueConstrainerEnabler[]an array of IssueConstrainerEnabler elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.