OSID Logo
OSID Specifications
calendaring package
Version 3.1.0
Interfaceosid.calendaring.Commitment
Implementsosid.OsidRelationship
Used Byosid.calendaring.CommitmentAdminSession
osid.calendaring.CommitmentList
osid.calendaring.CommitmentLookupSession
Description

A Commitment maps a Resource to an Event.

MethodgetEventId
Description

Gets the event Id.

Returnosid.id.Id the event Id
Compliancemandatory This method must be implemented.
MethodgetEvent
Description

Gets the Event.

Returnosid.calendaring.Event the event
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetResourceId
Description

Gets the resource Id.

Returnosid.id.Id a resource Id
Compliancemandatory This method must be implemented.
MethodgetResource
Description

Gets the Resource.

Returnosid.resource.Resource the resource
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This 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.TypecommitmentRecordType the type of the record to retrieve
Returnosid.calendaring.records.CommitmentRecord the commitment record
ErrorsNULL_ARGUMENT commitmentRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(commitmentRecordType) is false
Compliancemandatory This method must be implemented.