OSID Logo
OSID Specifications
resource package
Version 3.1.0
Interfaceosid.resource.ResourceList
Implementsosid.OsidList
Used Byosid.calendaring.Event
osid.calendaring.OffsetEvent
osid.calendaring.RecurringEvent
osid.course.Activity
osid.course.Course
osid.course.CourseOffering
osid.course.program.Program
osid.course.program.ProgramOffering
osid.hold.Issue
osid.inquiry.Inquiry
show 25 more…
osid.mapping.route.ResourceRouteSession
osid.messaging.Message
osid.offering.CanonicalUnit
osid.offering.Offering
osid.provisioning.Broker
osid.provisioning.Pool
osid.provisioning.Queue
osid.recognition.Convocation
osid.repository.Asset
osid.resource.GroupSession
osid.resource.ResourceBinSession
osid.resource.ResourceLookupSession
osid.resource.ResourceQuerySession
osid.resource.ResourceSearchResults
osid.resource.demographic.Demographic
osid.resourcing.Job
osid.resourcing.JobResourcingSession
osid.room.Room
osid.subscription.Dispatch
osid.tracking.IssueResourcingSession
osid.tracking.Queue
osid.tracking.QueueResourcingSession
osid.voting.Ballot
osid.workflow.Process
osid.workflow.Step
Description

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

while (rl.hasNext()) {
     Resource resource = rl.getNextResource();
}
                
or
while (rl.hasNext()) {
     Resource[] resources = rl.getNextResources(rl.available());
}
                
MethodgetNextResource
Description

Gets the next Resource in this list.

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

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

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