public interface IssueForm extends OsidRelationshipForm
This is the form for creating and updating Issues.
Like
all OsidForm
objects, various data elements may be set here
for use in the create and update methods in the IssueAdminSession.
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 |
clearCustomer()
Removes the customer.
|
void |
clearDueDate()
Removes the due date.
|
void |
clearPriorityType()
Removes the priority type.
|
void |
clearTopic()
Removes the topic.
|
Metadata |
getCustomerMetadata()
Gets the metadata for the customer.
|
Metadata |
getDueDateMetadata()
Gets the metadata for the due date.
|
IssueFormRecord |
getIssueFormRecord(Type issueRecordType)
Gets the
IssueFormRecord corresponding to the given
issue record Type. |
Metadata |
getPriorityTypeMetadata()
Gets the metadata for the priority type.
|
Metadata |
getTopicMetadata()
Gets the metadata for the topic.
|
void |
setCustomer(Id resourceId)
Sets the customer.
|
void |
setDueDate(DateTime topicId)
Sets the due date.
|
void |
setPriorityType(Type priorityType)
Sets the priority type.
|
void |
setTopic(Id topicId)
Sets the topic.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate
Metadata getPriorityTypeMetadata()
mandatory
- This method must be implemented. void setPriorityType(Type priorityType)
priorityType
- the new priority typeInvalidArgumentException
- priorityType
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- priorityType
is
null
mandatory
- This method must be implemented. void clearPriorityType()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getCustomerMetadata()
mandatory
- This method must be implemented. void setCustomer(Id resourceId)
resourceId
- the new customerInvalidArgumentException
- resourceId
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- resourceId
is
null
mandatory
- This method must be implemented. void clearCustomer()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getTopicMetadata()
mandatory
- This method must be implemented. void setTopic(Id topicId)
topicId
- the new topicInvalidArgumentException
- topicId
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- topicId
is
null
mandatory
- This method must be implemented. void clearTopic()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getDueDateMetadata()
mandatory
- This method must be implemented. void setDueDate(DateTime topicId)
topicId
- the new due dateInvalidArgumentException
- date
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- date
is
null
mandatory
- This method must be implemented. void clearDueDate()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. IssueFormRecord getIssueFormRecord(Type issueRecordType) throws OperationFailedException
IssueFormRecord
corresponding to the given
issue record Type.
issueRecordType
- a issue record typeNullArgumentException
- issueRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(issueRecordType)
is false
mandatory
- This method must be implemented.