org.osid.calendaring

Interface Calendar

All Superinterfaces:

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

public interface Calendar
extends OsidCatalog

A calendar defines a collection of events.

Method Summary

Methods

Modifier and Type	Method and Description
CalendarRecord	getCalendarRecord(Type calendarRecordType) Gets the record corresponding to the given Calendar 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

getCalendarRecord

CalendarRecord getCalendarRecord(Type calendarRecordType)
                                 throws OperationFailedException

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

Parameters:

calendarRecordType - a calendar record type

Returns:

the calendar record

Throws:

NullArgumentException - calendarRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(calendarRecordType) is false

Compliance:

mandatory - This method must be implemented.