public interface TypeForm extends OsidForm
This form provides a means of updating various fields in the
Type.
Note that the domain, authority and identifier are part of
the Type
identification, and as such not modifiable.
Modifier and Type | Method and Description |
---|---|
void |
clearDescription()
Clears the description.
|
void |
clearDisplayLabel()
Clears the display label.
|
void |
clearDisplayName()
Clears the display name.
|
void |
clearDomain()
Clears the domain.
|
Metadata |
getDescriptionMetadata()
Gets the metadata for the description.
|
Metadata |
getDisplayLabelMetadata()
Gets the metadata for the display label.
|
Metadata |
getDisplayNameMetadata()
Gets the metadata for the display name.
|
Metadata |
getDomainMetadata()
Gets the metadata for the domain.
|
void |
setDescription(java.lang.String description)
Sets a description.
|
void |
setDisplayLabel(java.lang.String displayLabel)
Seta a display label.
|
void |
setDisplayName(java.lang.String displayName)
Sets a display name.
|
void |
setDomain(java.lang.String domain)
Sets a domain.
|
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
Metadata getDisplayNameMetadata()
mandatory
- This method must be implemented. void setDisplayName(java.lang.String displayName)
displayName
- the new display nameInvalidArgumentException
- displayName
is invalidNoAccessException
- displayName
cannot
be modifiedNullArgumentException
- displayName
is
null
mandatory
- This method must be implemented. void clearDisplayName()
NoAccessException
- displayName
cannot
be modifiedmandatory
- This method must be implemented. Metadata getDisplayLabelMetadata()
mandatory
- This method must be implemented. void setDisplayLabel(java.lang.String displayLabel)
displayLabel
- the new display labelInvalidArgumentException
- displayLabel
is invalidNoAccessException
- displayLabel
cannot
be modifiedNullArgumentException
- displayLabel
is
null
mandatory
- This method must be implemented. void clearDisplayLabel()
NoAccessException
- displayLabel
cannot
be modifiedmandatory
- This method must be implemented. Metadata getDescriptionMetadata()
mandatory
- This method must be implemented. void setDescription(java.lang.String description)
description
- the new descriptionInvalidArgumentException
- description
is invalidNoAccessException
- description
cannot
be modifiedNullArgumentException
- description
is
null
mandatory
- This method must be implemented. void clearDescription()
NoAccessException
- description
cannot
be modifiedmandatory
- This method must be implemented. Metadata getDomainMetadata()
mandatory
- This method must be implemented. void setDomain(java.lang.String domain)
domain
- the new domainInvalidArgumentException
- domain
is
invalidNoAccessException
- domain
cannot be
modifiedNullArgumentException
- domain
is
null
mandatory
- This method must be implemented. void clearDomain()
NoAccessException
- domain
cannot be
modifiedmandatory
- This method must be implemented.