org.osid.personnel

Interface OrganizationForm

All Superinterfaces:

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

All Known Subinterfaces:

OrganizationBatchForm

public interface OrganizationForm
extends OsidObjectForm, OsidFederateableForm, OsidTemporalForm

This is the form for creating and updating Organization objects. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the OrganizationAdminSession. 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
void	clearDisplayLabel() Clears the display label.
Metadata	getDisplayLabelMetadata() Gets the metadata for a display label.
OrganizationFormRecord	getOrganizationFormRecord(Type organizationRecordType) Gets the OrganizationFormRecord interface corresponding to the given organization record Type.
void	setDisplayLabel(java.lang.String label) Sets the display label.

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.OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Method Detail

getDisplayLabelMetadata

Metadata getDisplayLabelMetadata()

Gets the metadata for a display label.

Returns:

metadata for the label

Compliance:

mandatory - This method must be implemented.

setDisplayLabel

void setDisplayLabel(java.lang.String label)

Sets the display label.

Parameters:

label - the v

Throws:

InvalidArgumentException - label is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - label is null

Compliance:

mandatory - This method must be implemented.

clearDisplayLabel

void clearDisplayLabel()

Clears the display label.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getOrganizationFormRecord

OrganizationFormRecord getOrganizationFormRecord(Type organizationRecordType)
                                                 throws OperationFailedException

Gets the OrganizationFormRecord interface corresponding to the given organization record Type.

Parameters:

organizationRecordType - the organization record type

Returns:

the record

Throws:

NullArgumentException - organizationRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(organizationRecordType) is false

Compliance:

mandatory - This method must be implemented.