org.osid

Interface OsidList

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidList

All Known Subinterfaces:

AcademyBatchFormList, AcademyList, AcademyNodeList, AccountBatchFormList, AccountList, AccountNodeList, ActionBatchFormList, ActionEnablerList, ActionGroupBatchFormList, ActionGroupList, ActionList, ActivityBatchFormList, ActivityBatchFormList, ActivityBatchFormList, ActivityBundleBatchFormList, ActivityBundleList, ActivityList, ActivityList, ActivityList, ActivityNodeList, ActivityPeerList, ActivityRegistrationBatchFormList, ActivityRegistrationList, ActivityRegistrationPeerList, ActivityUnitBatchFormList, ActivityUnitList, AddressBatchFormList, AddressBookBatchFormList, AddressBookList, AddressBookNodeList, AddressList, AgencyBatchFormList, AgencyList, AgencyNodeList, AgendaList, AgentBatchFormList, AgentList, AliasRequestList, AliasResponseList, AllocationList, AnswerBatchFormList, AnswerList, AntimatroidList, AntimatroidNodeList, AppointmentBatchFormList, AppointmentList, AppointmentPeerList, AssessmentBatchFormList, AssessmentEntryBatchFormList, AssessmentEntryList, AssessmentEntryPeerList, AssessmentList, AssessmentOfferedBatchFormList, AssessmentOfferedList, AssessmentPartList, AssessmentRequirementList, AssessmentSectionList, AssessmentTakenBatchFormList, AssessmentTakenList, AssessmentTakenPeerList, AssetBatchFormList, AssetContentList, AssetList, AuctionBatchFormList, AuctionConstrainerEnablerList, AuctionConstrainerList, AuctionHouseBatchFormList, AuctionHouseList, AuctionHouseNodeList, AuctionList, AuctionProcessorEnablerList, AuctionProcessorList, AuditBatchFormList, AuditEnablerList, AuditList, AuthorizationAgentPeerList, AuthorizationBatchFormList, AuthorizationEnablerList, AuthorizationList, AuthorizationResourcePeerList, AuthorizationTrustPeerList, AvailabilityBatchFormList, AvailabilityEnablerList, AvailabilityList, AvailabilityPeerList, AwardBatchFormList, AwardEntryBatchFormList, AwardEntryList, AwardEntryPeerList, AwardList, AwardRequirementList, BallotBatchFormList, BallotConstrainerEnablerList, BallotConstrainerList, BallotList, BankBatchFormList, BankList, BankNodeList, BidBatchFormList, BidList, BidPeerList, BillingBatchFormList, BillingList, BillingNodeList, BinBatchFormList, BinList, BinNodeList, BlockBatchFormList, BlockList, BlogBatchFormList, BlogList, BlogNodeList, BookBatchFormList, BookList, BookNodeList, BranchBatchFormList, BranchList, BrokerBatchFormList, BrokerConstrainerEnablerList, BrokerConstrainerList, BrokerList, BrokerProcessorEnablerList, BrokerProcessorList, BudgetBatchFormList, BudgetEntryBatchFormList, BudgetEntryList, BudgetEntryPeerList, BudgetList, BudgetPeerList, BuildingBatchFormList, BuildingList, BusinessBatchFormList, BusinessBatchFormList, BusinessList, BusinessList, BusinessNodeList, BusinessNodeList, CalendarBatchFormList, CalendarList, CalendarNodeList, CampusBatchFormList, CampusList, CampusNodeList, CandidateBatchFormList, CandidateList, CandidatePeerList, CanonicalUnitBatchFormList, CanonicalUnitEnablerList, CanonicalUnitList, CanonicalUnitProcessorEnablerList, CanonicalUnitProcessorList, CatalogEnablerList, CatalogList, CatalogNodeList, CatalogueBatchFormList, CatalogueList, CatalogueNodeList, CategoryBatchFormList, CategoryList, ChainList, CheckList, ChecklistBatchFormList, ChecklistList, ChecklistNodeList, CheckResultList, CommentBatchFormList, CommentList, CommissionBatchFormList, CommissionEnablerList, CommissionList, CommissionPeerList, CommitmentBatchFormList, CommitmentEnablerList, CommitmentList, CommitmentPeerList, CompetencyBatchFormList, CompetencyList, CompositionBatchFormList, CompositionEnablerList, CompositionList, ConferralBatchFormList, ConferralList, ConferralPeerList, ConfigurationBatchFormList, ConfigurationList, ConfigurationNodeList, ContactBatchFormList, ContactEnablerList, ContactList, ContactPeerList, ControllerBatchFormList, ControllerList, ConvocationBatchFormList, ConvocationList, CookbookBatchFormList, CookbookList, CookbookNodeList, CoordinateList, CostList, CourseBatchFormList, CourseCatalogBatchFormList, CourseCatalogList, CourseCatalogNodeList, CourseEntryBatchFormList, CourseEntryList, CourseEntryPeerList, CourseList, CourseOfferingBatchFormList, CourseOfferingList, CourseOfferingPeerList, CourseRequirementList, CreateResponseList, CredentialBatchFormList, CredentialEntryBatchFormList, CredentialEntryList, CredentialEntryPeerList, CredentialList, CredentialRequirementList, CreditBatchFormList, CreditList, CreditPeerList, CurrencyList, CustomerBatchFormList, CustomerList, CyclicEventBatchFormList, CyclicEventList, CyclicTimePeriodBatchFormList, CyclicTimePeriodList, DateTimeIntervalList, DateTimeList, DeedBatchFormList, DeedList, DeedPeerList, DeleteResponseList, DemographicEnablerList, DemographicList, DepotBatchFormList, DepotList, DepotNodeList, DeviceBatchFormList, DeviceEnablerList, DeviceList, DictionaryBatchFormList, DictionaryList, DictionaryNodeList, DirectionBatchFormList, DirectionList, DirectoryList, DispatchBatchFormList, DispatchList, DistributorBatchFormList, DistributorList, DistributorNodeList, DocetBatchFormList, DocetList, DocetPeerList, DurationList, EdgeBatchFormList, EdgeEnablerList, EdgeList, EdgePeerList, EffortBatchFormList, EffortList, EffortPeerList, EndpointList, EngineList, EngineList, EngineNodeList, EngineNodeList, EnrollmentBatchFormList, EnrollmentList, EnrollmentPeerList, EntryBatchFormList, EntryBatchFormList, EntryBatchFormList, EntryBatchFormList, EntryList, EntryList, EntryList, EntryList, EntryPeerList, EntryPeerList, EventBatchFormList, EventList, FamilyBatchFormList, FamilyList, FamilyNodeList, FileList, FiscalPeriodBatchFormList, FiscalPeriodList, FloorBatchFormList, FloorList, ForumBatchFormList, ForumList, ForumNodeList, FoundryBatchFormList, FoundryList, FoundryNodeList, FrontOfficeBatchFormList, FrontOfficeList, FrontOfficeNodeList, FunctionBatchFormList, FunctionList, GradeBatchFormList, GradebookBatchFormList, GradebookColumnBatchFormList, GradebookColumnCalculationList, GradebookColumnList, GradebookList, GradebookNodeList, GradeEntryBatchFormList, GradeEntryList, GradeEntryPeerList, GradeList, GradeMapList, GradeSystemBatchFormList, GradeSystemList, GradeSystemTransformList, GraphBatchFormList, GraphList, GraphNodeList, HierarchyList, HoldAgentPeerList, HoldBatchFormList, HoldEnablerList, HoldList, HoldResourcePeerList, IdBatchFormList, IdList, IngredientBatchFormList, IngredientList, InputBatchFormList, InputEnablerList, InputList, InputPeerList, InquestBatchFormList, InquestList, InquestNodeList, InquiryBatchFormList, InquiryEnablerList, InquiryList, InstallationContentList, InstallationList, InstructionList, IntersectionBatchFormList, IntersectionList, IntersectionPathList, InventoryBatchFormList, InventoryList, IssueBatchFormList, IssueBatchFormList, IssueList, IssueList, IssuePeerList, ItemBatchFormList, ItemBatchFormList, ItemBatchFormList, ItemBatchFormList, ItemList, ItemList, ItemList, ItemList, ItemPeerList, JobBatchFormList, JobConstrainerEnablerList, JobConstrainerList, JobList, JobProcessorEnablerList, JobProcessorList, JournalBatchFormList, JournalEntryBatchFormList, JournalEntryList, JournalEntryPeerList, JournalList, JournalNodeList, KeyBatchFormList, KeyList, LearningObjectiveRequirementList, LeaseBatchFormList, LeaseList, LeasePeerList, LessonAnchorList, LessonList, LocaleList, LocationBatchFormList, LocationList, LocationNodeList, LogBatchFormList, LogEntryBatchFormList, LogEntryList, LogEntryList, LogList, LogNodeList, MailboxBatchFormList, MailboxList, MailboxNodeList, MapBatchFormList, MapList, MapNodeList, MeetingTimeList, MessageBatchFormList, MessageList, MeterBatchFormList, MeterList, ModelBatchFormList, ModelList, ModuleBatchFormList, ModuleList, NodeBatchFormList, NodeList, NodeList, ObjectiveBankBatchFormList, ObjectiveBankList, ObjectiveBankNodeList, ObjectiveBatchFormList, ObjectiveList, ObjectiveNodeList, ObstacleBatchFormList, ObstacleEnablerList, ObstacleList, OfferingBatchFormList, OfferingConstrainerEnablerList, OfferingConstrainerList, OfferingList, OfferingPeerList, OfficeBatchFormList, OfficeList, OfficeNodeList, OffsetEventBatchFormList, OffsetEventEnablerList, OffsetEventList, OntologyBatchFormList, OntologyList, OntologyNodeList, OrderBatchFormList, OrderList, OrganizationBatchFormList, OrganizationList, OrganizationNodeList, OublietteBatchFormList, OublietteList, OublietteNodeList, PackageBatchFormList, PackageList, ParameterBatchFormList, ParameterList, ParameterProcessorEnablerList, ParameterProcessorList, ParticipantBatchFormList, ParticipantList, ParticipantPeerList, PathBatchFormList, PathList, PathList, PayerBatchFormList, PayerList, PaymentBatchFormList, PaymentList, PaymentPeerList, PeriodBatchFormList, PeriodList, PersonBatchFormList, PersonList, PlanList, PollsBatchFormList, PollsList, PollsNodeList, PoolBatchFormList, PoolConstrainerEnablerList, PoolConstrainerList, PoolList, PoolProcessorEnablerList, PoolProcessorList, PositionBatchFormList, PositionList, PostBatchFormList, PostBatchFormList, PostEntryBatchFormList, PostEntryList, PostList, PostList, PriceBatchFormList, PriceEnablerList, PriceList, PriceScheduleBatchFormList, PriceScheduleList, ProcedureBatchFormList, ProcedureList, ProcessBatchFormList, ProcessEnablerList, ProcessList, ProcessList, ProcessNodeList, ProductBatchFormList, ProductList, ProficiencyBatchFormList, ProficiencyList, ProficiencyPeerList, ProfileBatchFormList, ProfileEntryAgentPeerList, ProfileEntryBatchFormList, ProfileEntryEnablerList, ProfileEntryList, ProfileEntryResourcePeerList, ProfileItemBatchFormList, ProfileItemList, ProfileList, ProfileNodeList, ProgramBatchFormList, ProgramEntryBatchFormList, ProgramEntryList, ProgramEntryPeerList, ProgramList, ProgramOfferingBatchFormList, ProgramOfferingList, ProgramOfferingPeerList, ProgramRequirementList, ProjectBatchFormList, ProjectList, PropertyList, ProvisionableBatchFormList, ProvisionableList, ProvisionablePeerList, ProvisionBatchFormList, ProvisionList, ProvisionPeerList, PublisherBatchFormList, PublisherList, PublisherNodeList, QualifierBatchFormList, QualifierList, QualifierNodeList, QuestionBatchFormList, QuestionList, QueueBatchFormList, QueueBatchFormList, QueueConstrainerEnablerList, QueueConstrainerEnablerList, QueueConstrainerList, QueueConstrainerList, QueueList, QueueList, QueueProcessorEnablerList, QueueProcessorEnablerList, QueueProcessorList, QueueProcessorList, RaceBatchFormList, RaceConstrainerEnablerList, RaceConstrainerList, RaceList, RaceProcessorEnablerList, RaceProcessorList, RaceResultList, ReadingList, RealmBatchFormList, RealmList, RealmNodeList, ReceiptBatchFormList, ReceiptList, RecipeBatchFormList, RecipeList, RecurringEventBatchFormList, RecurringEventEnablerList, RecurringEventList, RegistrationBatchFormList, RegistrationList, RegistrationPeerList, RelationshipBatchFormList, RelationshipEnablerList, RelationshipList, RelationshipPeerList, RelevancyBatchFormList, RelevancyEnablerList, RelevancyList, RelevancyPeerList, RenovationBatchFormList, RenovationList, ReplyBatchFormList, ReplyList, RepositoryBatchFormList, RepositoryList, RepositoryNodeList, RequestBatchFormList, RequestList, RequestPeerList, RequestTransactionBatchFormList, RequestTransactionList, RequestTransactionPeerList, RequisiteList, ResourceBatchFormList, ResourceList, ResourceLocationList, ResourceNodeList, ResourceRelationshipBatchFormList, ResourceRelationshipList, ResourceRelationshipPeerList, ResourceVelocityList, ResponseBatchFormList, ResponseList, ResponseList, ResponsePeerList, ResultBatchFormList, ResultList, RoomBatchFormList, RoomList, RouteList, RouteProgressList, RouteSegmentList, RuleList, SceneBatchFormList, SceneList, ScheduleBatchFormList, ScheduleList, SchedulePeerList, ScheduleSlotBatchFormList, ScheduleSlotList, SequenceRuleEnablerList, SequenceRuleList, SettingBatchFormList, SettingList, ShipmentBatchFormList, ShipmentList, SignalBatchFormList, SignalEnablerList, SignalList, SiteList, SpatialUnitList, SpeedZoneBatchFormList, SpeedZoneEnablerList, SpeedZoneList, StateList, StatisticList, StepBatchFormList, StepConstrainerEnablerList, StepConstrainerList, StepList, StepProcessorEnablerList, StepProcessorList, StockBatchFormList, StockList, StockNodeList, StoreBatchFormList, StoreList, StoreNodeList, SubjectBatchFormList, SubjectList, SubjectNodeList, SubscriptionBatchFormList, SubscriptionEnablerList, SubscriptionList, SubscriptionPeerList, SubtaskIssuePeerList, SummaryList, SummaryList, SupersedingEventEnablerList, SupersedingEventList, SyllabusBatchFormList, SyllabusList, SystemBatchFormList, SystemList, SystemNodeList, TermBatchFormList, TermList, TermNodeList, TimeList, TimePeriodBatchFormList, TimePeriodList, TodoBatchFormList, TodoList, TodoNodeList, TodoProducerList, TriggerBatchFormList, TriggerEnablerList, TriggerList, TrustList, TypeList, UpdateResponseList, UtilityBatchFormList, UtilityList, UtilityNodeList, ValueBatchFormList, ValueEnablerList, ValueList, VaultBatchFormList, VaultList, VaultNodeList, VoteBatchFormList, VoteList, VotePeerList, VoterAllocationList, WarehouseList, WarehouseNodeList, WorkBatchFormList, WorkBatchFormList, WorkflowEventList, WorkList, WorkList

