org.osid.rules.check

Interface AgendaForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, Suppliable

public interface AgendaForm
extends OsidObjectForm

This is the form for creating and updating Agendas. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the AgendaAdminSession. 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
AgendaFormRecord	getAgendaFormRecord(Type agendaRecordType) Gets the AgendaFormRecord corresponding to the given agenda 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

Method Detail

getAgendaFormRecord

AgendaFormRecord getAgendaFormRecord(Type agendaRecordType)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Gets the AgendaFormRecord corresponding to the given agenda record Type.

Parameters:

agendaRecordType - an agenda record type

Returns:

the agenda form record

Throws:

NullArgumentException - agendaRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(agendaRecordType) is false

Compliance:

mandatory - This method must be implemented.