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 OsidForms, 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

Modifier and Type	Method	Description
void	clearAffirmationRequired()	Removes the affirmation required flag.
void	clearAuditors()	Removes the auditors.
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.
Metadata	getAuditorsMetadata()	Gets the metadata for the auditors.
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	setAuditors(IdList auditorIds)	Sets the auditors.
void	setNeedsOneResponse(boolean one)	Sets the needs one response flag.
void	setQuestion(String question)	Sets the question.
void	setRequired(boolean required)	Sets the required flag.

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 OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Modifier and Type	Method	Description
void	clearDisabled()	Removes the administratively disabled flag.
void	clearEnabled()	Removes the administratively enabled flag.
Metadata	getDisabledMetadata()	Gets the metadata for the disabled flag.
Metadata	getEnabledMetadata()	Gets the metadata for the enabled flag.
void	setDisabled(boolean disabled)	Sets the administratively disabled flag.
void	setEnabled(boolean enabled)	Sets the administratively enabled flag.

Methods inherited from interface OsidRuleForm

clearConditionRecordTypes, clearRule, getConditionRecordTypesMetadata, getRuleMetadata, setConditionRecordTypes, setRule

Modifier and Type	Method	Description
void	clearConditionRecordTypes()	Clears the condition record types.
void	clearRule()	Removes the rule.
Metadata	getConditionRecordTypesMetadata()	Gets the metadata for the condition record types.
Metadata	getRuleMetadata()	Gets the metadata for an associated rule.
void	setConditionRecordTypes(Type[] conditionRecordTypes)	Sets the condition record types.
void	setRule(Id ruleId)	Sets a rule.

Method Details

getAuditorsMetadata

Metadata getAuditorsMetadata()

Gets the metadata for the auditors.

Returns:

metadata for the auditors

Compliance:

mandatory - This method must be implemented.

setAuditors

void setAuditors(IdList auditorIds)

Sets the auditors.

Parameters:

auditorIds - the new auditors

Throws:

InvalidArgumentException - auditorIds is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - auditorIds is null

Compliance:

mandatory - This method must be implemented.

clearAuditors

void clearAuditors()

Removes the auditors.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getQuestionMetadata

Metadata getQuestionMetadata()

Gets the metadata for the question.

Returns:

metadata for the question

Compliance:

mandatory - This method must be implemented.

setQuestion

void setQuestion(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.