OSID Logo
OSID Specifications
relationship rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.relationship.rules.RelationshipEnablerList
Implementsosid.OsidList
Description

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

                     
                     
                     while (rel.hasNext()) {
                          RelationshipEnabler enabler = rel.getNextRelationshipEnabler();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (rel.hasNext()) {
                          RelationshipEnabler[] enablers = rel.getNextRelationshipEnablers rel.available());
                     }
                     
                                 
                     
                
MethodgetNextRelationshipEnabler
Description

Gets the next RelationshipEnabler in this list.

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

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

Parameterscardinalnthe number of RelationshipEnabler elements requested which must be less than or equal to available()
Returnosid.relationship.rules.RelationshipEnabler[]an array of RelationshipEnabler 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.