OSID Logo
OSID Specifications
authorization package
Version 3.1.0
Interfaceosid.authorization.VaultList
Implementsosid.OsidList
Used Byosid.authorization.AuthorizationVaultSession
osid.authorization.FunctionVaultSession
osid.authorization.QualifierVaultSession
osid.authorization.VaultHierarchySession
osid.authorization.VaultLookupSession
osid.authorization.VaultQuerySession
osid.authorization.VaultSearchResults
osid.authorization.rules.AuthorizationEnablerVaultSession
Description

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

while (vl.hasNext()) {
     Vault vault = vl.getNextVault();
}
                
or
while (vl.hasNext()) {
     Vault[] vaults = vl.getNextVaults(vl.available());
}
                
MethodgetNextVault
Description

Gets the next Vault in this list.

Returnosid.authorization.Vault the next Vault in this list. The hasNext() method should be used to test that a next Vault 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.
MethodgetNextVaults
Description

Gets the next set of Vault elements in this list which must be less than or equal to the return from available().

Parameterscardinaln the number of Vault elements requested which must be less than or equal to available()
Returnosid.authorization.Vault[] an array of Vault 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.