| Name | Proposal | |
|---|---|---|
| Version | ||
| Included Services | SearchService, DictionaryService | |
| Java Package | org.kuali.student.r2.core.proposal.service | |
| Method | getProposal | ||
|---|---|---|---|
| Description | Retrieves the details of a single Proposal by proposalId | ||
| Parameters | String | proposalId | Id of the proposal |
| ContextInfo | contextInfo | ??? | |
| Return | ProposalInfo | ??? | |
| Errors | DoesNotExistException | Proposal doesnt not exist | |
| InvalidParameterException | Invalid proposal id in the parameter | ||
| MissingParameterException | Missing proposal id | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| Method | getProposalsByIds | ||
|---|---|---|---|
| Description | Retrieves the list of Proposals for the supplied list of proposalIds | ||
| Parameters | StringList | proposalIds | list of proposal identifiers |
| ContextInfo | contextInfo | ??? | |
| Return | ProposalInfoList | List of proposals that match the supplied proposalId list | |
| Errors | DoesNotExistException | One or more proposalIds not found | |
| InvalidParameterException | One or more invalid proposalId | ||
| MissingParameterException | missing proposalIds | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | ??? | ||
| Method | getProposalsByProposalType | ||
|---|---|---|---|
| Description | Retrieves the list of Proposals for the supplied Proposal Type | ||
| Parameters | String | proposalTypeKey | key of the proposal type |
| ContextInfo | contextInfo | ??? | |
| Return | ProposalInfoList | List of proposal information | |
| Errors | DoesNotExistException | proposalTypeKey not found | |
| InvalidParameterException | invalid proposalTypeKey | ||
| MissingParameterException | missing proposalTypeKey | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | ??? | ||
| Method | getProposalsByReference | ||
|---|---|---|---|
| Description | Retrieves the list of Proposals for the specified Reference Type and Reference Id |
||
| Parameters | String | referenceTypeKey | Key of the Reference Type |
| String | referenceId | Identifier of the reference | |
| ContextInfo | contextInfo | ??? | |
| Return | ProposalInfoList | list of Proposal information | |
| Errors | DoesNotExistException | referenceTypeKey or referenceId not found | |
| InvalidParameterException | invalid referenceTypeKey or referenceId | ||
| MissingParameterException | missing referenceTypeKey or referenceId | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | ??? | ||
| Method | getProposalsByState | ||
|---|---|---|---|
| Description | Retrieves the list of Proposals for the specified proposal type and state | ||
| Parameters | String | proposalState | Proposal State |
| String | proposalTypeKey | Proposal Type. | |
| ContextInfo | contextInfo | ??? | |
| Return | ProposalInfoList | list of Proposal information | |
| Errors | DoesNotExistException | proposalTypeKey not found | |
| InvalidParameterException | invalid proposalState or proposalTypeKey |
||
| MissingParameterException | missing proposalState or proposalTypeKey |
||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | ??? | ||
| Method | getProposalByWorkflowId | ||
|---|---|---|---|
| Description | ??? | ||
| Parameters | String | workflowId | Workflow id |
| ContextInfo | contextInfo | ??? | |
| Return | ProposalInfo | Proposal Information | |
| Errors | DoesNotExistException | workflowId not found | |
| InvalidParameterException | invalid workflowId | ||
| MissingParameterException | missing workflowId | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | ??? | ||
| Method | validateProposal | ||
|---|---|---|---|
| Description | Validates a proposal. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained subobjects or expanded to perform all tests related to this object. If an identifier is present for the proposal and a record is found for that identifier, the validation checks if the proposal can be shifted to the new values. If a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationType to the current object. This is a slightly different pattern from the standard validation as the caller provides the identifier in the create statement instead of the server assigning an identifier. |
||
| Parameters | String | validationTypeKey | Identifier of the extent of validation |
| ProposalInfo | proposalInfo | The proposal information to be tested. | |
| ContextInfo | contextInfo | ??? | |
| Return | ValidationResultInfoList | Results from performing the validation | |
| Errors | DoesNotExistException | validationTypeKey not found | |
| InvalidParameterException | invalid validationTypeKey, proposalInfo | ||
| MissingParameterException | missing validationTypeKey, proposalInfo | ||
| OperationFailedException | unable to complete request | ||
| Method | createProposal | ||
|---|---|---|---|
| Description | Creates a new Proposal | ||
| Parameters | String | proposalTypeKey | identifier of the Proposal Type for the Proposal being created |
| ProposalInfo | proposalInfo | information about the Proposal being created | |
| ContextInfo | contextInfo | ??? | |
| Return | ProposalInfo | the created Proposal information | |
| Errors | AlreadyExistsException | Proposal already exists | |
| DataValidationErrorException | One or more values invalid for this operation |
||
| DoesNotExistException | proposalTypeKey not found | ||
| InvalidParameterException | invalid proposalTypeKey, proposalInfo | ||
| MissingParameterException | missing proposalTypeKey, proposalInfo | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| ReadOnlyException | ??? | ||
| Method | updateProposal | ||
|---|---|---|---|
| Description | Updates an existing CLU | ||
| Parameters | String | proposalId | identifier for the Proposal to be updated |
| ProposalInfo | proposalInfo | updated information about the Proposal | |
| ContextInfo | contextInfo | ??? | |
| Return | ProposalInfo | the updated Proposal information | |
| Errors | DataValidationErrorException | One or more values invalid for this operation |
|
| DoesNotExistException | proposalId not found | ||
| InvalidParameterException | invalid proposalId, proposalInfo | ||
| MissingParameterException | missing proposalId, proposalInfo | ||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||
| VersionMismatchException | The action was attempted on an out of date version. |
||
| Method | deleteProposal | ||
|---|---|---|---|
| Description | Deletes an existing Proposal | ||
| Parameters | String | proposalId | identifier for the Proposal to be deleted |
| ContextInfo | contextInfo | ??? | |
| Return | StatusInfo | status of the operation | |
| Errors | DoesNotExistException | proposalId not found | |
| InvalidParameterException | invalid proposalId | ||
| MissingParameterException | missing proposalId | ||
| DependentObjectsExistException | delete would leave orphaned objects or violate integrity constraints |
||
| OperationFailedException | unable to complete request | ||
| PermissionDeniedException | authorization failure | ||