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.
Modifier and Type | Method and 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.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
Metadata getIssuesMetadata()
mandatory
- This method must be implemented. void setIssues(Id[] issueIds)
issueIds
- the new issuesInvalidArgumentException
- issueIds
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- issueIds
is
null
mandatory
- This method must be implemented. void clearIssues()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. BlockFormRecord getBlockFormRecord(Type blockRecordType) throws OperationFailedException, PermissionDeniedException
BlockFormRecord
corresponding to the given
block record Type.
blockRecordType
- a block record typeNullArgumentException
- blockRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
hasRecordType(blockRecordType)
is false
mandatory
- This method must be implemented.