public interface OsidList
extends OsidList, java.io.Closeable

OsidList is the top-level interface for all OSID lists. An OSID list provides sequential access, one at a time or many at a time, access to a set of elements. These elements are not required to be OsidObjects but generally are. The element retrieval methods are defined in the sub-interface of OsidList where the appropriate return type is defined.

Osid lists are a once pass through iteration of elements. The size of the object set and the means in which the element set is generated or stored is not known. Assumptions based on the length of the element set by copying the entire contents of the list into a fixed buffer should be done with caution a awareness that an implementation may return a number of elements ranging from zero to infinity.

Lists are returned by methods when multiple return values are possible. There is no guarantee that successive calls to the same method will return the same set of elements in a list. Unless an order is specified in an interface definition, the order of the elements is not known.

Method Summary

Methods

Modifier and Type	Method and Description
long	available() Gets the number of elements available for retrieval.
boolean	hasNext() Tests if there are more elements in this list.
void	skip(long n) Skip the specified number of elements in the list.

Methods inherited from interface org.osid.binding.java.OsidList

close

Methods inherited from interface java.io.Closeable

close

Method Detail

hasNext

boolean hasNext()

Tests if there are more elements in this list.

Returns:

true if more elements are available in this list, false if the end of the list has been reached

Compliance:

mandatory - This method must be implemented.

Notes:

Any - errors that may result from accesing the underlying set of elements are to be deferred until the consumer attempts retrieval in which case the provider must return true for this method.

available

long available()

Gets the number of elements available for retrieval. The number returned by this method may be less than or equal to the total number of elements in this list. To determine if the end of the list has been reached, the method hasNext() should be used. This method conveys what is known about the number of remaining elements at a point in time and can be used to determine a minimum size of the remaining elements, if known. A valid return is zero even if hasNext() is true. This method does not imply asynchronous usage. All OSID methods may block.

Returns:

the number of elements available for retrieval

Compliance:

mandatory - This method must be implemented.

Notes:

Any - errors that may result from accesing the underlying set of elements are to be deferred until the consumer attempts retrieval in which case the provider must return a positive integer for this method so the consumer can continue execution to receive the error. In all other circumstances, the provider must not return a number greater than the number of elements known since this number will be fed as a parameter to the bulk retrieval method.

skip

void skip(long n)

Skip the specified number of elements in the list. If the number skipped is greater than the number of elements in the list, hasNext() becomes false and available() returns zero as there are no more elements to retrieve.

Parameters:

n - the number of elements to skip

Compliance:

mandatory - This method must be implemented.