OSID - osid.OsidRequest Service Interface Definition

Interface	osid.OsidRequest
Implements	`osid.OsidObject`
Implemented By	`osid.course.registration.request.RegistrationRequest`
Description	`OsidRequest` is the top level interface for `OsidObjects` used to submit and process transactional requests. An `OsidRequest` typically has a submitting `Agent` and is acommpanied by a set of request item `Subjugateables` reprsenting the parts or line items of the `OsidReques` t. `OsidRequests` have an explicit state model: not submitted submitted processed error cancelled Additional states may be added through an `OsidRecord` or orchestrated `Process` .
Method	getPostingDate
Description	Gets the posting date of the request.
Return	`osid.calendaring.DateTime`	the request date
Compliance	`mandatory`	This method must be implemented.
Method	getRequesterId
Description	Gets the `Id` of the requester.
Return	`osid.id.Id`	the resource `Id`
Compliance	`mandatory`	This method must be implemented.
Method	getRequester
Description	Gets the requester.
Return	`osid.resource.Resource`	the resource
Errors	OPERATION_FAILED	unable to complete request
Compliance	`mandatory`	This method must be implemented.
Method	isSubmitted
Description	Tests if this request has been submitted.
Return	`boolean`	true if this request has been submitted, false otherwise
Compliance	`mandatory`	This method must be implemented.
Method	getSubmittedDate
Description	Gets the date the request was submitted.
Return	`osid.calendaring.DateTime`	the submission date
Errors	ILLEGAL_STATE	`isSubmitted()` is `false`
Compliance	`mandatory`	This method must be implemented.
Method	getSubmitterId
Description	Gets the `Id` of the submittor.
Return	`osid.id.Id`	the resource `Id`
Compliance	`mandatory`	This method must be implemented.
Method	getSubmitter
Description	Gets the submittor.
Return	`osid.resource.Resource`	the resource
Errors	ILLEGAL_STATE	`isSubmitted()` is `false`
Errors	OPERATION_FAILED	unable to complete request
Compliance	`mandatory`	This method must be implemented.
Method	getSubmittingAgentId
Description	Gets the `Id` of the submitting agent.
Return	`osid.id.Id`	the submitting agent `Id`
Errors	ILLEGAL_STATE	`isSubmitted()` is `false`
Compliance	`mandatory`	This method must be implemented.
Method	getSubmittingAgent
Description	Gets the submitting agent.
Return	`osid.authentication.Agent`	the submitting agent
Errors	ILLEGAL_STATE	`isSubmitted()` is `false`
Errors	OPERATION_FAILED	unable to complete request
Compliance	`mandatory`	This method must be implemented.
Method	isCanceled
Description	Tests if this request has been canceled.
Return	`boolean`	true if this request has been canceled, false otherwise
Compliance	`mandatory`	This method must be implemented.
Method	getCanceledDate
Description	Gets the date the request was canceled.
Return	`osid.calendaring.DateTime`	the cancel date
Errors	ILLEGAL_STATE	`isCanceled()` is `false`
Compliance	`mandatory`	This method must be implemented.
Method	isProcessed
Description	Tests if this request has been processed.
Return	`boolean`	true if this request has been processed, false otherwise
Compliance	`mandatory`	This method must be implemented.
Method	getProcessedDate
Description	Gets the date the request processing completed.
Return	`osid.calendaring.DateTime`	the procsssed date
Errors	ILLEGAL_STATE	`isProcessed()` is `false`
Compliance	`mandatory`	This method must be implemented.
Method	hasError
Description	Tests if this request has been processed but not fulfilled due to error.
Return	`boolean`	true if this request has error, false otherwise
Compliance	`mandatory`	This method must be implemented.
Method	getErrorId
Description	Gets the `Id` of the error state.
Return	`osid.id.Id`	the state `Id`
Errors	ILLEGAL_STATE	`hasError()` is `false`
Compliance	`mandatory`	This method must be implemented.
Method	getError
Description	Gets the error state.
Return	`osid.process.State`	the state
Errors	ILLEGAL_STATE	`hasError()` is `false`
Errors	OPERATION_FAILED	unable to complete request
Compliance	`mandatory`	This method must be implemented.