public interface CredentialRequirementList extends OsidList
Like all OsidLists,
CredentialRequirementList
provides a means for accessing CredentialRequirement
elements sequentially either one at a time or many at a time.
Examples:
while (crl.hasNext()) { CredentialRequirement req = crl.getNextCredentialRequirement(); }or
while (crl.hasNext()) { CredentialRequirement[] reqs = crl.getNextCredentialRequirements(crl.available()); }
Modifier and Type | Method and Description |
---|---|
CredentialRequirement |
getNextCredentialRequirement()
Gets the next
CredentialRequirement in this list. |
CredentialRequirement[] |
getNextCredentialRequirements(long n)
Gets the next set of
CredentialRequirement elements in
this list. |
CredentialRequirement getNextCredentialRequirement() throws OperationFailedException
CredentialRequirement
in this list. CredentialRequirement
in this list.
The hasNext()
method should be used to test
that a next CredentialRequirement
is available
before calling this method.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented. CredentialRequirement[] getNextCredentialRequirements(long n) throws OperationFailedException
CredentialRequirement
elements in
this list. The specified amount must be less than or equal to the
return from available().
n
- the number of CredentialRequirement
elements
requested which must be less than or equal to
available()
CredentialRequirement
elements.
The length of the array is less than or equal
to the number specified.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented.