org.osid.tracking

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

Methods

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.

Methods inherited from interface org.osid.OsidObjectForm

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

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

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

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Method Detail

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.