org.osid.checklist

Interface Checklist

All Superinterfaces:

Browsable, Extensible, Federateable, Identifiable, OsidCatalog, OsidObject, Sourceable

public interface Checklist
extends OsidCatalog

A Checklist represents a collection of todos. Like all OSID objects, a Checklist is identified by its Id and any persisted references should use the Id.

Method Summary

Methods

Modifier and Type	Method and Description
ChecklistRecord	getChecklistRecord(Type checklistRecordType) Gets the checklist record corresponding to the given Checklist record Type.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getChecklistRecord

ChecklistRecord getChecklistRecord(Type checklistRecordType)
                                   throws OperationFailedException

Gets the checklist record corresponding to the given Checklist record Type. This method is used to retrieve an object implementing the requested record. The checklistRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(checklistRecordType) is true .

Parameters:

checklistRecordType - the type of checklist record to retrieve

Returns:

the checklist record

Throws:

NullArgumentException - checklistRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(checklistRecordType) is false

Compliance:

mandatory - This method must be implemented.