public interface Journal extends OsidCatalog
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.
Modifier and Type | Method and Description |
---|---|
JournalRecord |
getJournalRecord(Type journalRecordType)
Gets the journal record corresponding to the given
Journal
record Type. |
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
JournalRecord getJournalRecord(Type journalRecordType) throws OperationFailedException
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
.journalRecordType
- the type of journal record to retrieveNullArgumentException
- journalRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(journalRecordType)
is false
mandatory
- This method must be implemented.