org.osid.id

Interface IdForm

All Superinterfaces:

Identifiable, OsidForm, Suppliable

public interface IdForm
extends OsidForm

This form provides a means of creating an Id.

Method Summary

Methods

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.

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

Method Detail

getAuthorityMetadata

Metadata getAuthorityMetadata()

Gets the metadata for the authority.

Returns:

metadata for the authority

Compliance:

mandatory - This method must be implemented.

setAuthority

void setAuthority(java.lang.String authority)

Sets the authority.

Parameters:

authority - the authority

Throws:

InvalidArgumentException - authority is invalid

NoAccessException - authority cannot be modified

NullArgumentException - authority is null

Compliance:

mandatory - This method must be implemented.

clearAuthority

void clearAuthority()

Clears the authority.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getIdentifierNamespaceMetadata

Metadata getIdentifierNamespaceMetadata()

Gets the metadata for the identifier namespace.

Returns:

metadata for the namespace

Compliance:

mandatory - This method must be implemented.

setIdentifierNamespace

void setIdentifierNamespace(java.lang.String namespace)

Seta the identifier namespace.

Parameters:

namespace - the namespace

Throws:

InvalidArgumentException - namespace is invalid

NoAccessException - namespace cannot be modified

NullArgumentException - namespace is null

Compliance:

mandatory - This method must be implemented.

clearIdentifierNamespace

void clearIdentifierNamespace()

Clears the identifier namespace.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getIdentifierPrefixMetadata

Metadata getIdentifierPrefixMetadata()

Gets the metadata for the identifier prefix.

Returns:

metadata for the prefix

Compliance:

mandatory - This method must be implemented.

setIdentifierPrefix

void setIdentifierPrefix(java.lang.String prefix)

Seta the identifier prefix. An identifier will be generated with this prefix.

Parameters:

prefix - the prefix

Throws:

InvalidArgumentException - prefix is invalid

NoAccessException - prefix cannot be modified

NullArgumentException - prefix is null

Compliance:

mandatory - This method must be implemented.

clearIdentifierPrefix

void clearIdentifierPrefix()

Clears the identifier prefix.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getIdentifierSuffixMetadata

Metadata getIdentifierSuffixMetadata()

Gets the metadata for the identifier suffix.

Returns:

metadata for the suffix

Compliance:

mandatory - This method must be implemented.

setIdentifierSuffix

void setIdentifierSuffix(java.lang.String suffix)

Seta the identifier prefix. An identifier will be generated with this suffix.

Parameters:

suffix - the suffix

Throws:

InvalidArgumentException - suffix is invalid

NoAccessException - suffix cannot be modified

NullArgumentException - suffix is null

Compliance:

mandatory - This method must be implemented.

clearIdentifierSuffix

void clearIdentifierSuffix()

Clears the identifier suffix.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getIdentifierMetadata

Metadata getIdentifierMetadata()

Gets the metadata for the identifier.

Returns:

metadata for the identifier

Compliance:

mandatory - This method must be implemented.

setIdentifier

void setIdentifier(java.lang.String identifier)

Seta the identifier.

Parameters:

identifier - the identifier

Throws:

InvalidArgumentException - identifier is invalid

NoAccessException - identifier cannot be modified

NullArgumentException - identifier is null

Compliance:

mandatory - This method must be implemented.

clearIdentifier

void clearIdentifier()

Clears the identifier.

Throws:

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

Compliance:

mandatory - This method must be implemented.