OSID Logo
OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.Commitment
Implementsosid.OsidRelationship
Description

A Commitment maps a Resource to an Event.

MethodgetEventId
Description

Gets the event Id.

Returnosid.id.Idthe event Id
CompliancemandatoryThis method must be implemented.
MethodgetEvent
Description

Gets the Event.

Returnosid.calendaring.Eventthe event
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetResourceId
Description

Gets the resource Id.

Returnosid.id.Ida resource Id
CompliancemandatoryThis method must be implemented.
MethodgetResource
Description

Gets the Resource.

Returnosid.resource.Resourcethe resource
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetCommitmentRecord
Description

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

Parametersosid.type.TypecommitmentRecordTypethe type of the record to retrieve
Returnosid.calendaring.records.CommitmentRecordthe commitment record
ErrorsNULL_ARGUMENT commitmentRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(commitmentRecordType) is false
CompliancemandatoryThis method must be implemented.