OSID - osid.id.IdForm Service Interface Definition

Interface	osid.id.IdForm
Implements	`osid.OsidForm`
Used By	`osid.id.IdAdminSession`
Description	This form provides a means of creating an `Id`.
Method	getAuthorityMetadata
Description	Gets the metadata for the authority.
Return	`osid.Metadata`		metadata for the authority
Compliance	`mandatory`		This method must be implemented.
Method	setAuthority
Description	Sets the authority.
Parameters	`string`	`authority`	the authority
Errors	INVALID_ARGUMENT		`authority` is invalid
	NO_ACCESS		`authority` cannot be modified
	NULL_ARGUMENT		`authority` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAuthority
Description	Clears the authority.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getIdentifierNamespaceMetadata
Description	Gets the metadata for the identifier namespace.
Return	`osid.Metadata`		metadata for the namespace
Compliance	`mandatory`		This method must be implemented.
Method	setIdentifierNamespace
Description	Seta the identifier namespace.
Parameters	`string`	`namespace`	the namespace
Errors	INVALID_ARGUMENT		`namespace` is invalid
	NO_ACCESS		`namespace` cannot be modified
	NULL_ARGUMENT		`namespace` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearIdentifierNamespace
Description	Clears the identifier namespace.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getIdentifierPrefixMetadata
Description	Gets the metadata for the identifier prefix.
Return	`osid.Metadata`		metadata for the prefix
Compliance	`mandatory`		This method must be implemented.
Method	setIdentifierPrefix
Description	Seta the identifier prefix. An identifier will be generated with this prefix.
Parameters	`string`	`prefix`	the prefix
Errors	INVALID_ARGUMENT		`prefix` is invalid
	NO_ACCESS		`prefix` cannot be modified
	NULL_ARGUMENT		`prefix` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearIdentifierPrefix
Description	Clears the identifier prefix.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getIdentifierSuffixMetadata
Description	Gets the metadata for the identifier suffix.
Return	`osid.Metadata`		metadata for the suffix
Compliance	`mandatory`		This method must be implemented.
Method	setIdentifierSuffix
Description	Seta the identifier prefix. An identifier will be generated with this suffix.
Parameters	`string`	`suffix`	the suffix
Errors	INVALID_ARGUMENT		`suffix` is invalid
	NO_ACCESS		`suffix` cannot be modified
	NULL_ARGUMENT		`suffix` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearIdentifierSuffix
Description	Clears the identifier suffix.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getIdentifierMetadata
Description	Gets the metadata for the identifier.
Return	`osid.Metadata`		metadata for the identifier
Compliance	`mandatory`		This method must be implemented.
Method	setIdentifier
Description	Seta the identifier.
Parameters	`string`	`identifier`	the identifier
Errors	INVALID_ARGUMENT		`identifier` is invalid
	NO_ACCESS		`identifier` cannot be modified
	NULL_ARGUMENT		`identifier` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearIdentifier
Description	Clears the identifier.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.