OSID Logo
OSID Specifications
journaling package
Version 3.0.0
Release Candidate Preview
Interfaceosid.journaling.Journal
Implementsosid.OsidCatalog
Description

A Journal represents a collection of entries. Like all OSID objects, a Journal is identified by its Id and any persisted references should use the Id.

MethodgetJournalRecord
Description

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

Parametersosid.type.TypejournalRecordTypethe type of journal record to retrieve
Returnosid.journaling.records.JournalRecordthe journal record
ErrorsNULL_ARGUMENT journalRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(journalRecordType) is false
CompliancemandatoryThis method must be implemented.