Interface BlockForm

All Superinterfaces:

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

All Known Subinterfaces:

BlockBatchForm

public interface BlockForm
extends OsidObjectForm

This is the form for creating and updating Blocks .Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the BlockAdminSession . For each data element that may be set, metadata may be examined to provide display hints or data constraints.

Method Summary

Modifier and Type	Method	Description
void	clearIssues()	Removes the issues.
BlockFormRecord	getBlockFormRecord(Type blockRecordType)	Gets the BlockFormRecord corresponding to the given block record Type .
Metadata	getIssuesMetadata()	Gets the metadata for the issues.
void	setIssues(Id[] issueIds)	Sets the issues.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Modifier and Type	Method	Description
TypeList	getRequiredRecordTypes()	Gets the minimum required record types for successful submission of this OsidForm .

Methods inherited from interface OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Gets a default locale for the form.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales()	Gets the locales available for this form.
DisplayText[]	getValidationMessages()	Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate()	Tests if this form is for an update operation.
boolean	isValid()	Tests if this form is in a valid state for submission.
void	setJournalComment(String comment)	Sets a comment.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for the form.

Methods inherited from interface OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
Metadata	getDescriptionMetadata()	Gets the metadata for a description.
Metadata	getDisplayNameMetadata()	Gets the metadata for a display name.
Metadata	getGenusTypeMetadata()	Gets the metadata for a genus type.
void	setDescription(String description)	Sets a description.
void	setDisplayName(String displayName)	Sets a display name.
void	setGenusType(Type genusType)	Sets a genus.

Method Details

getIssuesMetadata

Metadata getIssuesMetadata()

Gets the metadata for the issues.

Returns:

metadata for the issues

Compliance:

mandatory - This method must be implemented.

setIssues

void setIssues(Id[] issueIds)

Sets the issues.

Parameters:

issueIds - the new issues

Throws:

InvalidArgumentException - issueIds is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - issueIds is null

Compliance:

mandatory - This method must be implemented.

clearIssues

void clearIssues()

Removes the issues.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getBlockFormRecord

BlockFormRecord getBlockFormRecord(Type blockRecordType)
                            throws OperationFailedException,
PermissionDeniedException

Gets the BlockFormRecord corresponding to the given block record Type .

Parameters:

blockRecordType - a block record type

Returns:

the block form record

Throws:

NullArgumentException - blockRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(blockRecordType) is false

Compliance:

mandatory - This method must be implemented.