public interface IdForm extends OsidForm
This form provides a means of creating an Id.
Modifier and Type | Method and Description |
---|---|
void |
clearAuthority()
Clears the authority.
|
void |
clearIdentifier()
Clears the identifier.
|
void |
clearIdentifierNamespace()
Clears the identifier namespace.
|
void |
clearIdentifierPrefix()
Clears the identifier prefix.
|
void |
clearIdentifierSuffix()
Clears the identifier suffix.
|
Metadata |
getAuthorityMetadata()
Gets the metadata for the authority.
|
Metadata |
getIdentifierMetadata()
Gets the metadata for the identifier.
|
Metadata |
getIdentifierNamespaceMetadata()
Gets the metadata for the identifier namespace.
|
Metadata |
getIdentifierPrefixMetadata()
Gets the metadata for the identifier prefix.
|
Metadata |
getIdentifierSuffixMetadata()
Gets the metadata for the identifier suffix.
|
void |
setAuthority(java.lang.String authority)
Sets the authority.
|
void |
setIdentifier(java.lang.String identifier)
Seta the identifier.
|
void |
setIdentifierNamespace(java.lang.String namespace)
Seta the identifier namespace.
|
void |
setIdentifierPrefix(java.lang.String prefix)
Seta the identifier prefix.
|
void |
setIdentifierSuffix(java.lang.String suffix)
Seta the identifier prefix.
|
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
Metadata getAuthorityMetadata()
mandatory
- This method must be implemented. void setAuthority(java.lang.String authority)
authority
- the authorityInvalidArgumentException
- authority
is
invalidNoAccessException
- authority
cannot be
modifiedNullArgumentException
- authority
is
null
mandatory
- This method must be implemented. void clearAuthority()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getIdentifierNamespaceMetadata()
mandatory
- This method must be implemented. void setIdentifierNamespace(java.lang.String namespace)
namespace
- the namespaceInvalidArgumentException
- namespace
is
invalidNoAccessException
- namespace
cannot be
modifiedNullArgumentException
- namespace
is
null
mandatory
- This method must be implemented. void clearIdentifierNamespace()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getIdentifierPrefixMetadata()
mandatory
- This method must be implemented. void setIdentifierPrefix(java.lang.String prefix)
prefix
- the prefixInvalidArgumentException
- prefix
is
invalidNoAccessException
- prefix
cannot be
modifiedNullArgumentException
- prefix
is
null
mandatory
- This method must be implemented. void clearIdentifierPrefix()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getIdentifierSuffixMetadata()
mandatory
- This method must be implemented. void setIdentifierSuffix(java.lang.String suffix)
suffix
- the suffixInvalidArgumentException
- suffix
is
invalidNoAccessException
- suffix
cannot be
modifiedNullArgumentException
- suffix
is
null
mandatory
- This method must be implemented. void clearIdentifierSuffix()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getIdentifierMetadata()
mandatory
- This method must be implemented. void setIdentifier(java.lang.String identifier)
identifier
- the identifierInvalidArgumentException
- identifier
is
invalidNoAccessException
- identifier
cannot be
modifiedNullArgumentException
- identifier
is
null
mandatory
- This method must be implemented. void clearIdentifier()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented.