OSID - osid.repository.AssetList Service Interface Definition

Interface	osid.repository.AssetList
Implements	`osid.OsidList`
Used By	`osid.Sourceable`
	`osid.course.syllabus.Docet`
	`osid.learning.Activity`
	`osid.recipe.Direction`
	`osid.recipe.Recipe`
	`osid.repository.AssetCompositionSession`
	`osid.repository.AssetLookupSession`
	`osid.repository.AssetQuerySession`
	`osid.repository.AssetRepositorySession`
	`osid.repository.AssetSearchResults`
	show 1 more…
`osid.repository.AssetSpatialSession`
Description	Like all `OsidLists`, `AssetList` provides a means for accessing `Asset` elements sequentially either one at a time or many at a time. Examples: while (al.hasNext()) { Asset asset = al.getNextAsset(); } or while (al.hasNext()) { Asset[] assets = al.getNextAssets(al.available()); }
Method	getNextAsset
Description	Gets the next `Asset` in this list.
Return	`osid.repository.Asset`		the next `Asset` in this list. The `hasNext()` method should be used to test that a next `Asset` is available before calling this method.
Errors	ILLEGAL_STATE		no more elements available in this list
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getNextAssets
Description	Gets the next set of `Assets` in this list which must be less than or equal to the return from `available()`.
Parameters	`cardinal`	`n`	the number of `Asset` elements requested which must be less than or equal to `available()`
Return	`osid.repository.Asset[]`		an array of `Asset` elements. The length of the array is less than or equal to the number specified.
Errors	ILLEGAL_STATE		no more elements available in this list
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.