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.
Modifier and Type | Method and Description |
---|---|
AgencyFormRecord |
getAgencyFormRecord(Type agencyRecordType)
Gets the
AgencyFormRecord corresponding to the given
agency record Type. |
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
clearBranding, clearLicense, clearProvider, getBrandingMetadata, getLicenseMetadata, getProviderMetadata, setBranding, setLicense, setProvider
AgencyFormRecord getAgencyFormRecord(Type agencyRecordType) throws OperationFailedException
AgencyFormRecord
corresponding to the given
agency record Type.
agencyRecordType
- an agency record typeNullArgumentException
- agencyRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(agencyRecordType)
is false
mandatory
- This method must be implemented.