OSID Logo
OSID Specifications
acknowledgement package
Version 3.1.0
Interfaceosid.acknowledgement.Credit
Implementsosid.OsidRelationship
Used Byosid.acknowledgement.CreditAdminSession
osid.acknowledgement.CreditList
osid.acknowledgement.CreditLookupSession
Description

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

MethodgetReferenceId
Description

Gets the Id of the referenced object.

Returnosid.id.Id the reference Id
Compliancemandatory This method must be implemented.
MethodgetResourceId
Description

Gets the Id of the resource in this credit.

Returnosid.id.Id the Resource Id
Compliancemandatory This method must be implemented.
MethodgetResource
Description

Gets the resource in this credit.

Returnosid.resource.Resource the Resource
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This 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.TypecreditRecordType the type of credit record to retrieve
Returnosid.acknowledgement.records.CreditRecord the credit record
ErrorsNULL_ARGUMENT creditRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(creditRecordType) is false
Compliancemandatory This method must be implemented.