org.osid.logging

Interface LogForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidCatalogForm, OsidExtensibleForm, OsidFederateableForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidSourceableForm, Suppliable

All Known Subinterfaces:

LogBatchForm

public interface LogForm
extends OsidCatalogForm

This is the form for creating and updating Logs. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the LogAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

Method Summary

Methods

Modifier and Type	Method and Description
LogFormRecord	getLogFormRecord(Type logRecordType) Gets the LogFormRecord corresponding to the given log record Type.

Methods inherited from interface org.osid.OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.OsidSourceableForm

clearBranding, clearLicense, clearProvider, getBrandingMetadata, getLicenseMetadata, getProviderMetadata, setBranding, setLicense, setProvider

Method Detail

getLogFormRecord

LogFormRecord getLogFormRecord(Type logRecordType)
                               throws OperationFailedException

Gets the LogFormRecord corresponding to the given log record Type.

Parameters:

logRecordType - the log record type

Returns:

the log form record

Throws:

NullArgumentException - logRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(logRecordType) is false

Compliance:

mandatory - This method must be implemented.