OSID - osid.OsidRequestForm Service Interface Definition

Interface	osid.OsidRequestForm
Implements	`osid.OsidObjectForm`
Implemented By	`osid.course.registration.request.RegistrationRequestForm`
Description	This form is used to create and update rules.
Method	getPostingDateMetadata
Description	Gets the metadata for the posting date.
Return	`osid.Metadata`		metadata for the posting date
Compliance	`mandatory`		This method must be implemented.
Method	setPostingDate
Description	Sets the posting date.
Parameters	`osid.calendaring.DateTime`	`date`	the new posting date
Errors	INVALID_ARGUMENT		`date` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`date` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearPostingDate
Description	Removes the posting date.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getRequesterMetadata
Description	Gets the metadata for the requester.
Return	`osid.Metadata`		metadata for the requester.
Compliance	`mandatory`		This method must be implemented.
Method	setRequester
Description	Sets the requester.
Parameters	`osid.id.Id`	`resourceId`	the new requester
Errors	INVALID_ARGUMENT		`resourceId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`resourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRequester
Description	Removes the requester.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getSubmittedDateMetadata
Description	Gets the metadata for the submitted date.
Return	`osid.Metadata`		metadata for the submitted date
Compliance	`mandatory`		This method must be implemented.
Method	setSubmittedDate
Description	Sets the submitted date.
Parameters	`osid.calendaring.DateTime`	`date`	the new submitted date
Errors	INVALID_ARGUMENT		`date` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`date` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSubmittedDate
Description	Removes the submitted date.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getSubmitterMetadata
Description	Gets the metadata for the submitter.
Return	`osid.Metadata`		metadata for the submitter
Compliance	`mandatory`		This method must be implemented.
Method	setSubmitter
Description	Sets the submitter.
Parameters	`osid.id.Id`	`resourceId`	the new submitter
Errors	INVALID_ARGUMENT		`resourceId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`resourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSubmitter
Description	Removes the submitter.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getSubmittingAgentMetadata
Description	Gets the metadata for the submitting agent.
Return	`osid.Metadata`		metadata for the submitting agent.
Compliance	`mandatory`		This method must be implemented.
Method	setSubmittingAgent
Description	Sets the submitting agent.
Parameters	`osid.id.Id`	`agentId`	the new submitting agent
Errors	INVALID_ARGUMENT		`agentId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`agentId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSubmittingAgent
Description	Removes the submitting agent.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCanceledMetadata
Description	Gets the metadata for the cancelation.
Return	`osid.Metadata`		metadata for the cancelation
Compliance	`mandatory`		This method must be implemented.
Method	setCanceled
Description	Sets canceled.
Parameters	`boolean`	`canceled`	the new canceled state
Errors	INVALID_ARGUMENT		`canceled` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearCanceled
Description	Removes canceled.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCanceledDateMetadata
Description	Gets the metadata for the canceled date.
Return	`osid.Metadata`		metadata for the canceled date
Compliance	`mandatory`		This method must be implemented.
Method	setCanceledDate
Description	Sets the canceled date.
Parameters	`osid.calendaring.DateTime`	`date`	the new canceled date
Errors	INVALID_ARGUMENT		`date` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`date` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCanceledDate
Description	Removes the canceled date.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getProcessedMetadata
Description	Gets the metadata for the processed flag.
Return	`osid.Metadata`		metadata for processed
Compliance	`mandatory`		This method must be implemented.
Method	setProcessed
Description	Sets processed.
Parameters	`boolean`	`processed`	the new processed state
Errors	INVALID_ARGUMENT		`processed` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearProcessed
Description	Removes processed.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getProcessedDateMetadata
Description	Gets the metadata for the processed date.
Return	`osid.Metadata`		metadata for the processed date
Compliance	`mandatory`		This method must be implemented.
Method	setProcessedDate
Description	Sets the processed date.
Parameters	`osid.calendaring.DateTime`	`date`	the new processed date
Errors	INVALID_ARGUMENT		`date` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`date` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearProcessedDate
Description	Removes the processed date.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getErrorMetadata
Description	Gets the metadata for the error state.
Return	`osid.Metadata`		metadata for the error state
Compliance	`mandatory`		This method must be implemented.
Method	setError
Description	Sets the error state.
Parameters	`osid.id.Id`	`stateId`	the new error state
Errors	INVALID_ARGUMENT		`stateId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`stateId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearErrorState
Description	Removes the error state.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.