org.osid.inquiry

Interface InquiryForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidRuleForm, OsidSubjugateableForm, Suppliable

All Known Subinterfaces:

AuditBatchForm, InquiryBatchForm

public interface InquiryForm
extends OsidRuleForm, OsidSubjugateableForm

This is the form for creating and updating Inquiries. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the InquiryAdminSession. 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	clearAffirmationRequired() Removes the affirmation required flag.
void	clearNeedsOneResponse() Removes the needs one response flag.
void	clearQuestion() Removes the question.
void	clearRequired() Removes the required flag.
Metadata	getAffirmationRequiredMetadata() Gets the metadata for the affirmation required flag.
InquiryFormRecord	getInquiryFormRecord(Type inquiryRecordType) Gets the InquiryFormRecord corresponding to the given inquiry record Type.
Metadata	getNeedsOneResponseMetadata() Gets the metadata for the needs one response flag.
Metadata	getQuestionMetadata() Gets the metadata for the question.
Metadata	getRequiredMetadata() Gets the metadata for the required flag.
void	setAffirmationRequired(boolean required) Sets the affirmation required flag.
void	setNeedsOneResponse(boolean one) Sets the needs one response flag.
void	setQuestion(java.lang.String question) Sets the question.
void	setRequired(boolean required) Sets the required flag.

Methods inherited from interface org.osid.OsidRuleForm

clearRule, getRuleMetadata, setRule

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.OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Method Detail

getQuestionMetadata

Metadata getQuestionMetadata()

Gets the metadata for the question.

Returns:

metadata for the question

Compliance:

mandatory - This method must be implemented.

setQuestion

void setQuestion(java.lang.String question)

Sets the question.

Parameters:

question - the new question

Throws:

InvalidArgumentException - question is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - question is null

Compliance:

mandatory - This method must be implemented.

clearQuestion

void clearQuestion()

Removes the question.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getRequiredMetadata

Metadata getRequiredMetadata()

Gets the metadata for the required flag.

Returns:

metadata for the required flag

Compliance:

mandatory - This method must be implemented.

setRequired

void setRequired(boolean required)

Sets the required flag.

Parameters:

required - true is the inquiry requires a response, false if optional

Throws:

InvalidArgumentException - required is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearRequired

void clearRequired()

Removes the required flag.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getAffirmationRequiredMetadata

Metadata getAffirmationRequiredMetadata()

Gets the metadata for the affirmation required flag.

Returns:

metadata for the required flag

Compliance:

mandatory - This method must be implemented.

setAffirmationRequired

void setAffirmationRequired(boolean required)

Sets the affirmation required flag.

Parameters:

required - true if a positive response is required, false if a negative response is also acceptable

Throws:

InvalidArgumentException - required is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearAffirmationRequired

void clearAffirmationRequired()

Removes the affirmation required flag.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getNeedsOneResponseMetadata

Metadata getNeedsOneResponseMetadata()

Gets the metadata for the needs one response flag.

Returns:

metadata for the needs one response flag

Compliance:

mandatory - This method must be implemented.

setNeedsOneResponse

void setNeedsOneResponse(boolean one)

Sets the needs one response flag.

Parameters:

one - true if only one effective response is needed,, false if the inquiry should be performed each time

Throws:

InvalidArgumentException - one is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearNeedsOneResponse

void clearNeedsOneResponse()

Removes the needs one response flag.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getInquiryFormRecord

InquiryFormRecord getInquiryFormRecord(Type inquiryRecordType)
                                       throws OperationFailedException

Gets the InquiryFormRecord corresponding to the given inquiry record Type.

Parameters:

inquiryRecordType - an inquiry record type

Returns:

the inquiry form record

Throws:

NullArgumentException - inquiryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(inquiryRecordType) is false

Compliance:

mandatory - This method must be implemented.