org.osid.billing

Interface CategoryForm

All Superinterfaces:

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

All Known Subinterfaces:

CategoryBatchForm

public interface CategoryForm
extends OsidObjectForm

This is the form for creating and updating Categories. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the CategoryAdminSession. 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
CategoryFormRecord	getCategoryFormRecord(Type categoryRecordType) Gets the CategoryFormRecord corresponding to the given category 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

getCategoryFormRecord

CategoryFormRecord getCategoryFormRecord(Type categoryRecordType)
                                         throws OperationFailedException

Gets the CategoryFormRecord corresponding to the given category record Type.

Parameters:

categoryRecordType - a category record type

Returns:

the category form record

Throws:

NullArgumentException - categoryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(categoryRecordType) is false

Compliance:

mandatory - This method must be implemented.