OSID Logo
OSID Specifications
acknowledgement package
Version 3.0.0
Release Candidate Preview
Interfaceosid.acknowledgement.Credit
Implementsosid.OsidRelationship
Description

A Credit relates a Resource with a reference to an Id .

MethodgetReferenceId
Description

Gets the Id of the referenced object.

Returnosid.id.Idthe reference Id
CompliancemandatoryThis method must be implemented.
MethodgetResourceId
Description

Gets the Id of the resource in this credit.

Returnosid.id.Idthe Resource Id
CompliancemandatoryThis method must be implemented.
MethodgetResource
Description

Gets the resource in this credit.

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

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

Parametersosid.type.TypecreditRecordTypethe type of credit record to retrieve
Returnosid.acknowledgement.records.CreditRecordthe credit record
ErrorsNULL_ARGUMENT creditRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(creditRecordType) is false
CompliancemandatoryThis method must be implemented.