AcademicPlanService (Kuali Student 2.1.1-FR2-M1-SNAPSHOT API)

All Known Implementing Classes:

AcademicPlanServiceAuthorizationDecorator, AcademicPlanServiceDecorator, AcademicPlanServiceImpl, AcademicPlanServiceValidationDecorator
```
public interface AcademicPlanService
```
Provides a means for students to plan an academic career.
It designed to allow the student to:
- Search for courses [...or, requirements, certifications, etc.] by subject course code, keyword, and to selective narrow a search result by a plethora of categories (e.g. subj code, course # level, gen-end rqmts,....)
- Select courses and add to their plan, or to a "bookmark" list
- Adopt a learning template plan
- View of courses already taken and credits/grade recieved for each, directly within their plan
- Share a plan (...or part thereof) with an Advisor for review/comment/recommendation
- Run degree audit on a plan
- Select courses for doing a what if audit
- Creating multiple plans (pathways) to meet program goals
- Build out a detailed class schedule that may be used to feed registration (i.e. ...to make a "registration request")
- Use an interface to the program / learning objectives (degree/major/minor/certificate/...) in which they are enrolled, or for which they may wish to consider in a "what if" planning scenario (e.g. when running degree audit)
Version:

1.0 (Dev)

Author:

Kuali Student Team (ks-collab@kuali.org)

Method Summary

Methods
Modifier and Type	Method and Description
`LearningPlanInfo`	`createLearningPlan(LearningPlanInfo learningPlan, ContextInfo context)` create learning plan
`PlanItemInfo`	`createPlanItem(PlanItemInfo planItem, ContextInfo context)` create plan item
`StatusInfo`	`deleteLearningPlan(String learningPlanId, ContextInfo context)` delete the indicated learning plan
`StatusInfo`	`deletePlanItem(String planItemId, ContextInfo context)` delete the indicated learning plan
`LearningPlanInfo`	`getLearningPlan(String learningPlanId, ContextInfo context)` Retrieve learning plan by it's Id
`List<LearningPlanInfo>`	`getLearningPlansByIds(List<String> learningPlanIds, ContextInfo context)` Retrieve a set of learning plans that match the passed in list of plan ids
`List<LearningPlanInfo>`	`getLearningPlansForStudentByType(String studentId, String planTypeKey, ContextInfo context)` Get learning plans for the indicated student and of the indicated plan type
`PlanItemInfo`	`getPlanItem(String planItemId, ContextInfo context)` Retrieve plan item that matches the passed in plan item id
`List<PlanItemInfo>`	`getPlanItemsByIds(List<String> planItemIds, ContextInfo context)` Retrieve a list of plan items matching the passed in ids
`List<PlanItemInfo>`	`getPlanItemsByPlanTermAndCategories(String learningPlanId, String termId, List<AcademicPlanServiceConstants.ItemCategory> categories, ContextInfo context)`
`List<PlanItemInfo>`	`getPlanItemsInPlan(String learningPlanId, ContextInfo context)` retrieve all items for the indicated plan
`List<PlanItemInfo>`	`getPlanItemsInPlanByCategory(String learningPlanId, AcademicPlanServiceConstants.ItemCategory category, ContextInfo context)` Retrieve a list of plan items in a specific plan, by item category
`List<PlanItemInfo>`	`getPlanItemsInPlanByRefObjectIdByRefObjectType(String learningPlanId, String refObjectId, String refObjectType, ContextInfo context)` Gets plan items for the indicated reference object id and reference object type
`List<PlanItemInfo>`	`getPlanItemsInPlanByTermIdByCategory(String learningPlanId, String termId, AcademicPlanServiceConstants.ItemCategory category, ContextInfo context)` Retrieve a list of plan items that are planned for the indicated academic term and in the indicated category category
`List<PlanItemInfo>`	`getPlanItemsInPlanByType(String learningPlanId, String planItemTypeKey, ContextInfo context)` Retrieve a list of plan items in a specific plan, by plan item type
`LearningPlanInfo`	`updateLearningPlan(String learningPlanId, LearningPlanInfo learningPlan, ContextInfo context)` update learning plan
`PlanItemInfo`	`updatePlanItem(String planItemId, PlanItemInfo planItem, ContextInfo context)` update learning plan item
`List<ValidationResultInfo>`	`validateLearningPlan(String validationType, LearningPlanInfo learningPlanInfo, ContextInfo context)` validate the passed in learning plan
`List<ValidationResultInfo>`	`validatePlanItem(String validationType, PlanItemInfo planItemInfo, ContextInfo context)` validate the passed in plan item

Method Detail

getLearningPlan

LearningPlanInfo getLearningPlan(String learningPlanId,
                               ContextInfo context)
                                 throws DoesNotExistException,
                                        InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException,
                                        PermissionDeniedException

Retrieve learning plan by it's Id

Parameters:: learningPlanId - plan id; context - service call context, including: date-time of call, id of user executing the call
Returns:: requested learning plan
Throws:: DoesNotExistException - a learning plan having the passed in Id was not found; InvalidParameterException - a passed in parameter value is invalid; MissingParameterException - a passed in parameter value is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException

getLearningPlansByIds
```
List<LearningPlanInfo> getLearningPlansByIds(List<String> learningPlanIds,
                                           ContextInfo context)
                                             throws InvalidParameterException,
                                                    MissingParameterException,
                                                    OperationFailedException,
                                                    PermissionDeniedException
```
Retrieve a set of learning plans that match the passed in list of plan ids

Parameters:
learningPlanIds - list of ids of plans to retrieve
context - service call context, including: date-time of call, id of user executing the call

Returns:
set of learning plans that match the passed in list of plan ids

Throws:

InvalidParameterException - a passed in parameter value is invalid

MissingParameterException - a passed in parameter value is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - the user specified in the contextInfo is not authorized to perform the retrieval requested

getPlanItem
```
PlanItemInfo getPlanItem(String planItemId,
                       ContextInfo context)
                         throws DoesNotExistException,
                                InvalidParameterException,
                                MissingParameterException,
                                OperationFailedException,
                                PermissionDeniedException
```
Retrieve plan item that matches the passed in plan item id

Parameters:
planItemId - id of plan item to be retrieved
context - service call context, including: date-time of call, id of user executing the call

Returns:
plan item matching the passed in plan item id

Throws:

DoesNotExistException - a plan item having the passed in Id was not found

InvalidParameterException - a passed in parameter value is invalid

MissingParameterException - a passed in parameter value is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException

getPlanItemsByIds

List<PlanItemInfo> getPlanItemsByIds(List<String> planItemIds,
                                   ContextInfo context)
                                     throws InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException,
                                            PermissionDeniedException

Retrieve a list of plan items matching the passed in ids

Parameters:: planItemIds - list of plan item ids; context - service call context, including: date-time of call, id of user executing the call
Returns:: a list of plan items matching the passed in ids
Throws:: InvalidParameterException - a passed in parameter value is invalid; MissingParameterException - a passed in parameter value is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException

getPlanItemsInPlanByType

List<PlanItemInfo> getPlanItemsInPlanByType(String learningPlanId,
                                          String planItemTypeKey,
                                          ContextInfo context)
                                            throws InvalidParameterException,
                                                   MissingParameterException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

Retrieve a list of plan items in a specific plan, by plan item type

Parameters:: learningPlanId - id of learning plan for which items are to be retrieved; planItemTypeKey - key of plan item type; context - service call context, including: date-time of call, id of user executing the call
Returns:: a list of plan items for the indicated plan id and item type
Throws:: InvalidParameterException - a passed in parameter value is invalid; MissingParameterException - a passed in parameter value is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException

getPlanItemsInPlanByCategory

List<PlanItemInfo> getPlanItemsInPlanByCategory(String learningPlanId,
                                              AcademicPlanServiceConstants.ItemCategory category,
                                              ContextInfo context)
                                                throws InvalidParameterException,
                                                       MissingParameterException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

Retrieve a list of plan items in a specific plan, by item category

Parameters:: learningPlanId - id of learning plan for which items are to be retrieved; category - the category (e.g. planned, bookmarked, backup) of items to be retrieved; context - service call context, including: date-time of call, id of user executing the call
Returns:: a list of plan items for the indicated plan id and category
Throws:: InvalidParameterException - a passed in parameter value is invalid; MissingParameterException - a passed in parameter value is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException

getPlanItemsInPlan

List<PlanItemInfo> getPlanItemsInPlan(String learningPlanId,
                                    ContextInfo context)
                                      throws InvalidParameterException,
                                             MissingParameterException,
                                             OperationFailedException,
                                             PermissionDeniedException

retrieve all items for the indicated plan

Parameters:: learningPlanId - id of plan for which items are to be retrieved; context - service call context, including: date-time of call, id of user executing the call
Returns:: a list of plan items for the indcated plan id
Throws:: InvalidParameterException - a passed in parameter value is invalid; MissingParameterException - a passed in parameter value is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException

getPlanItemsInPlanByTermIdByCategory

List<PlanItemInfo> getPlanItemsInPlanByTermIdByCategory(String learningPlanId,
                                                      String termId,
                                                      AcademicPlanServiceConstants.ItemCategory category,
                                                      ContextInfo context)
                                                        throws InvalidParameterException,
                                                               MissingParameterException,
                                                               OperationFailedException,
                                                               PermissionDeniedException

Retrieve a list of plan items that are planned for the indicated academic term and in the indicated category category

Parameters:: learningPlanId - id of learning plan for which items are to be retrieved; termId - id of the academic term for which items are to be retrieved; category - the category (e.g. planned, bookmarked, backup) of items to be retrieved; context - service call context, including: date-time of call, id of user executing the call
Returns:: a list of plan items for the indicated plan id, term id, and item category
Throws:: InvalidParameterException - a passed in parameter value is invalid; MissingParameterException - a passed in parameter value is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException

getPlanItemsByPlanTermAndCategories

List<PlanItemInfo> getPlanItemsByPlanTermAndCategories(String learningPlanId,
                                                     String termId,
                                                     List<AcademicPlanServiceConstants.ItemCategory> categories,
                                                     ContextInfo context)
                                                       throws InvalidParameterException,
                                                              MissingParameterException,
                                                              OperationFailedException,
                                                              PermissionDeniedException

Parameters:: learningPlanId - id of learning plan for which items are to be retrieved; termId - id of the academic term for which items are to be retrieved; categories - the list of categories (e.g. planned, bookmarked, backup) of items to be retrieved; context - service call context, including: date-time of call, id of user executing the call
Returns:: a list of plan items for the indicated plan id, term id, and item category
Throws:: InvalidParameterException - a passed in parameter value is invalid; MissingParameterException - a passed in parameter value is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException

getPlanItemsInPlanByRefObjectIdByRefObjectType

List<PlanItemInfo> getPlanItemsInPlanByRefObjectIdByRefObjectType(String learningPlanId,
                                                                String refObjectId,
                                                                String refObjectType,
                                                                ContextInfo context)
                                                                  throws InvalidParameterException,
                                                                         MissingParameterException,
                                                                         OperationFailedException,
                                                                         PermissionDeniedException

Gets plan items for the indicated reference object id and reference object type

Parameters:: learningPlanId - The id of the plan.; refObjectId - The id of the referenced object.; refObjectType - The type of the referenced object.; context - service call context, including: date-time of call, id of user executing the call
Returns:: a list of plan items for the indicated plan id, reference object id, and reference object type
Throws:: InvalidParameterException - a passed in parameter value is invalid; MissingParameterException - a passed in parameter value is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException

getLearningPlansForStudentByType

List<LearningPlanInfo> getLearningPlansForStudentByType(String studentId,
                                                      String planTypeKey,
                                                      ContextInfo context)
                                                        throws InvalidParameterException,
                                                               MissingParameterException,
                                                               OperationFailedException,
                                                               PermissionDeniedException

Get learning plans for the indicated student and of the indicated plan type

Parameters:: studentId - id of student for which learning plans are to be retrieved; planTypeKey - key for type of plans to be retrieved; context - service call context, including: date-time of call, id of user executing the call
Returns:: a list of learning plans for the indicated student and plan type
Throws:: InvalidParameterException - a passed in parameter value is invalid; MissingParameterException - a passed in parameter value is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException

createLearningPlan

LearningPlanInfo createLearningPlan(LearningPlanInfo learningPlan,
                                  ContextInfo context)
                                    throws AlreadyExistsException,
                                           DataValidationErrorException,
                                           InvalidParameterException,
                                           MissingParameterException,
                                           OperationFailedException,
                                           PermissionDeniedException

create learning plan

Parameters:: learningPlan - learning plan to be created; context - service call context, including: date-time of call, id of user executing the call
Returns:: the newly created learning plan (...includes the newly assigned learningPlanId)
Throws:: AlreadyExistsException - a learning plan with the indicated plan id already exists; DataValidationErrorException - a data item of the learning plan is invalid; InvalidParameterException - a passed in parameter value is invalid; MissingParameterException - a passed in parameter value is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - the user (context.getUserId()) is not authorized to perform this operation

createPlanItem
```
PlanItemInfo createPlanItem(PlanItemInfo planItem,
                          ContextInfo context)
                            throws AlreadyExistsException,
                                   DataValidationErrorException,
                                   InvalidParameterException,
                                   MissingParameterException,
                                   OperationFailedException,
                                   PermissionDeniedException
```
create plan item

Parameters:
planItem - item to be created
context - service call context, including: date-time of call, id of user executing the call

Returns:
the newly created learning plan (...includes the newly assigned learningPlanId)

Throws:

AlreadyExistsException - a plan item with the indicated id already exists

DataValidationErrorException - a data item of the plan item is invalid

InvalidParameterException - a passed in parameter value is invalid

MissingParameterException - a passed in parameter value is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - the user (context.getUserId()) is not authorized to perform this operation

updateLearningPlan

LearningPlanInfo updateLearningPlan(String learningPlanId,
                                  LearningPlanInfo learningPlan,
                                  ContextInfo context)
                                    throws DataValidationErrorException,
                                           InvalidParameterException,
                                           MissingParameterException,
                                           OperationFailedException,
                                           PermissionDeniedException,
                                           DoesNotExistException,
                                           VersionMismatchException

update learning plan

Parameters:: learningPlanId - id of learning plan to be updated; learningPlan - updated learning plan to be persisted; context - service call context, including: date-time of call, id of user executing the call
Returns:: the updated learning plan
Throws:: DataValidationErrorException - a data item of the passed in learning plan is invalid; InvalidParameterException - a passed in parameter value is invalid; MissingParameterException - a passed in parameter value is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - the user (context.getUserId()) is not authorized to perform this operation; DoesNotExistException - a learning plan does not exist having the indicated plan id; VersionMismatchException - the version on the passed in plan was out of sync with the last saved version

updatePlanItem

PlanItemInfo updatePlanItem(String planItemId,
                          PlanItemInfo planItem,
                          ContextInfo context)
                            throws DataValidationErrorException,
                                   InvalidParameterException,
                                   MissingParameterException,
                                   OperationFailedException,
                                   PermissionDeniedException,
                                   DoesNotExistException,
                                   VersionMismatchException

update learning plan item

Parameters:: planItemId - id of the plan item to be udpated; planItem - item to be persisted; context - service call context, including: date-time of call, id of user executing the call
Returns:: the updated plan item
Throws:: DataValidationErrorException - a data item of the passed in plan item is invalid; InvalidParameterException - a passed in parameter value is invalid; MissingParameterException - a passed in parameter value is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - the user (context.getUserId()) is not authorized to perform this operation; DoesNotExistException - a learning plan does not exist having the indicated plan id; VersionMismatchException - the version on the passed in plan was out of sync with the last saved version

deleteLearningPlan
```
StatusInfo deleteLearningPlan(String learningPlanId,
                            ContextInfo context)
                              throws DoesNotExistException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException
```
delete the indicated learning plan

Parameters:
learningPlanId - id of plan to be deleted
context - service call context, including: date-time of call, id of user executing the call

Returns:
StatusInfo status of delete: where StatusInfo.isSuccess() is true only if the delete was successful and StatusInfo.getMessage() contains a textual description of the status

Throws:

DoesNotExistException - a plan item does not exist having the indicated id

InvalidParameterException - a passed in parameter value is invalid

MissingParameterException - a passed in parameter value is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - the user (context.getUserId()) is not authorized to perform this operation

deletePlanItem
```
StatusInfo deletePlanItem(String planItemId,
                        ContextInfo context)
                          throws DoesNotExistException,
                                 InvalidParameterException,
                                 MissingParameterException,
                                 OperationFailedException,
                                 PermissionDeniedException
```
delete the indicated learning plan

Parameters:
planItemId - id of plan item to be deleted
context - service call context, including: date-time of call, id of user executing the call

Returns:
StatusInfo status of delete: where StatusInfo.isSuccess() is true only if the delete was successful and StatusInfo.getMessage() contains a textual description of the status

Throws:

DoesNotExistException - a plan item does not exist having the indicated id

InvalidParameterException - a passed in parameter value is invalid

MissingParameterException - a passed in parameter value is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - the user (context.getUserId()) is not authorized to perform this operation

validateLearningPlan

List<ValidationResultInfo> validateLearningPlan(String validationType,
                                              LearningPlanInfo learningPlanInfo,
                                              ContextInfo context)
                                                throws DoesNotExistException,
                                                       InvalidParameterException,
                                                       MissingParameterException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

validate the passed in learning plan

Parameters:: validationType - must be one of: "FULL_VALIDATION", "SKIP_REQUREDNESS_VALIDATIONS", see: DataDictionaryValidator; learningPlanInfo - the learning plan object to be validated; context - service call context, including: date-time of call, id of user executing the call
Returns:: a list of validation results (multiple validation issues may exist)
Throws:: DoesNotExistException - a plan does not exist having the indicated id; InvalidParameterException - a passed in parameter value is invalid; MissingParameterException - a passed in parameter value is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException

validatePlanItem

List<ValidationResultInfo> validatePlanItem(String validationType,
                                          PlanItemInfo planItemInfo,
                                          ContextInfo context)
                                            throws DoesNotExistException,
                                                   InvalidParameterException,
                                                   MissingParameterException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

validate the passed in plan item

Parameters:: validationType - must be one of: "FULL_VALIDATION", "SKIP_REQUREDNESS_VALIDATIONS", see: DataDictionaryValidator; planItemInfo - the learning plan item to be validated; context - service call context, including: date-time of call, id of user executing the call
Returns:: a list of validation results (multiple validation issues may exist)
Throws:: DoesNotExistException - a plan item does not exist having the incated id; InvalidParameterException - a passed in parameter value is invalid; MissingParameterException - a passed in parameter value is missing or null; OperationFailedException - unable to complete request; AlreadyExistsException; PermissionDeniedException

Interface AcademicPlanService