Interface IssueForm

All Superinterfaces:

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

All Known Subinterfaces:

IssueBatchForm

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.

Method Summary

Modifier and Type	Method	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.

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.

Methods inherited from interface OsidRelationshipForm

clearEndReason, getEndReasonMetadata, setEndReason

Modifier and Type	Method	Description
void	clearEndReason()	Removes the end reason.
Metadata	getEndReasonMetadata()	Gets the metadata for the end reason.
void	setEndReason(Id stateId)	Sets the end reason.

Methods inherited from interface OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Modifier and Type	Method	Description
void	clearEndDate()	Clears the end date.
void	clearStartDate()	Clears the start date.
Metadata	getEndDateMetadata()	Gets the metadata for an end date.
Metadata	getStartDateMetadata()	Gets the metadata for a start date.
void	setEndDate(DateTime date)	Sets the end date.
void	setStartDate(DateTime date)	Sets the start date.

Method Details

getPriorityTypeMetadata

Metadata getPriorityTypeMetadata()

Gets the metadata for the priority type.

Returns:

metadata for the priority type

Compliance:

mandatory - This method must be implemented.

setPriorityType

void setPriorityType(Type priorityType)

Sets the priority type.

Parameters:

priorityType - the new priority type

Throws:

InvalidArgumentException - priorityType is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - priorityType is null

Compliance:

mandatory - This method must be implemented.

clearPriorityType

void clearPriorityType()

Removes the priority type.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getCustomerMetadata

Metadata getCustomerMetadata()

Gets the metadata for the customer.

Returns:

metadata for the customer

Compliance:

mandatory - This method must be implemented.

setCustomer

void setCustomer(Id resourceId)

Sets the customer.

Parameters:

resourceId - the new customer

Throws:

InvalidArgumentException - resourceId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearCustomer

void clearCustomer()

Removes the customer.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getTopicMetadata

Metadata getTopicMetadata()

Gets the metadata for the topic.

Returns:

metadata for the topic

Compliance:

mandatory - This method must be implemented.

setTopic

void setTopic(Id topicId)

Sets the topic.

Parameters:

topicId - the new topic

Throws:

InvalidArgumentException - topicId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - topicId is null

Compliance:

mandatory - This method must be implemented.

clearTopic

void clearTopic()

Removes the topic.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getDueDateMetadata

Metadata getDueDateMetadata()

Gets the metadata for the due date.

Returns:

metadata for the due date

Compliance:

mandatory - This method must be implemented.

setDueDate

void setDueDate(DateTime topicId)

Sets the due date.

Parameters:

topicId - the new due date

Throws:

InvalidArgumentException - date is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - date is null

Compliance:

mandatory - This method must be implemented.

clearDueDate

void clearDueDate()

Removes the due date.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getIssueFormRecord

IssueFormRecord getIssueFormRecord(Type issueRecordType)
                            throws OperationFailedException

Gets the IssueFormRecord corresponding to the given issue record Type .

Parameters:

issueRecordType - a issue record type

Returns:

the issue form record

Throws:

NullArgumentException - issueRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(issueRecordType) is false

Compliance:

mandatory - This method must be implemented.