org.osid.authentication

Interface AgencyForm

All Superinterfaces:

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

All Known Subinterfaces:

AgencyBatchForm, AgentBatchForm

public interface AgencyForm
extends OsidCatalogForm

This is the form for creating and updating agencies. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the AgencyAdminSession. 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
AgencyFormRecord	getAgencyFormRecord(Type agencyRecordType) Gets the AgencyFormRecord corresponding to the given agency 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

getAgencyFormRecord

AgencyFormRecord getAgencyFormRecord(Type agencyRecordType)
                                     throws OperationFailedException

Gets the AgencyFormRecord corresponding to the given agency record Type.

Parameters:

agencyRecordType - an agency record type

Returns:

the agency form record

Throws:

NullArgumentException - agencyRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(agencyRecordType) is false

Compliance:

mandatory - This method must be implemented.