ServicePlanDelivery (ServicePlans)

All Known Implementing Classes:

ServicePlanDelivery, curam.serviceplans.facade.impl.ServicePlanDelivery, ServicePlanDeliveryFactory
```
@AccessLevel(value=EXTERNAL)
public interface ServicePlanDelivery
```
This process class provides the functionality for the Service Plan Delivery facade.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`curam.core.sl.entity.struct.DailyAttendanceKey`	`addClientParticipationDefaultPlanItem(curam.serviceplans.facade.struct.AddClientParticipationDetails addClientParticipationDetails)` Adds Client Participation record with default planItem.
`curam.core.sl.entity.struct.DailyAttendanceKey`	`addClientParticipationSelectPlanItem(curam.serviceplans.facade.struct.AddClientParticipationDetails addClientParticipationDetails)` Adds Client Participation record for plan item selected by user.
`void`	`addMilestone(curam.serviceplans.facade.struct.SPMilestoneDeliveryDetails details)` Method to allow a user to add a milestone to a service plan.
`void`	`addTemplate(curam.serviceplans.facade.struct.AddTemplateDetails details)` Creates service plan delivery for an integrated case member based on the selected service plan template.
`void`	`approve(curam.serviceplans.facade.struct.ServicePlanDeliveryKey key)` Approves service plan delivery.
`void`	`approvePlanItem(curam.serviceplans.facade.struct.PlannedItemIDKey plannedItemIDKey)` Approves a plan item.
`void`	`cancelClienParticipation(curam.core.sl.entity.struct.DailyAttendanceKey key)` Cancels the daily attendance record.
`void`	`cancelServiceUnitDelivery(curam.serviceplans.facade.struct.CancelServiceUnitDeliveryKey key)` Cancel Service Unit Deliveries
`curam.serviceplans.facade.struct.CaseClientParticipationForDayList`	`caseClienParticipationDailyList(curam.serviceplans.facade.struct.CaseClientParticipationForDayKey caseClientParticipationForDayKey)` Lists client participation summary for all planItems of integrated case for a day specified.
`curam.serviceplans.facade.struct.WeeklyServicePlanClientParticipationList`	`caseClientParticipationWeeklyList(curam.serviceplans.facade.struct.CaseActiveClientParticipationKey caseActiveClientParticipationKey)` Lists weekly client participation summary for all planItems of integrated case.
`void`	`checkSecurity(curam.serviceplans.facade.struct.ServicePlanSecurityKey key)` Checks service plan security.
`curam.serviceplans.facade.struct.ServicePlanDeliveryKey`	`clone(curam.serviceplans.facade.struct.ServicePlanDeliveryKey key)` Clones service plan delivery.
`void`	`close(curam.serviceplans.facade.struct.ServicePlanDeliveryClosureDetails details)` Closes service plan delivery.
`curam.serviceplans.facade.struct.BaselineComparisonGanttDetails`	`compareBaselines(curam.serviceplans.facade.struct.BaselineCompareKey key)` Compare a baseline with another baseline or with a current plan.
`curam.serviceplans.facade.struct.ServicePlanDeliveryKey`	`create(curam.serviceplans.facade.struct.CreateServicePlanDeliveryDetails details, curam.serviceplans.facade.struct.IntegratedCaseMemberKey key)` Creates service plan delivery for an integrated case member.
`void`	`createAbsenceForPlanItem(curam.serviceplans.facade.struct.PlannedItemAbsenceDetails details)` Records absence details.
`void`	`createAttachment(curam.serviceplans.sl.entity.struct.PlannedItemAttachmentDetails plannedItemAttachmentDetails)` Method to create the attachment for the planned item
`void`	`createBasicPlanItemToSubGoal(curam.serviceplans.facade.struct.PlannedItemDetailsStruct createPlannedItemDetailsStruct)` Adds a service plan basic plan item to a planned subgoal.
`curam.serviceplans.facade.struct.CreateServicePlanContractKey`	`createContract(curam.serviceplans.facade.struct.CreateServicePlanContractDetails createServicePlanContractDetails)` Creates a contract for a specific service plan.
`void`	`createPlanGroup(curam.serviceplans.facade.struct.CreatePlanGroupDetails createPlanGroupDetails)` Creates a plan group for a service plan.
`void`	`createPlannedSubGoal(curam.serviceplans.facade.struct.CreatePlannedSubGoalDetails createPlannedSubGoalDetails)` creates a planned sub-goal for a service plan.
`curam.serviceplans.facade.struct.BaselineReturnKey`	`createServicePlanBaseline(curam.serviceplans.facade.struct.CreateBaselineDetails createBaselineDetails)` Creates a baseline for a service plan delivery.
`curam.serviceplans.facade.struct.ServiceUnitDeliveryKey`	`createServiceUnitDelivery(curam.serviceplans.facade.struct.ServiceUnitDeliveryDetails details)` Create Service Unit Deliveries.
`void`	`createServiceUnitDeliveryPlanItemToSubGoal(curam.serviceplans.facade.struct.PlannedItemDetailsStruct details)` Adds a service unit delivery plan item to a planned subgoal.
`void`	`deleteAttachment(curam.serviceplans.sl.entity.struct.PlannedItemAttachmentLinkKey plannedItemAttachmentLinkKey)` Method to cancel the attachment of a planned item
`void`	`deleteNominatedRepresentative(curam.serviceplans.facade.struct.CancelServicePlanParticipantDetails details)` Deletes nominated representative.
`curam.serviceplans.facade.struct.PlannedSubGoalAndCaseIDStruct`	`deletePlanItem(curam.serviceplans.facade.struct.PlannedItemIDKey plannedItemIDKey)` Removes the planItem.
`curam.serviceplans.facade.struct.ServicePlanStatementDisplayDetails`	`displayServicePlanStatement(curam.serviceplans.facade.struct.ServicePlanDeliveryKey servicePlanDeliveryKey)` Returns service plan statement if it is available, else it returns informational message.
`curam.serviceplans.facade.struct.ICMembersList`	`getAvailableICMembers(curam.serviceplans.facade.struct.ServicePlanDeliveryKey key)` Lists all integrated case members except the current plan participant.
`curam.serviceplans.facade.struct.ServicePlanTypesList`	`getAvailableSPTypes(curam.serviceplans.facade.struct.IntegratedCaseMemberKey key)` Reads a list of service plan types defined for the specified integrated case member.
`curam.serviceplans.facade.struct.ICServicePlanDeliveryMenuDataDetails`	`getICIntegratedServicePlanMenuData(curam.serviceplans.facade.struct.IntegratedServicePlanKey integratedServicePlanKey)` Retrieves IC Integrated Service Plan Menu Data
`curam.serviceplans.facade.struct.ICServicePlanDeliveryMenuDataDetails`	`getICServicePlanGroupMenuData(curam.serviceplans.facade.struct.ServicePlanGroupDeliveryKey servicePlanGroupDeliveryKey)` Gets IC Service Plan Group Menu Data
`curam.serviceplans.facade.struct.ICServicePlanDeliveryMenuDataDetails`	`getICServicePlanMenuData(curam.serviceplans.facade.struct.ServicePlanIntegratedCaseKey key)` Retrieves menu data for the service plan delivery tab menu bar creation.
`curam.serviceplans.facade.struct.SPDeliveryContextDescription`	`getIntegratedServicePlanContextDescription(curam.serviceplans.facade.struct.IntegratedServicePlanKey integratedServicePlanKey)` Gets Integrated Service Plan Context Description
`curam.serviceplans.sl.struct.PlannedItemApprovalCriteriaLinkDetailsList`	`getListOfApprovalCriteriaForPlannedItem(curam.serviceplans.facade.struct.PlannedItemIDKey key)` Method to get the list of planned item approval criteria details.
`curam.serviceplans.sl.entity.struct.PlannedItemIDAndNameDetails`	`getPlannedItemIDAndName(curam.serviceplans.facade.struct.PlannedItemIDKey key)` Method to return the planned item id passed in and its name.
`curam.serviceplans.facade.struct.SPDeliveryContextDescription`	`getServicePlanGroupContextDescription(curam.serviceplans.facade.struct.ServicePlanGroupDeliveryKey servicePlanGroupDeliveryKey)` Retrieves Service Plan Group Context Description
`curam.serviceplans.facade.struct.servicePlanIDDetails`	`getServicePlanID(curam.serviceplans.facade.struct.ServicePlanKey servicePlanKey)` Returns a Service Plan ID depending on the amount of sub-goals created for the selected Service Plan type.
`curam.serviceplans.facade.struct.ServicePlanDeliveryMenuDataDetails`	`getServicePlanMenuData(curam.serviceplans.facade.struct.ServicePlanDeliveryMenuKey servicePlanDeliveryMenuKey)` Returns the Service Plan menu data.
`curam.serviceplans.facade.struct.ServicePlanDeliveryMenuDataDetails`	`getSPGDServicePlanMenuData(curam.serviceplans.facade.struct.ServicePlanDeliveryMenuKey servicePlanDeliveryMenuKey)` Returns the SPGD Service Plan menu data.
`curam.core.facade.struct.WizardProperties`	`getWeeklyClientParticipationWizard()` Returns the wizard details for the Weekly Client Participation wizard.
`curam.serviceplans.facade.struct.ServicePlanDeliveryKey`	`ICCreate(curam.serviceplans.facade.struct.ICCreateServicePlanDeliveryDetails details, curam.serviceplans.facade.struct.ServicePlanIntegratedCaseKey key)` Creates a new service plan delivery on the Integrated Case level.
`curam.serviceplans.facade.struct.ServicePlanDeliveryKey`	`ICCreateWithGroupDelivery(curam.serviceplans.facade.struct.ICCreateServicePlanDeliveryAndGroupDetails dtls)` Creates a new service plan delivery on the Integrated Case level and a link record between the service plan delivery and the service plan group delivery.
`curam.serviceplans.facade.struct.CaseParticipantRoleKey`	`insertNominatedRepresentative(curam.serviceplans.facade.struct.CreateNominatedRepresentativeDetails details)` Adds a case participant role record of type Nominated Representative.
`curam.serviceplans.facade.struct.PlannedItemAbsenceDetailsList`	`listAbsenceForPlanItem(curam.serviceplans.facade.struct.PlannedItemIDKey key)` Retrieves the list of absences for the specified plan item.
`curam.serviceplans.facade.struct.ServicePlanAbsenceDetailsList`	`listAbsenceForServicePlan(curam.serviceplans.sl.entity.struct.ServicePlanDeliveryKey key)` Retrieves the list of absences for plan items associated with the specified service plan.
`curam.serviceplans.facade.struct.MilestoneDeliveryDetailsList`	`listAllMilestoneDeliveriesForServicePlan(curam.core.struct.CaseHeaderKey caseID)` This method allows a user to view a list of all milestones at service plan, plan group and sub goal levels with a status of Not Started, In Progress and Completed.
`curam.serviceplans.facade.struct.PlannedItemAttachmentsList`	`listAttachments(curam.serviceplans.sl.entity.struct.PlannedItemKey plannedItemKey)` Method to list all the attachments of a planned item
`curam.serviceplans.facade.struct.ListServicePlanForIC`	`listByICCase(curam.serviceplans.facade.struct.ServicePlanIntegratedCaseKey key)` Lists service plan deliveries for all members of the integrated case.
`curam.serviceplans.facade.struct.ServicePlanForICMemberList`	`listByICMember(curam.serviceplans.facade.struct.IntegratedCaseMemberKey integratedCaseMemberKey)` Lists service plan deliveries for the integrated case member.
`curam.serviceplans.facade.struct.PlannedItemClientParticipationList`	`listClienParticipationForPlannedItem(curam.serviceplans.facade.struct.PlanItemClientParticipationSearchKey key)` Lists all client participation records with time absent information for selected planItem.
`curam.serviceplans.facade.struct.ServicePlanClientParticipationList`	`listClienParticipationForServicePlan(curam.serviceplans.facade.struct.CaseClientParticipationKey key)` List all client participation records with time absent information for all planItems of service plan delivery.
`curam.serviceplans.facade.struct.PrintContractHistoryDetailsList`	`listContractPrintHistory(curam.serviceplans.facade.struct.ServicePlanContractKey servicePlanContractKey)` Returns a list of print history records for the service plan contract.
`curam.serviceplans.facade.struct.ServicePlanContractDetailsList`	`listContracts(curam.serviceplans.facade.struct.ServicePlanDeliveryKey servicePlanDeliveryKey)` Returns a list of contracts for a specific service plan delivery.
`curam.serviceplans.facade.struct.SPContractDetailsListwithCaseStatus`	`listContractswithCaseStatus(curam.serviceplans.facade.struct.ServicePlanDeliveryKey key)` Contains a list of contracts with service plan status for a specific service plan.
`curam.serviceplans.facade.struct.ListICServicePlanEventDetails1`	`listICServicePlanEventDetails1(curam.serviceplans.facade.struct.SearchCaseandEventKey key)` Method to return the list of events on the service plan.
`curam.serviceplans.facade.struct.MilestoneConfigIDNameAndTypeList`	`listMilestoneConfigsForServicePlanType(curam.core.struct.CaseHeaderKey key)` This method allows a user to select a milestone to be added to the service plan.
`curam.serviceplans.facade.struct.PlanParticipantList`	`listNominatedRepresentative(curam.serviceplans.facade.struct.ServicePlanDeliveryKey key)` Returns a list of nominated representatives for a particular service plan.
`curam.core.facade.struct.ListMemberDetails`	`listParticipantsToIssueContractTo(curam.serviceplans.facade.struct.ServicePlanDeliveryKey servicePlanDeliveryKey)` Lists the participants available to issue the contract to.
`curam.serviceplans.facade.struct.ServicePlanContentDetailsList`	`listPlanContentforServicePlans(curam.serviceplans.facade.struct.ServicePlanDeliveryKey key)` Displays a list of all plan groups and sub-goals that have been added directly to a selected service plan goal.
`curam.serviceplans.facade.struct.PAApprovalRequestDetailsList`	`listPlanItemApprovalRequest(curam.serviceplans.facade.struct.ApprovalRequestPlannedItemIDKey approvalRequestPlannedItemIDKey)` Lists all the approval requests for a planned item
`curam.serviceplans.facade.struct.PlannedItemNameAndIDDetailsList`	`listPlanItemsForClientParticipation(curam.serviceplans.facade.struct.PlanItemsForClientParticipationSearchKey planItemsForClientParticipationSearchKey)` Returns a list of in progress and completed plan items for which client participation can be recorded.
`curam.serviceplans.facade.struct.PlannedItemIDAndNameDetailsList`	`listPlanItemsForServicePlan(curam.serviceplans.sl.entity.struct.ServicePlanDeliveryKey key)` Retrieves all plan items associated with the specified service plan delivery.
`curam.serviceplans.facade.struct.PlanItemSummaryDetailsList`	`listPlanItemsForSubGoal(curam.serviceplans.facade.struct.PlannedSubGoalIDStruct plannedSubGoalIDStruct)` Lists all the planned items for a planned subgoal.
`curam.serviceplans.facade.struct.PlannedSubGoalList`	`listPlannedSubGoals(curam.serviceplans.facade.struct.PlannedSubGoalCaseIDKey plannedSubGoalCaseIDKey)` Lists all planned sub-goals for a service plan.
`curam.serviceplans.facade.struct.PlanParticipantList`	`listPlanParticipants(curam.serviceplans.facade.struct.ServicePlanDeliveryKey key)` Lists all the plan participant records for a service plan delivery.
`curam.serviceplans.facade.struct.PlanParticipantList1`	`listPlanParticipants1(curam.serviceplans.facade.struct.ServicePlanDeliveryKey key)` This method lists all the plan participant records for a service plan delivery.
`curam.serviceplans.facade.struct.PlanParticipantList`	`listPlanParticipantsForContract(curam.serviceplans.facade.struct.ContractParticipantKey key)` This method returns the list of participants barring the one to whom the contract is issued to.
`curam.serviceplans.facade.struct.SPApprovalRequestDtlsList`	`listServicePlanApprovalRequest(curam.serviceplans.facade.struct.ApprovalRequestCaseIDKey approvalRequestCaseIDKey)` Lists all the approval requests for a service plan.
`curam.serviceplans.facade.struct.BaselineDetailsList`	`listServicePlanBaselines(curam.serviceplans.facade.struct.BaselineCaseIDKey baselineCaseIDKey)` Reads a list of baselines for a service plan delivery.
`curam.serviceplans.facade.struct.ServicePlanConcernList`	`listServicePlanDeliveryForConcern(curam.core.struct.RelationshipConcernRoleIDKey key)` Lists all service plan deliveries for a specified concern.
`curam.serviceplans.facade.struct.ServicePlanConcernListForDuplicate`	`listServicePlanDeliveryForDuplicateConcern(curam.core.struct.ConcernRoleKey key)` Lists all service plan deliveries for a specified concern duplicate.
`curam.serviceplans.facade.struct.ServicePlansForOwnerList`	`listServicePlanDeliveryForOwner(curam.serviceplans.facade.struct.ServicePlansByOwnerKey key)` Lists all service plan deliveries for which the current user is the owner.
`curam.serviceplans.facade.struct.BaselineMilestoneListDetailsList`	`listServicePlanLevelBaselineMilestones(curam.serviceplans.facade.struct.BaselineKey key)` Method to list all service plan level baseline milestones.
`curam.serviceplans.facade.struct.PlanTemplateNameAndIDDetailsList`	`listServicePlanTemplates(curam.serviceplans.facade.struct.ServicePlanDeliveryKey key)` Returns list of planTemplateIDs and planTemplateNames for all plan templates assigned to a service plan.
`curam.serviceplans.facade.struct.ServiceUnitDeliveryDetailsList`	`listServiceUnitDeliveries(curam.serviceplans.facade.struct.ServiceUnitDeliveryListKey key)` Lists all the active service unit deliveries for a given day.
`curam.serviceplans.facade.struct.PlannedSubGoalListByTypeDetailsList`	`listSubGoalsOfType(curam.serviceplans.facade.struct.PlannedSubGoalTypeCodeKey plannedSubGoalTypeCodeKey)` List of all sub-goals of a certain type.
`curam.serviceplans.facade.struct.ListServicePlanTaskDetails`	`listTask(curam.serviceplans.facade.struct.ServicePlanDeliveryKey servicePlanDeliveryKey)` Lists Tasks for Service Plan.
`curam.serviceplans.facade.struct.MilestoneDeliveryDetailsList`	`listUncompletedMilestoneDeliveriesForServicePlan(curam.core.struct.CaseHeaderKey key)` This method allows the user to view the default list of milestones for a service plan.
`curam.serviceplans.facade.struct.ServicePlanDeliveryVersions`	`listVersions(curam.serviceplans.facade.struct.ServicePlanDeliveryKey key)` Lists service plan delivery versions.
`void`	`modifyAbsenceForPlanItem(curam.serviceplans.facade.struct.PlannedItemAbsenceDetails details)` Updates the specified absence record.
`void`	`modifyAttachment(curam.serviceplans.sl.entity.struct.PlannedItemAttachmentDetails plannedItemAttachmentDetails)` Method to modify the attachment of a planned item
`void`	`modifyAuthorizedUnits(curam.serviceplans.facade.struct.PlannedItemIDKey key, curam.serviceplans.facade.struct.ModifyAuthorizedUnitsDetails details)` Modifies the authorized units on a service unit planned item.
`curam.serviceplans.facade.struct.ModifyPlanItemReturnStruct`	`modifyBasicPlanItem(curam.serviceplans.facade.struct.ModifyPlannedItemDetailsStruct modifyPlannedItemDetailsStruct)` Modifies the basic planItem.
`void`	`modifyClientParticipation(curam.serviceplans.facade.struct.ModifyClientParticipationDetails modifyClientParticipationDetails)` Modifies details of client participation.
`void`	`modifyClosureDetails(curam.serviceplans.facade.struct.ServicePlanDeliveryKey key, curam.serviceplans.facade.struct.ModifyServicePlanClosureDetails details)` Modifies service plan closure details.
`void`	`modifyContract(curam.serviceplans.facade.struct.ModifyServicePlanContractDetails modifyServicePlanContractDetails)` Updates the details of the service plan contract.
`void`	`modifyMilestone(curam.serviceplans.facade.struct.SPMilestoneDeliveryDetails key)` Method to allow a user to modify milestone delivery details for a service plan.
`void`	`modifyMilestoneForWaiver(curam.serviceplans.facade.struct.SPMilestoneDeliveryDetails details)` This method is used to modify the service plan milestone delivery details
`void`	`modifyNominatedRepresentative(curam.serviceplans.facade.struct.ModifyServicePlanParticipantDetails details)` Modifies nominated representative.
`void`	`modifyPlanGroup(curam.serviceplans.facade.struct.ModifyPlanGroupDetails modifyPlanGroupDetails)` Modifies the details of a plan group.
`void`	`modifyPlanItemApprovalRequest(curam.serviceplans.facade.struct.ModifyRejectionDetails details)` Modifies the planned item approval request.
`void`	`modifyPlannedSubGoal(curam.serviceplans.facade.struct.ModifyPlannedSubGoalDetails modifyPlannedSubGoalDetails)` modifies the details of a planned sub-goal.
`void`	`modifyServicePlanApprovalRequest(curam.serviceplans.facade.struct.ModifyRejectionDetails details)` Modifies the service plan approval request.
`void`	`modifyServicePlanBaseline(curam.serviceplans.facade.struct.ModifyBaselineDetails modifyBaselineDetails)` Modifies the details of the service plan baseline
`void`	`modifyServicePlanDetails(curam.serviceplans.facade.struct.ModifySPOutcomeAndCommentsKey key, curam.serviceplans.facade.struct.ModifySPOutcomeAndCommentsDetails dtls)` Modifies the outcome and comments for a service plan delivery.
`void`	`modifyServicePlanGoal(curam.serviceplans.facade.struct.ModifyServicePlanGoalKey key, curam.serviceplans.facade.struct.ModifyServicePlanGoalDetails dtls)` Modifies a service plan goal.
`void`	`modifyServicePlanPlanItem(curam.serviceplans.facade.struct.ModifyPlannedItemDetailsStruct modifyPlannedItemDetailsStruct)` Modifies the planned item.
`curam.core.struct.InformationalMsgDtlsList`	`modifyServicePlanTypeAndComments(curam.serviceplans.facade.struct.ModifyServicePlanTypeKey key, curam.serviceplans.facade.struct.ModifyServicePlanTypeDetails dtls)` Modifies the service plan type and the comments for the service plan.
`void`	`modifyServiceUnitDelivery(curam.serviceplans.facade.struct.ServiceUnitDeliveryDetails dtls)` Modify the service unit delivery details.
`curam.serviceplans.facade.struct.ModifyPlanItemReturnStruct`	`modifyServiceUnitPlannedItemDetails(curam.serviceplans.facade.struct.ModifyPlannedItemDetailsStruct details)` Modifies the service unit delivery planned item details.
`curam.serviceplans.facade.struct.WeeklyPlanItemClientParticipationList`	`planItemClienParticipationWeeklyList(curam.serviceplans.facade.struct.PlanItemActiveClientParticipationSearchKey planItemActiveClientParticipationSearchKey)` Lists client participation summary for plan item for every week .
`curam.serviceplans.facade.struct.PlanItemChartDetails`	`planItemClientParticipationWeeklyChart(curam.serviceplans.facade.struct.PlanItemActiveClientParticipationSearchKey planItemActiveClientParticipationForDateRangeKey)` Gets weekly summary of active client participations of plan item specified to display chart.
`curam.serviceplans.facade.struct.PIDailyAttendanceDetailsList`	`plannedItemParticipationForWeekList(curam.serviceplans.facade.struct.PlanItemClientParticipationForDateRangeKey key)` Lists all client participation records with time absent information for particular plan item for a week specified.
`curam.serviceplans.facade.struct.PopulatedPlanParticipants`	`populatePlanParticipants(curam.serviceplans.facade.struct.ServicePlanDeliveryKey key)` Populates integrated case member list and service plan participants list to add and/or remove case members as plan participants.
`void`	`printContract(curam.serviceplans.facade.struct.ServicePlanContractKey servicePlanContractKey)` Prints a record of the service plan contract
`curam.serviceplans.facade.struct.PlannedItemAbsenceDetails`	`readAbsenceForPlanItem(curam.serviceplans.facade.struct.PlannedItemAbsenceIDKey key)` Retrieves the specified absence record details.
`curam.serviceplans.facade.struct.ReadAuthorizedUnitDetailsForModify`	`readAuthorizedUnitDetailsForModify(curam.serviceplans.facade.struct.PlannedItemIDKey key)` Returns service unit details required for display on the modify authorized units screen.
`curam.serviceplans.facade.struct.ExistingBaselinesDetails`	`readBaselinesForComparison(curam.serviceplans.facade.struct.BaselineIDAndCaseIDKey key)` Reads current baseline name and the list of all existing baselines for the service plan.
`curam.serviceplans.facade.struct.ViewClientParticipationDetails`	`readClientParticipationDetails(curam.core.sl.entity.struct.DailyAttendanceKey key)` Reads details of client participation.
`curam.serviceplans.facade.struct.ModifyServicePlanClosureDetails`	`readClosureDetails(curam.serviceplans.facade.struct.ServicePlanDeliveryKey key)` Reads service plan closure details for modify.
`curam.serviceplans.facade.struct.CaseParticipantRoleIDStruct`	`readContractDetailsForCreateContract(curam.serviceplans.facade.struct.CaseIDAndParticipantRoleIDKey caseIDAndParticipantRoleIDKey)` Reads the case participant role id based on case id and participant role id.
`curam.serviceplans.facade.struct.ContractClientNameAndParticipantRoleID`	`readContractIssuerDetails(curam.core.facade.struct.CaseParticipantRoleIDKey caseParticipantRoleIDKey)` Reads the participant role id and the client name for which a contract is to be issued to based on the case participant role id passed in.
`curam.serviceplans.facade.struct.ReadDetailsForAddServiceUnitDelivery`	`readDetailsForAddServiceUnitDelivery(curam.serviceplans.facade.struct.PlannedItemIDKey plannedItemIDKey)` Reads the details required to display the record service unit delivery screen.
`curam.serviceplans.facade.struct.ReadDtlsForAddServiceUnitPlannedItem`	`readDtlsForAddServiceUnitPlannedItem(curam.serviceplans.facade.struct.PlannedSubGoalKey plannedSubGoalKey, curam.serviceplans.facade.struct.PlanItemKey key)` Reads the details necessary to display the add service unit plan item to sub-goal screen.
`curam.serviceplans.sl.entity.struct.PlannedItemEstimatedCost`	`readEstimatedCostOfPlannedItemID(curam.serviceplans.facade.struct.PlannedItemIDKey key)` Reads the estimated cost for the passed in planned item.
`curam.serviceplans.facade.struct.ServicePlanDeliveryHomePageDetails1`	`readHomePageDetails1(curam.serviceplans.facade.struct.ServicePlanDeliveryKey key)` Replaces the deprecated method `readServicePlanDeliveryHomeDetails(ServicePlanDeliveryKey)`.
`curam.serviceplans.facade.struct.ReadMilestoneDeliveryDetails`	`readMilestone(curam.core.sl.entity.struct.MilestoneDeliveryKey key)` Method to read the details of a milestone delivery.
`curam.serviceplans.facade.struct.ServicePlanParticipantDetails`	`readNominatedRepresentativeDetails(curam.serviceplans.facade.struct.CaseParticipantRoleKey key)` Reads nominated representative details for a service plan delivery.
`curam.serviceplans.facade.struct.ServicePlanParticipantDetails`	`readNominatedRepresentativeDetailsForModify(curam.serviceplans.facade.struct.CaseParticipantRoleKey key)` Reads nominated representative details for modify.
`curam.serviceplans.facade.struct.ReadOutcomeAchievedAndCommentsDetails`	`readOutcomeAchievedAndComments(curam.serviceplans.facade.struct.ReadOutcomeAchievedAndCommentsKey key)` Reads the outcome and comments for a service plan delivery.
`curam.serviceplans.facade.struct.RejectionDetailsForModify`	`readPAApprovalRequestDetailsForModify(curam.serviceplans.facade.struct.PAApprovalRequestKey key)` Reads planned item approval request for modify.
`curam.serviceplans.facade.struct.ExpectedOutcomesForPlanItemDtlsList`	`readPossibleOutcomesAndSubGoalNameDetailsForPlanItem(curam.serviceplans.facade.struct.PlannedSubGoalKey plannedSubGoalKey, curam.serviceplans.facade.struct.PlanItemKey planItemKey)` Reads the outcomes and goal name for an plan item based on the plan item id and planned sub goal id.
`curam.core.facade.struct.ReadAttachmentDetails`	`readServicePlanContractAttachment(curam.core.facade.struct.ReadAttachmentKey key)` Reads the details for the service plan contract attachment.
`curam.serviceplans.facade.struct.ReadServicePlanGoalsDetails`	`readServicePlanGoals(curam.serviceplans.facade.struct.ReadServicePlanGoalsKey key)` Reads a list of valid service plan goals.
`curam.serviceplans.facade.struct.ReadServicePlanTypesAndCommentsDetails`	`readServicePlanTypesAndComments(curam.serviceplans.facade.struct.ReadServicePlanTypesAndCommentsKey key)` Reads the Service plan types available for the integrated case on which the service plan in created and the comments for the service plan.
`curam.serviceplans.facade.struct.ReadServiceUnitDeliveryDetails`	`readServiceUnitDeliveryDetails(curam.serviceplans.facade.struct.ReadServiceUnitDeliveryKey readServiceUnitDeliveryKey)` Reads a service unit delivery.
`curam.serviceplans.facade.struct.RejectionDetailsForModify`	`readSPApprovalRequestDetailsForModify(curam.serviceplans.facade.struct.SPApprovalRequestKey key)` Reads details for service plan approval request modification.
`curam.serviceplans.facade.struct.PlannedSubGoalNameKey`	`readSubGoalName(curam.serviceplans.facade.struct.PlannedSubGoalNameStruct plannedSubGoalNameKey)` Reads the sub goal name based on type code.
`void`	`reject(curam.serviceplans.facade.struct.ServicePlanDeliveryRejectDetails details)` Rejects submitted service plan delivery.
`void`	`rejectPlanItem(curam.serviceplans.facade.struct.PlannedItemIDKey plannedItemIDKey, curam.serviceplans.facade.struct.RejectionReasonAndRejectionComments rejectionReasonAndRejectionComments)` Rejects a plan item.
`void`	`removeMilestone(curam.core.sl.entity.struct.MilestoneDeliveryKey key)` Method to allow a user to remove a milestone from a service plan.
`void`	`removePlanGroup(curam.serviceplans.facade.struct.PlanGroupKey planGroupKey)` Removes physically a plan group.
`void`	`removePlannedSubGoal(curam.serviceplans.facade.struct.PlannedSubGoalKey plannedSubGoalKey)` Remove physically a planned sub-goal.
`void`	`removeServicePlanBaseline(curam.serviceplans.facade.struct.BaselineKey baselineKey)` Removes a service plan baseline from the database (physical remove).
`curam.serviceplans.sl.struct.CreatePageDetailsStruct`	`resolveCreatePlanItemPage(curam.serviceplans.facade.struct.PlanItemIDDetailsStruct planItemIDDetailsStruct)` Resolves the details of the create plan item page.
`curam.serviceplans.facade.struct.ModifyPageDetailsStruct`	`resolveModifyPlanItemPage(curam.serviceplans.facade.struct.PlannedItemIDKey plannedItemIDKey)` Resolves the details of the modify plan item page.
`curam.serviceplans.facade.struct.PageIdentifierDetails`	`resolvePlannedSubGoal(curam.serviceplans.facade.struct.PlannedSubGoalTypeCodeKey key, curam.serviceplans.sl.entity.struct.ParentGroupIDKey parentGroupIDKey)` Returns the correct sub-goal page depending on the amount of sub goals created for the selected type.
`curam.serviceplans.facade.struct.ViewPageDetailsStruct`	`resolveViewPlanItemPage(curam.serviceplans.facade.struct.PlannedItemIDKey plannedItemIDKey)` Resolves the details of the view plan item page.
`curam.serviceplans.facade.struct.ICServicePlanEventandActivity`	`searchICServicePlanEventandActivity(curam.serviceplans.facade.struct.SearchCaseandEventKey key)` Returns data representing case events and activities for a Service Plan
`curam.serviceplans.facade.struct.ServicePlanClientParticipationList`	`servicePlanParticipationForWeekList(curam.serviceplans.facade.struct.CaseClientParticipationForDateRangeKey key)` Lists all client participation records with time absent information for all planItems of the service plan for a week specified.
`curam.serviceplans.facade.struct.SPStatementXMLString`	`showIntegratedServicePlanStatement(curam.serviceplans.facade.struct.IntegratedServicePlanKey integratedServicePlanKey)` Displays Integrated Service Plan Statement
`curam.serviceplans.facade.struct.SPStatementXMLString`	`showServicePlanGroupStatement(curam.serviceplans.facade.struct.ServicePlanGroupDeliveryKey servicePlanGroupDeliveryKey)` Displays Service Plan Group Statement
`void`	`submit(curam.serviceplans.facade.struct.ServicePlanDeliveryKey key)` Submits service plan delivery for approval.
`void`	`submitPlanItem(curam.serviceplans.facade.struct.PlannedItemIDKey plannedItemIDKey)` Submits a plan item.
`void`	`updatePlanParticipants(curam.serviceplans.facade.struct.PlanParticipantDetailsForUpdate details)` Manage plan participants by adding and/or removing integrated case members as plan participant.
`curam.serviceplans.facade.struct.PlannedSubGoalTypeCodeDetailsList`	`validateGoalExistsAndReturnSubGoalTypes(curam.serviceplans.facade.struct.PlannedSubGoalCaseIDKey plannedSubGoalCaseIDKey)` Checks to see if a planned goal exists when listing the sub-goal types.
`curam.serviceplans.sl.entity.struct.PlannedItemAttachmentDetails`	`viewAttachment(curam.serviceplans.sl.entity.struct.PlannedItemAttachmentLinkKey plannedItemAttachmentLinkKey)` Method to view the Planned Item Attachment
`curam.serviceplans.facade.struct.AuthorizedUnitHistoryDetails`	`viewAuthorizationHistoryDetails(curam.serviceplans.facade.struct.AuthorizedUnitHistoryKey key)` Returns the authorized unit history details for a service unit planned item.
`curam.serviceplans.facade.struct.AuthorizedUnitHistoryDetailsList`	`viewAuthorizationHistoryList(curam.serviceplans.facade.struct.PlannedItemIDKey key)` Returns the authorized unit history list details for a service unit planned item.
`curam.serviceplans.facade.struct.BaselineGanttDetails`	`viewBaselineGantt(curam.serviceplans.facade.struct.BaselineKey key)` Displays a Baseline Gantt
`curam.serviceplans.facade.struct.ReadBaselineDetails`	`viewBaselineHome(curam.serviceplans.facade.struct.BaselineKey baselineKey)` Reads the details of a baseline
`curam.serviceplans.sl.entity.struct.BaselineMilestoneDtls`	`viewBaselineMilestoneDetails(curam.serviceplans.sl.entity.struct.BaselineMilestoneKey key)` This method is used by the application to view the baseline milestone details for a service plan baseline.
`curam.serviceplans.facade.struct.BaselinePlanContentList`	`viewBaselinePlanContentList(curam.serviceplans.facade.struct.BaselineKey key)` Returns the baseline content list
`curam.serviceplans.facade.struct.BaselinePlanGroupDetails`	`viewBaselinePlanGroupDetails(curam.serviceplans.facade.struct.BaselinePlanGroupReadDetailsKey key)` reads the details of a Baseline Plan Group.
`curam.serviceplans.facade.struct.ServicePlanDeliveryClosureDetails`	`viewClosureDetails(curam.serviceplans.facade.struct.ServicePlanDeliveryKey key)` Returns service plan delivery closure details.
`curam.serviceplans.facade.struct.ReadCompleteContractDetails`	`viewCompleteContract(curam.serviceplans.facade.struct.ServicePlanContractKey servicePlanContractKey)` Views the service plan contract and displays it to the user.
`curam.serviceplans.facade.struct.ReadContractHomeDetails`	`viewContractHome(curam.serviceplans.facade.struct.ServicePlanContractKey servicePlanContractKey)` Views the details of the contract home page.
`curam.serviceplans.facade.struct.ServicePlanTrackingGanttDetails`	`viewGroupTrackingGantt(curam.serviceplans.facade.struct.ServicePlanGroupDeliveryKey servicePlanGroupDeliveryKey)` Views Group Tracking Gantt
`curam.serviceplans.facade.struct.ServicePlanTrackingGanttDetails`	`viewIntegratedTrackingGantt(curam.serviceplans.facade.struct.IntegratedServicePlanKey integratedServicePlanKey)` Views Integrated Tracking Gantt
`curam.serviceplans.facade.struct.ReadPlannedGroupDetails`	`viewPlanGroupDetails(curam.serviceplans.facade.struct.PlanGroupKey planGroupKey)` Displays details of a plan group with a list of any planned sub-goals or additional groups that have been added to the plan group.
`curam.serviceplans.facade.struct.ViewPlannedItemDetailsStruct`	`viewPlanItem(curam.serviceplans.facade.struct.PlannedItemIDKey plannedItemIDKey)` Resolves the details of the planned item.
`curam.serviceplans.facade.struct.PlannedItemApprovalRequestDetails`	`viewPlanItemApprovalRequest(curam.serviceplans.facade.struct.PAApprovalRequestKey paApprovalRequestKey)` Reads the planned item approval request.
`curam.serviceplans.facade.struct.ReadPlannedGroupAndSubGoalDetails`	`viewPlannedGroupAndSubGoalDetails(curam.serviceplans.facade.struct.PlanGroupKey planGroupKey)` Displays details of a plan group with a list of any planned sub-goals or additional groups that have been added to the plan group.
`curam.serviceplans.facade.struct.ReadPlannedSubGoalDetailsForModification`	`viewPlannedSubGoal(curam.serviceplans.facade.struct.PlannedSubGoalKey plannedSubGoalKey)` reads the details of a planned sub-goal.
`curam.serviceplans.facade.struct.ReadPlannedSubGoalDetailsWithPlannedItemsDetails`	`viewPlannedSubGoalWithPlannedItems(curam.serviceplans.facade.struct.PlannedSubGoalKey plannedSubGoalKey)` list details of planned sub-goal with it's corresponding planned items.
`curam.serviceplans.facade.struct.ServicePlanApprovalRequestFullDetails`	`viewServicePlanApprovalRequest(curam.serviceplans.facade.struct.SPApprovalRequestKey spApprovalRequestKey)` Reads the service plan approval request.
`curam.serviceplans.facade.struct.ViewBaselinePlannedItemDetails`	`viewServicePlanBaselinePlannedItemDetails(curam.serviceplans.sl.entity.struct.BaselinePlanItemKey baselinePlanItemKey)` Method to view the planned item details of a given base line
`curam.serviceplans.facade.struct.BaselineSubGoalDetails`	`viewServicePlanBaselineSubGoalDetails(curam.serviceplans.facade.struct.BaselineSubGoalKey baselineSubGoalKey)` Views the details of a baseline sub goal record.
`curam.serviceplans.facade.struct.PlannedItemAndServiceUnitDetails`	`viewServiceUnitPlannedItemDetails(curam.serviceplans.facade.struct.PlannedItemIDKey key)` Reads the service unit delivery planned item details.
`curam.serviceplans.facade.struct.TrackingGanttDetails`	`viewTrackingGantt(curam.serviceplans.facade.struct.ServicePlanDeliveryKey servicePlanDeliveryKey)` View the Tracking Gantt for a Service Plan.

Method Detail

addClientParticipationDefaultPlanItem

@AccessLevel(value=EXTERNAL)
curam.core.sl.entity.struct.DailyAttendanceKey addClientParticipationDefaultPlanItem(curam.serviceplans.facade.struct.AddClientParticipationDetails addClientParticipationDetails)
                                                                                                           throws curam.util.exception.AppException,
                                                                                                                  curam.util.exception.InformationalException

Adds Client Participation record with default planItem.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

addClientParticipationSelectPlanItem

@AccessLevel(value=EXTERNAL)
curam.core.sl.entity.struct.DailyAttendanceKey addClientParticipationSelectPlanItem(curam.serviceplans.facade.struct.AddClientParticipationDetails addClientParticipationDetails)
                                                                                                          throws curam.util.exception.AppException,
                                                                                                                 curam.util.exception.InformationalException

Adds Client Participation record for plan item selected by user.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

addMilestone

@AccessLevel(value=EXTERNAL)
void addMilestone(curam.serviceplans.facade.struct.SPMilestoneDeliveryDetails details)
                                        throws curam.util.exception.AppException,
                                               curam.util.exception.InformationalException

Method to allow a user to add a milestone to a service plan.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

addTemplate

@AccessLevel(value=EXTERNAL)
void addTemplate(curam.serviceplans.facade.struct.AddTemplateDetails details)
                                       throws curam.util.exception.AppException,
                                              curam.util.exception.InformationalException

Creates service plan delivery for an integrated case member based on the selected service plan template.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

approve

@AccessLevel(value=EXTERNAL)
void approve(curam.serviceplans.facade.struct.ServicePlanDeliveryKey key)
                                   throws curam.util.exception.AppException,
                                          curam.util.exception.InformationalException

Approves service plan delivery.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

approvePlanItem

@AccessLevel(value=EXTERNAL)
void approvePlanItem(curam.serviceplans.facade.struct.PlannedItemIDKey plannedItemIDKey)
                                           throws curam.util.exception.AppException,
                                                  curam.util.exception.InformationalException

Approves a plan item.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelClienParticipation

@AccessLevel(value=EXTERNAL)
void cancelClienParticipation(curam.core.sl.entity.struct.DailyAttendanceKey key)
                                                    throws curam.util.exception.AppException,
                                                           curam.util.exception.InformationalException

Cancels the daily attendance record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelServiceUnitDelivery

@AccessLevel(value=EXTERNAL)
void cancelServiceUnitDelivery(curam.serviceplans.facade.struct.CancelServiceUnitDeliveryKey key)
                                                     throws curam.util.exception.AppException,
                                                            curam.util.exception.InformationalException

Cancel Service Unit Deliveries

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

caseClienParticipationDailyList

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.CaseClientParticipationForDayList caseClienParticipationDailyList(curam.serviceplans.facade.struct.CaseClientParticipationForDayKey caseClientParticipationForDayKey)
                                                                                                                         throws curam.util.exception.AppException,
                                                                                                                                curam.util.exception.InformationalException

Lists client participation summary for all planItems of integrated case for a day specified.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

caseClientParticipationWeeklyList

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.WeeklyServicePlanClientParticipationList caseClientParticipationWeeklyList(curam.serviceplans.facade.struct.CaseActiveClientParticipationKey caseActiveClientParticipationKey)
                                                                                                                                  throws curam.util.exception.AppException,
                                                                                                                                         curam.util.exception.InformationalException

Lists weekly client participation summary for all planItems of integrated case.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

checkSecurity

@AccessLevel(value=EXTERNAL)
void checkSecurity(curam.serviceplans.facade.struct.ServicePlanSecurityKey key)
                                         throws curam.util.exception.AppException,
                                                curam.util.exception.InformationalException

Checks service plan security.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

clone

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ServicePlanDeliveryKey clone(curam.serviceplans.facade.struct.ServicePlanDeliveryKey key)
                                                                                    throws curam.util.exception.AppException,
                                                                                           curam.util.exception.InformationalException

Clones service plan delivery.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

close

@AccessLevel(value=EXTERNAL)
void close(curam.serviceplans.facade.struct.ServicePlanDeliveryClosureDetails details)
                                 throws curam.util.exception.AppException,
                                        curam.util.exception.InformationalException

Closes service plan delivery.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

compareBaselines

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.BaselineComparisonGanttDetails compareBaselines(curam.serviceplans.facade.struct.BaselineCompareKey key)
                                                                                                       throws curam.util.exception.AppException,
                                                                                                              curam.util.exception.InformationalException

Compare a baseline with another baseline or with a current plan.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

create

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ServicePlanDeliveryKey create(curam.serviceplans.facade.struct.CreateServicePlanDeliveryDetails details,
                                                                                            curam.serviceplans.facade.struct.IntegratedCaseMemberKey key)
                                                                                     throws curam.util.exception.AppException,
                                                                                            curam.util.exception.InformationalException

Creates service plan delivery for an integrated case member.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createAbsenceForPlanItem

@AccessLevel(value=EXTERNAL)
void createAbsenceForPlanItem(curam.serviceplans.facade.struct.PlannedItemAbsenceDetails details)
                                                    throws curam.util.exception.AppException,
                                                           curam.util.exception.InformationalException

Records absence details. Called when a user selects the option to manually create an absence details record for a plan item.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createAttachment

@AccessLevel(value=EXTERNAL)
void createAttachment(curam.serviceplans.sl.entity.struct.PlannedItemAttachmentDetails plannedItemAttachmentDetails)
                                            throws curam.util.exception.AppException,
                                                   curam.util.exception.InformationalException

Method to create the attachment for the planned item

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createContract

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.CreateServicePlanContractKey createContract(curam.serviceplans.facade.struct.CreateServicePlanContractDetails createServicePlanContractDetails)
                                                                                                   throws curam.util.exception.AppException,
                                                                                                          curam.util.exception.InformationalException

Creates a contract for a specific service plan.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createPlanGroup

@AccessLevel(value=EXTERNAL)
void createPlanGroup(curam.serviceplans.facade.struct.CreatePlanGroupDetails createPlanGroupDetails)
                                           throws curam.util.exception.AppException,
                                                  curam.util.exception.InformationalException

Creates a plan group for a service plan.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createPlannedSubGoal

@AccessLevel(value=EXTERNAL)
void createPlannedSubGoal(curam.serviceplans.facade.struct.CreatePlannedSubGoalDetails createPlannedSubGoalDetails)
                                                throws curam.util.exception.AppException,
                                                       curam.util.exception.InformationalException

creates a planned sub-goal for a service plan.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createServicePlanBaseline

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.BaselineReturnKey createServicePlanBaseline(curam.serviceplans.facade.struct.CreateBaselineDetails createBaselineDetails)
                                                                                                   throws curam.util.exception.AppException,
                                                                                                          curam.util.exception.InformationalException

Creates a baseline for a service plan delivery.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createServiceUnitDelivery

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ServiceUnitDeliveryKey createServiceUnitDelivery(curam.serviceplans.facade.struct.ServiceUnitDeliveryDetails details)
                                                                                                        throws curam.util.exception.AppException,
                                                                                                               curam.util.exception.InformationalException

Create Service Unit Deliveries.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

deleteAttachment

@AccessLevel(value=EXTERNAL)
void deleteAttachment(curam.serviceplans.sl.entity.struct.PlannedItemAttachmentLinkKey plannedItemAttachmentLinkKey)
                                            throws curam.util.exception.AppException,
                                                   curam.util.exception.InformationalException

Method to cancel the attachment of a planned item

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

deleteNominatedRepresentative

@AccessLevel(value=EXTERNAL)
void deleteNominatedRepresentative(curam.serviceplans.facade.struct.CancelServicePlanParticipantDetails details)
                                                         throws curam.util.exception.AppException,
                                                                curam.util.exception.InformationalException

Deletes nominated representative.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

deletePlanItem

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.PlannedSubGoalAndCaseIDStruct deletePlanItem(curam.serviceplans.facade.struct.PlannedItemIDKey plannedItemIDKey)
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

Removes the planItem.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

getAvailableICMembers

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ICMembersList getAvailableICMembers(curam.serviceplans.facade.struct.ServicePlanDeliveryKey key)
                                                                                           throws curam.util.exception.AppException,
                                                                                                  curam.util.exception.InformationalException

Lists all integrated case members except the current plan participant.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

getAvailableSPTypes

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ServicePlanTypesList getAvailableSPTypes(curam.serviceplans.facade.struct.IntegratedCaseMemberKey key)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Reads a list of service plan types defined for the specified integrated case member.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

getICServicePlanMenuData

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ICServicePlanDeliveryMenuDataDetails getICServicePlanMenuData(curam.serviceplans.facade.struct.ServicePlanIntegratedCaseKey key)
                                                                                                                     throws curam.util.exception.AppException,
                                                                                                                            curam.util.exception.InformationalException

Retrieves menu data for the service plan delivery tab menu bar creation.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

getPlannedItemIDAndName

@AccessLevel(value=EXTERNAL)
curam.serviceplans.sl.entity.struct.PlannedItemIDAndNameDetails getPlannedItemIDAndName(curam.serviceplans.facade.struct.PlannedItemIDKey key)
                                                                                                              throws curam.util.exception.AppException,
                                                                                                                     curam.util.exception.InformationalException

Method to return the planned item id passed in and its name.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

getServicePlanID

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.servicePlanIDDetails getServicePlanID(curam.serviceplans.facade.struct.ServicePlanKey servicePlanKey)
                                                                                             throws curam.util.exception.AppException,
                                                                                                    curam.util.exception.InformationalException

Returns a Service Plan ID depending on the amount of sub-goals created for the selected Service Plan type.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

ICCreate

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ServicePlanDeliveryKey ICCreate(curam.serviceplans.facade.struct.ICCreateServicePlanDeliveryDetails details,
                                                                                              curam.serviceplans.facade.struct.ServicePlanIntegratedCaseKey key)
                                                                                       throws curam.util.exception.AppException,
                                                                                              curam.util.exception.InformationalException

Creates a new service plan delivery on the Integrated Case level.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

insertNominatedRepresentative

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.CaseParticipantRoleKey insertNominatedRepresentative(curam.serviceplans.facade.struct.CreateNominatedRepresentativeDetails details)
                                                                                                            throws curam.util.exception.AppException,
                                                                                                                   curam.util.exception.InformationalException

Adds a case participant role record of type Nominated Representative.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listAbsenceForPlanItem

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.PlannedItemAbsenceDetailsList listAbsenceForPlanItem(curam.serviceplans.facade.struct.PlannedItemIDKey key)
                                                                                                            throws curam.util.exception.AppException,
                                                                                                                   curam.util.exception.InformationalException

Retrieves the list of absences for the specified plan item. Called when a user selects the option to view the list of absence details for a plan item.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listAbsenceForServicePlan

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ServicePlanAbsenceDetailsList listAbsenceForServicePlan(curam.serviceplans.sl.entity.struct.ServicePlanDeliveryKey key)
                                                                                                               throws curam.util.exception.AppException,
                                                                                                                      curam.util.exception.InformationalException

Retrieves the list of absences for plan items associated with the specified service plan. Called when a user selects the option to view the list of absence details for a service plan.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listAllMilestoneDeliveriesForServicePlan

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.MilestoneDeliveryDetailsList listAllMilestoneDeliveriesForServicePlan(curam.core.struct.CaseHeaderKey caseID)
                                                                                                                             throws curam.util.exception.AppException,
                                                                                                                                    curam.util.exception.InformationalException

This method allows a user to view a list of all milestones at service plan, plan group and sub goal levels with a status of Not Started, In Progress and Completed.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listAttachments

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.PlannedItemAttachmentsList listAttachments(curam.serviceplans.sl.entity.struct.PlannedItemKey plannedItemKey)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Method to list all the attachments of a planned item

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listByICMember

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ServicePlanForICMemberList listByICMember(curam.serviceplans.facade.struct.IntegratedCaseMemberKey integratedCaseMemberKey)
                                                                                                 throws curam.util.exception.AppException,
                                                                                                        curam.util.exception.InformationalException

Lists service plan deliveries for the integrated case member.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listContractPrintHistory

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.PrintContractHistoryDetailsList listContractPrintHistory(curam.serviceplans.facade.struct.ServicePlanContractKey servicePlanContractKey)
                                                                                                                throws curam.util.exception.AppException,
                                                                                                                       curam.util.exception.InformationalException

Returns a list of print history records for the service plan contract.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listContracts

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ServicePlanContractDetailsList listContracts(curam.serviceplans.facade.struct.ServicePlanDeliveryKey servicePlanDeliveryKey)
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

Returns a list of contracts for a specific service plan delivery.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listMilestoneConfigsForServicePlanType

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.MilestoneConfigIDNameAndTypeList listMilestoneConfigsForServicePlanType(curam.core.struct.CaseHeaderKey key)
                                                                                                                               throws curam.util.exception.AppException,
                                                                                                                                      curam.util.exception.InformationalException

This method allows a user to select a milestone to be added to the service plan. Milestones which have been configured in administration for the selected service plan type are displayed. Only milestones which have no end date or an end date in the future are displayed for selection.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listNominatedRepresentative

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.PlanParticipantList listNominatedRepresentative(curam.serviceplans.facade.struct.ServicePlanDeliveryKey key)
                                                                                                       throws curam.util.exception.AppException,
                                                                                                              curam.util.exception.InformationalException

Returns a list of nominated representatives for a particular service plan.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listParticipantsToIssueContractTo

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListMemberDetails listParticipantsToIssueContractTo(curam.serviceplans.facade.struct.ServicePlanDeliveryKey servicePlanDeliveryKey)
                                                                                                   throws curam.util.exception.AppException,
                                                                                                          curam.util.exception.InformationalException

Lists the participants available to issue the contract to.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listPlanItemApprovalRequest

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.PAApprovalRequestDetailsList listPlanItemApprovalRequest(curam.serviceplans.facade.struct.ApprovalRequestPlannedItemIDKey approvalRequestPlannedItemIDKey)
                                                                                                                throws curam.util.exception.AppException,
                                                                                                                       curam.util.exception.InformationalException

Lists all the approval requests for a planned item

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listPlanItemsForClientParticipation

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.PlannedItemNameAndIDDetailsList listPlanItemsForClientParticipation(curam.serviceplans.facade.struct.PlanItemsForClientParticipationSearchKey planItemsForClientParticipationSearchKey)
                                                                                                                           throws curam.util.exception.AppException,
                                                                                                                                  curam.util.exception.InformationalException

Returns a list of in progress and completed plan items for which client participation can be recorded. Called during client participation tracking by a case worker.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listPlanItemsForServicePlan

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.PlannedItemIDAndNameDetailsList listPlanItemsForServicePlan(curam.serviceplans.sl.entity.struct.ServicePlanDeliveryKey key)
                                                                                                                   throws curam.util.exception.AppException,
                                                                                                                          curam.util.exception.InformationalException

Retrieves all plan items associated with the specified service plan delivery.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listPlanItemsForSubGoal

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.PlanItemSummaryDetailsList listPlanItemsForSubGoal(curam.serviceplans.facade.struct.PlannedSubGoalIDStruct plannedSubGoalIDStruct)
                                                                                                          throws curam.util.exception.AppException,
                                                                                                                 curam.util.exception.InformationalException

Lists all the planned items for a planned subgoal.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listPlannedSubGoals

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.PlannedSubGoalList listPlannedSubGoals(curam.serviceplans.facade.struct.PlannedSubGoalCaseIDKey plannedSubGoalCaseIDKey)
                                                                                              throws curam.util.exception.AppException,
                                                                                                     curam.util.exception.InformationalException

Lists all planned sub-goals for a service plan.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listPlanParticipants

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.PlanParticipantList listPlanParticipants(curam.serviceplans.facade.struct.ServicePlanDeliveryKey key)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Lists all the plan participant records for a service plan delivery.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listPlanParticipantsForContract

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.PlanParticipantList listPlanParticipantsForContract(curam.serviceplans.facade.struct.ContractParticipantKey key)
                                                                                                           throws curam.util.exception.AppException,
                                                                                                                  curam.util.exception.InformationalException

This method returns the list of participants barring the one to whom the contract is issued to.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listServicePlanApprovalRequest

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.SPApprovalRequestDtlsList listServicePlanApprovalRequest(curam.serviceplans.facade.struct.ApprovalRequestCaseIDKey approvalRequestCaseIDKey)
                                                                                                                throws curam.util.exception.AppException,
                                                                                                                       curam.util.exception.InformationalException

Lists all the approval requests for a service plan.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listServicePlanBaselines

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.BaselineDetailsList listServicePlanBaselines(curam.serviceplans.facade.struct.BaselineCaseIDKey baselineCaseIDKey)
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

Reads a list of baselines for a service plan delivery.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listServicePlanDeliveryForConcern

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ServicePlanConcernList listServicePlanDeliveryForConcern(curam.core.struct.RelationshipConcernRoleIDKey key)
                                                                                                                throws curam.util.exception.AppException,
                                                                                                                       curam.util.exception.InformationalException

Lists all service plan deliveries for a specified concern.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listServicePlanDeliveryForDuplicateConcern

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ServicePlanConcernListForDuplicate listServicePlanDeliveryForDuplicateConcern(curam.core.struct.ConcernRoleKey key)
                                                                                                                                     throws curam.util.exception.AppException,
                                                                                                                                            curam.util.exception.InformationalException

Lists all service plan deliveries for a specified concern duplicate.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listServicePlanDeliveryForOwner

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ServicePlansForOwnerList listServicePlanDeliveryForOwner(curam.serviceplans.facade.struct.ServicePlansByOwnerKey key)
                                                                                                                throws curam.util.exception.AppException,
                                                                                                                       curam.util.exception.InformationalException

Lists all service plan deliveries for which the current user is the owner.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listServicePlanLevelBaselineMilestones

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.BaselineMilestoneListDetailsList listServicePlanLevelBaselineMilestones(curam.serviceplans.facade.struct.BaselineKey key)
                                                                                                                               throws curam.util.exception.AppException,
                                                                                                                                      curam.util.exception.InformationalException

Method to list all service plan level baseline milestones.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listServicePlanTemplates

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.PlanTemplateNameAndIDDetailsList listServicePlanTemplates(curam.serviceplans.facade.struct.ServicePlanDeliveryKey key)
                                                                                                                 throws curam.util.exception.AppException,
                                                                                                                        curam.util.exception.InformationalException

Returns list of planTemplateIDs and planTemplateNames for all plan templates assigned to a service plan.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listServiceUnitDeliveries

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ServiceUnitDeliveryDetailsList listServiceUnitDeliveries(curam.serviceplans.facade.struct.ServiceUnitDeliveryListKey key)
                                                                                                                throws curam.util.exception.AppException,
                                                                                                                       curam.util.exception.InformationalException

Lists all the active service unit deliveries for a given day.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listSubGoalsOfType

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.PlannedSubGoalListByTypeDetailsList listSubGoalsOfType(curam.serviceplans.facade.struct.PlannedSubGoalTypeCodeKey plannedSubGoalTypeCodeKey)
                                                                                                              throws curam.util.exception.AppException,
                                                                                                                     curam.util.exception.InformationalException

List of all sub-goals of a certain type.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listTask

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ListServicePlanTaskDetails listTask(curam.serviceplans.facade.struct.ServicePlanDeliveryKey servicePlanDeliveryKey)
                                                                                           throws curam.util.exception.AppException,
                                                                                                  curam.util.exception.InformationalException

Lists Tasks for Service Plan.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listUncompletedMilestoneDeliveriesForServicePlan

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.MilestoneDeliveryDetailsList listUncompletedMilestoneDeliveriesForServicePlan(curam.core.struct.CaseHeaderKey key)
                                                                                                                                     throws curam.util.exception.AppException,
                                                                                                                                            curam.util.exception.InformationalException

This method allows the user to view the default list of milestones for a service plan. This list contains milestones at service plan level with a status of Not Started or In Progress.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listVersions

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ServicePlanDeliveryVersions listVersions(curam.serviceplans.facade.struct.ServicePlanDeliveryKey key)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Lists service plan delivery versions.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyAbsenceForPlanItem

@AccessLevel(value=EXTERNAL)
void modifyAbsenceForPlanItem(curam.serviceplans.facade.struct.PlannedItemAbsenceDetails details)
                                                    throws curam.util.exception.AppException,
                                                           curam.util.exception.InformationalException

Updates the specified absence record. Called when a user selects the option to update the absence details for a plan item.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyAttachment

@AccessLevel(value=EXTERNAL)
void modifyAttachment(curam.serviceplans.sl.entity.struct.PlannedItemAttachmentDetails plannedItemAttachmentDetails)
                                            throws curam.util.exception.AppException,
                                                   curam.util.exception.InformationalException

Method to modify the attachment of a planned item

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyAuthorizedUnits

@AccessLevel(value=EXTERNAL)
void modifyAuthorizedUnits(curam.serviceplans.facade.struct.PlannedItemIDKey key,
                                                        curam.serviceplans.facade.struct.ModifyAuthorizedUnitsDetails details)
                                                 throws curam.util.exception.AppException,
                                                        curam.util.exception.InformationalException

Modifies the authorized units on a service unit planned item. Only users with the 'Modify Authorized SID', configured in the administration component, can access this function. Called during service plan scheduling by a case worker.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyBasicPlanItem

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ModifyPlanItemReturnStruct modifyBasicPlanItem(curam.serviceplans.facade.struct.ModifyPlannedItemDetailsStruct modifyPlannedItemDetailsStruct)
                                                                                                      throws curam.util.exception.AppException,
                                                                                                             curam.util.exception.InformationalException

Modifies the basic planItem.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyClientParticipation

@AccessLevel(value=EXTERNAL)
void modifyClientParticipation(curam.serviceplans.facade.struct.ModifyClientParticipationDetails modifyClientParticipationDetails)
                                                     throws curam.util.exception.AppException,
                                                            curam.util.exception.InformationalException

Modifies details of client participation.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyClosureDetails

@AccessLevel(value=EXTERNAL)
void modifyClosureDetails(curam.serviceplans.facade.struct.ServicePlanDeliveryKey key,
                                                       curam.serviceplans.facade.struct.ModifyServicePlanClosureDetails details)
                                                throws curam.util.exception.AppException,
                                                       curam.util.exception.InformationalException

Modifies service plan closure details.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyContract

@AccessLevel(value=EXTERNAL)
void modifyContract(curam.serviceplans.facade.struct.ModifyServicePlanContractDetails modifyServicePlanContractDetails)
                                          throws curam.util.exception.AppException,
                                                 curam.util.exception.InformationalException

Updates the details of the service plan contract.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyMilestone

@AccessLevel(value=EXTERNAL)
void modifyMilestone(curam.serviceplans.facade.struct.SPMilestoneDeliveryDetails key)
                                           throws curam.util.exception.AppException,
                                                  curam.util.exception.InformationalException

Method to allow a user to modify milestone delivery details for a service plan.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyMilestoneForWaiver

@AccessLevel(value=EXTERNAL)
void modifyMilestoneForWaiver(curam.serviceplans.facade.struct.SPMilestoneDeliveryDetails details)
                                                    throws curam.util.exception.AppException,
                                                           curam.util.exception.InformationalException

This method is used to modify the service plan milestone delivery details

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyNominatedRepresentative

@AccessLevel(value=EXTERNAL)
void modifyNominatedRepresentative(curam.serviceplans.facade.struct.ModifyServicePlanParticipantDetails details)
                                                         throws curam.util.exception.AppException,
                                                                curam.util.exception.InformationalException

Modifies nominated representative.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyPlanGroup

@AccessLevel(value=EXTERNAL)
void modifyPlanGroup(curam.serviceplans.facade.struct.ModifyPlanGroupDetails modifyPlanGroupDetails)
                                           throws curam.util.exception.AppException,
                                                  curam.util.exception.InformationalException

Modifies the details of a plan group.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyPlanItemApprovalRequest

@AccessLevel(value=EXTERNAL)
void modifyPlanItemApprovalRequest(curam.serviceplans.facade.struct.ModifyRejectionDetails details)
                                                         throws curam.util.exception.AppException,
                                                                curam.util.exception.InformationalException

Modifies the planned item approval request.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyPlannedSubGoal

@AccessLevel(value=EXTERNAL)
void modifyPlannedSubGoal(curam.serviceplans.facade.struct.ModifyPlannedSubGoalDetails modifyPlannedSubGoalDetails)
                                                throws curam.util.exception.AppException,
                                                       curam.util.exception.InformationalException

modifies the details of a planned sub-goal.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyServicePlanApprovalRequest

@AccessLevel(value=EXTERNAL)
void modifyServicePlanApprovalRequest(curam.serviceplans.facade.struct.ModifyRejectionDetails details)
                                                            throws curam.util.exception.AppException,
                                                                   curam.util.exception.InformationalException

Modifies the service plan approval request.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyServicePlanBaseline

@AccessLevel(value=EXTERNAL)
void modifyServicePlanBaseline(curam.serviceplans.facade.struct.ModifyBaselineDetails modifyBaselineDetails)
                                                     throws curam.util.exception.AppException,
                                                            curam.util.exception.InformationalException

Modifies the details of the service plan baseline

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyServicePlanDetails

@AccessLevel(value=EXTERNAL)
void modifyServicePlanDetails(curam.serviceplans.facade.struct.ModifySPOutcomeAndCommentsKey key,
                                                           curam.serviceplans.facade.struct.ModifySPOutcomeAndCommentsDetails dtls)
                                                    throws curam.util.exception.AppException,
                                                           curam.util.exception.InformationalException

Modifies the outcome and comments for a service plan delivery.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyServicePlanGoal

@AccessLevel(value=EXTERNAL)
void modifyServicePlanGoal(curam.serviceplans.facade.struct.ModifyServicePlanGoalKey key,
                                                        curam.serviceplans.facade.struct.ModifyServicePlanGoalDetails dtls)
                                                 throws curam.util.exception.AppException,
                                                        curam.util.exception.InformationalException

Modifies a service plan goal.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyServicePlanPlanItem

@AccessLevel(value=EXTERNAL)
void modifyServicePlanPlanItem(curam.serviceplans.facade.struct.ModifyPlannedItemDetailsStruct modifyPlannedItemDetailsStruct)
                                                     throws curam.util.exception.AppException,
                                                            curam.util.exception.InformationalException

Modifies the planned item.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyServicePlanTypeAndComments

@AccessLevel(value=EXTERNAL)
curam.core.struct.InformationalMsgDtlsList modifyServicePlanTypeAndComments(curam.serviceplans.facade.struct.ModifyServicePlanTypeKey key,
                                                                                                         curam.serviceplans.facade.struct.ModifyServicePlanTypeDetails dtls)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Modifies the service plan type and the comments for the service plan.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyServiceUnitDelivery

@AccessLevel(value=EXTERNAL)
void modifyServiceUnitDelivery(curam.serviceplans.facade.struct.ServiceUnitDeliveryDetails dtls)
                                                     throws curam.util.exception.AppException,
                                                            curam.util.exception.InformationalException

Modify the service unit delivery details.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyServiceUnitPlannedItemDetails

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ModifyPlanItemReturnStruct modifyServiceUnitPlannedItemDetails(curam.serviceplans.facade.struct.ModifyPlannedItemDetailsStruct details)
                                                                                                                      throws curam.util.exception.AppException,
                                                                                                                             curam.util.exception.InformationalException

Modifies the service unit delivery planned item details.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

planItemClienParticipationWeeklyList

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.WeeklyPlanItemClientParticipationList planItemClienParticipationWeeklyList(curam.serviceplans.facade.struct.PlanItemActiveClientParticipationSearchKey planItemActiveClientParticipationSearchKey)
                                                                                                                                  throws curam.util.exception.AppException,
                                                                                                                                         curam.util.exception.InformationalException

Lists client participation summary for plan item for every week .

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

planItemClientParticipationWeeklyChart

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.PlanItemChartDetails planItemClientParticipationWeeklyChart(curam.serviceplans.facade.struct.PlanItemActiveClientParticipationSearchKey planItemActiveClientParticipationForDateRangeKey)
                                                                                                                   throws curam.util.exception.AppException,
                                                                                                                          curam.util.exception.InformationalException

Gets weekly summary of active client participations of plan item specified to display chart.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

populatePlanParticipants

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.PopulatedPlanParticipants populatePlanParticipants(curam.serviceplans.facade.struct.ServicePlanDeliveryKey key)
                                                                                                          throws curam.util.exception.AppException,
                                                                                                                 curam.util.exception.InformationalException

Populates integrated case member list and service plan participants list to add and/or remove case members as plan participants.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

printContract

@AccessLevel(value=EXTERNAL)
void printContract(curam.serviceplans.facade.struct.ServicePlanContractKey servicePlanContractKey)
                                         throws curam.util.exception.AppException,
                                                curam.util.exception.InformationalException

Prints a record of the service plan contract

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readAbsenceForPlanItem

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.PlannedItemAbsenceDetails readAbsenceForPlanItem(curam.serviceplans.facade.struct.PlannedItemAbsenceIDKey key)
                                                                                                        throws curam.util.exception.AppException,
                                                                                                               curam.util.exception.InformationalException

Retrieves the specified absence record details. Called when a user selects the option to view the details of an absence details record for a plan item.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readAuthorizedUnitDetailsForModify

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ReadAuthorizedUnitDetailsForModify readAuthorizedUnitDetailsForModify(curam.serviceplans.facade.struct.PlannedItemIDKey key)
                                                                                                                             throws curam.util.exception.AppException,
                                                                                                                                    curam.util.exception.InformationalException

Returns service unit details required for display on the modify authorized units screen. Called during service plan scheduling by a case worker.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readBaselinesForComparison

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ExistingBaselinesDetails readBaselinesForComparison(curam.serviceplans.facade.struct.BaselineIDAndCaseIDKey key)
                                                                                                           throws curam.util.exception.AppException,
                                                                                                                  curam.util.exception.InformationalException

Reads current baseline name and the list of all existing baselines for the service plan.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readClientParticipationDetails

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ViewClientParticipationDetails readClientParticipationDetails(curam.core.sl.entity.struct.DailyAttendanceKey key)
                                                                                                                     throws curam.util.exception.AppException,
                                                                                                                            curam.util.exception.InformationalException

Reads details of client participation.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readClosureDetails

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ModifyServicePlanClosureDetails readClosureDetails(curam.serviceplans.facade.struct.ServicePlanDeliveryKey key)
                                                                                                          throws curam.util.exception.AppException,
                                                                                                                 curam.util.exception.InformationalException

Reads service plan closure details for modify.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readContractDetailsForCreateContract

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.CaseParticipantRoleIDStruct readContractDetailsForCreateContract(curam.serviceplans.facade.struct.CaseIDAndParticipantRoleIDKey caseIDAndParticipantRoleIDKey)
                                                                                                                        throws curam.util.exception.AppException,
                                                                                                                               curam.util.exception.InformationalException

Reads the case participant role id based on case id and participant role id.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readContractIssuerDetails

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ContractClientNameAndParticipantRoleID readContractIssuerDetails(curam.core.facade.struct.CaseParticipantRoleIDKey caseParticipantRoleIDKey)
                                                                                                                        throws curam.util.exception.AppException,
                                                                                                                               curam.util.exception.InformationalException

Reads the participant role id and the client name for which a contract is to be issued to based on the case participant role id passed in.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readDetailsForAddServiceUnitDelivery

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ReadDetailsForAddServiceUnitDelivery readDetailsForAddServiceUnitDelivery(curam.serviceplans.facade.struct.PlannedItemIDKey plannedItemIDKey)
                                                                                                                                 throws curam.util.exception.AppException,
                                                                                                                                        curam.util.exception.InformationalException

Reads the details required to display the record service unit delivery screen.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readMilestone

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ReadMilestoneDeliveryDetails readMilestone(curam.core.sl.entity.struct.MilestoneDeliveryKey key)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Method to read the details of a milestone delivery.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readNominatedRepresentativeDetails

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ServicePlanParticipantDetails readNominatedRepresentativeDetails(curam.serviceplans.facade.struct.CaseParticipantRoleKey key)
                                                                                                                        throws curam.util.exception.AppException,
                                                                                                                               curam.util.exception.InformationalException

Reads nominated representative details for a service plan delivery.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readNominatedRepresentativeDetailsForModify

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ServicePlanParticipantDetails readNominatedRepresentativeDetailsForModify(curam.serviceplans.facade.struct.CaseParticipantRoleKey key)
                                                                                                                                 throws curam.util.exception.AppException,
                                                                                                                                        curam.util.exception.InformationalException

Reads nominated representative details for modify.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readOutcomeAchievedAndComments

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ReadOutcomeAchievedAndCommentsDetails readOutcomeAchievedAndComments(curam.serviceplans.facade.struct.ReadOutcomeAchievedAndCommentsKey key)
                                                                                                                            throws curam.util.exception.AppException,
                                                                                                                                   curam.util.exception.InformationalException

Reads the outcome and comments for a service plan delivery.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readPAApprovalRequestDetailsForModify

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.RejectionDetailsForModify readPAApprovalRequestDetailsForModify(curam.serviceplans.facade.struct.PAApprovalRequestKey key)
                                                                                                                       throws curam.util.exception.AppException,
                                                                                                                              curam.util.exception.InformationalException

Reads planned item approval request for modify.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readServicePlanContractAttachment

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadAttachmentDetails readServicePlanContractAttachment(curam.core.facade.struct.ReadAttachmentKey key)
                                                                                                       throws curam.util.exception.AppException,
                                                                                                              curam.util.exception.InformationalException

Reads the details for the service plan contract attachment.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readServicePlanGoals

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ReadServicePlanGoalsDetails readServicePlanGoals(curam.serviceplans.facade.struct.ReadServicePlanGoalsKey key)
                                                                                                        throws curam.util.exception.AppException,
                                                                                                               curam.util.exception.InformationalException

Reads a list of valid service plan goals.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readServicePlanTypesAndComments

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ReadServicePlanTypesAndCommentsDetails readServicePlanTypesAndComments(curam.serviceplans.facade.struct.ReadServicePlanTypesAndCommentsKey key)
                                                                                                                              throws curam.util.exception.AppException,
                                                                                                                                     curam.util.exception.InformationalException

Reads the Service plan types available for the integrated case on which the service plan in created and the comments for the service plan.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readServiceUnitDeliveryDetails

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ReadServiceUnitDeliveryDetails readServiceUnitDeliveryDetails(curam.serviceplans.facade.struct.ReadServiceUnitDeliveryKey readServiceUnitDeliveryKey)
                                                                                                                     throws curam.util.exception.AppException,
                                                                                                                            curam.util.exception.InformationalException

Reads a service unit delivery.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readSPApprovalRequestDetailsForModify

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.RejectionDetailsForModify readSPApprovalRequestDetailsForModify(curam.serviceplans.facade.struct.SPApprovalRequestKey key)
                                                                                                                       throws curam.util.exception.AppException,
                                                                                                                              curam.util.exception.InformationalException

Reads details for service plan approval request modification.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readSubGoalName

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.PlannedSubGoalNameKey readSubGoalName(curam.serviceplans.facade.struct.PlannedSubGoalNameStruct plannedSubGoalNameKey)
                                                                                             throws curam.util.exception.AppException,
                                                                                                    curam.util.exception.InformationalException

Reads the sub goal name based on type code.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

reject

@AccessLevel(value=EXTERNAL)
void reject(curam.serviceplans.facade.struct.ServicePlanDeliveryRejectDetails details)
                                  throws curam.util.exception.AppException,
                                         curam.util.exception.InformationalException

Rejects submitted service plan delivery.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

rejectPlanItem

@AccessLevel(value=EXTERNAL)
void rejectPlanItem(curam.serviceplans.facade.struct.PlannedItemIDKey plannedItemIDKey,
                                                 curam.serviceplans.facade.struct.RejectionReasonAndRejectionComments rejectionReasonAndRejectionComments)
                                          throws curam.util.exception.AppException,
                                                 curam.util.exception.InformationalException

Rejects a plan item.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

removeMilestone

@AccessLevel(value=EXTERNAL)
void removeMilestone(curam.core.sl.entity.struct.MilestoneDeliveryKey key)
                                           throws curam.util.exception.AppException,
                                                  curam.util.exception.InformationalException

Method to allow a user to remove a milestone from a service plan.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

removePlanGroup

@AccessLevel(value=EXTERNAL)
void removePlanGroup(curam.serviceplans.facade.struct.PlanGroupKey planGroupKey)
                                           throws curam.util.exception.AppException,
                                                  curam.util.exception.InformationalException

Removes physically a plan group.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

removePlannedSubGoal

@AccessLevel(value=EXTERNAL)
void removePlannedSubGoal(curam.serviceplans.facade.struct.PlannedSubGoalKey plannedSubGoalKey)
                                                throws curam.util.exception.AppException,
                                                       curam.util.exception.InformationalException

Remove physically a planned sub-goal.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

removeServicePlanBaseline

@AccessLevel(value=EXTERNAL)
void removeServicePlanBaseline(curam.serviceplans.facade.struct.BaselineKey baselineKey)
                                                     throws curam.util.exception.AppException,
                                                            curam.util.exception.InformationalException

Removes a service plan baseline from the database (physical remove).

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

resolveCreatePlanItemPage

@AccessLevel(value=EXTERNAL)
curam.serviceplans.sl.struct.CreatePageDetailsStruct resolveCreatePlanItemPage(curam.serviceplans.facade.struct.PlanItemIDDetailsStruct planItemIDDetailsStruct)
                                                                                                     throws curam.util.exception.AppException,
                                                                                                            curam.util.exception.InformationalException

Resolves the details of the create plan item page.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

resolveModifyPlanItemPage

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ModifyPageDetailsStruct resolveModifyPlanItemPage(curam.serviceplans.facade.struct.PlannedItemIDKey plannedItemIDKey)
                                                                                                         throws curam.util.exception.AppException,
                                                                                                                curam.util.exception.InformationalException

Resolves the details of the modify plan item page.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

resolvePlannedSubGoal

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.PageIdentifierDetails resolvePlannedSubGoal(curam.serviceplans.facade.struct.PlannedSubGoalTypeCodeKey key,
                                                                                                          curam.serviceplans.sl.entity.struct.ParentGroupIDKey parentGroupIDKey)
                                                                                                   throws curam.util.exception.AppException,
                                                                                                          curam.util.exception.InformationalException

Returns the correct sub-goal page depending on the amount of sub goals created for the selected type.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

resolveViewPlanItemPage

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ViewPageDetailsStruct resolveViewPlanItemPage(curam.serviceplans.facade.struct.PlannedItemIDKey plannedItemIDKey)
                                                                                                     throws curam.util.exception.AppException,
                                                                                                            curam.util.exception.InformationalException

Resolves the details of the view plan item page.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

searchICServicePlanEventandActivity

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ICServicePlanEventandActivity searchICServicePlanEventandActivity(curam.serviceplans.facade.struct.SearchCaseandEventKey key)
                                                                                                                         throws curam.util.exception.AppException,
                                                                                                                                curam.util.exception.InformationalException

Returns data representing case events and activities for a Service Plan

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

submit

@AccessLevel(value=EXTERNAL)
void submit(curam.serviceplans.facade.struct.ServicePlanDeliveryKey key)
                                  throws curam.util.exception.AppException,
                                         curam.util.exception.InformationalException

Submits service plan delivery for approval.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

submitPlanItem

@AccessLevel(value=EXTERNAL)
void submitPlanItem(curam.serviceplans.facade.struct.PlannedItemIDKey plannedItemIDKey)
                                          throws curam.util.exception.AppException,
                                                 curam.util.exception.InformationalException

Submits a plan item.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

updatePlanParticipants

@AccessLevel(value=EXTERNAL)
void updatePlanParticipants(curam.serviceplans.facade.struct.PlanParticipantDetailsForUpdate details)
                                                  throws curam.util.exception.AppException,
                                                         curam.util.exception.InformationalException

Manage plan participants by adding and/or removing integrated case members as plan participant.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

validateGoalExistsAndReturnSubGoalTypes

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.PlannedSubGoalTypeCodeDetailsList validateGoalExistsAndReturnSubGoalTypes(curam.serviceplans.facade.struct.PlannedSubGoalCaseIDKey plannedSubGoalCaseIDKey)
                                                                                                                                 throws curam.util.exception.AppException,
                                                                                                                                        curam.util.exception.InformationalException

Checks to see if a planned goal exists when listing the sub-goal types.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

viewAttachment

@AccessLevel(value=EXTERNAL)
curam.serviceplans.sl.entity.struct.PlannedItemAttachmentDetails viewAttachment(curam.serviceplans.sl.entity.struct.PlannedItemAttachmentLinkKey plannedItemAttachmentLinkKey)
                                                                                                      throws curam.util.exception.AppException,
                                                                                                             curam.util.exception.InformationalException

Method to view the Planned Item Attachment

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

viewAuthorizationHistoryDetails

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.AuthorizedUnitHistoryDetails viewAuthorizationHistoryDetails(curam.serviceplans.facade.struct.AuthorizedUnitHistoryKey key)
                                                                                                                    throws curam.util.exception.AppException,
                                                                                                                           curam.util.exception.InformationalException

Returns the authorized unit history details for a service unit planned item. Called during service plan scheduling by a case worker.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

viewAuthorizationHistoryList

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.AuthorizedUnitHistoryDetailsList viewAuthorizationHistoryList(curam.serviceplans.facade.struct.PlannedItemIDKey key)
                                                                                                                     throws curam.util.exception.AppException,
                                                                                                                            curam.util.exception.InformationalException

Returns the authorized unit history list details for a service unit planned item. Called during service plan scheduling by a case worker.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

viewBaselineGantt

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.BaselineGanttDetails viewBaselineGantt(curam.serviceplans.facade.struct.BaselineKey key)
                                                                                              throws curam.util.exception.AppException,
                                                                                                     curam.util.exception.InformationalException

Displays a Baseline Gantt

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

viewBaselineHome

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ReadBaselineDetails viewBaselineHome(curam.serviceplans.facade.struct.BaselineKey baselineKey)
                                                                                            throws curam.util.exception.AppException,
                                                                                                   curam.util.exception.InformationalException

Reads the details of a baseline

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

viewBaselinePlanContentList

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.BaselinePlanContentList viewBaselinePlanContentList(curam.serviceplans.facade.struct.BaselineKey key)
                                                                                                           throws curam.util.exception.AppException,
                                                                                                                  curam.util.exception.InformationalException

Returns the baseline content list

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

viewBaselinePlanGroupDetails

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.BaselinePlanGroupDetails viewBaselinePlanGroupDetails(curam.serviceplans.facade.struct.BaselinePlanGroupReadDetailsKey key)
                                                                                                             throws curam.util.exception.AppException,
                                                                                                                    curam.util.exception.InformationalException

reads the details of a Baseline Plan Group.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

viewClosureDetails

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ServicePlanDeliveryClosureDetails viewClosureDetails(curam.serviceplans.facade.struct.ServicePlanDeliveryKey key)
                                                                                                            throws curam.util.exception.AppException,
                                                                                                                   curam.util.exception.InformationalException

Returns service plan delivery closure details.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

viewCompleteContract

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ReadCompleteContractDetails viewCompleteContract(curam.serviceplans.facade.struct.ServicePlanContractKey servicePlanContractKey)
                                                                                                        throws curam.util.exception.AppException,
                                                                                                               curam.util.exception.InformationalException

Views the service plan contract and displays it to the user.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

viewContractHome

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ReadContractHomeDetails viewContractHome(curam.serviceplans.facade.struct.ServicePlanContractKey servicePlanContractKey)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Views the details of the contract home page.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

viewPlanGroupDetails

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ReadPlannedGroupDetails viewPlanGroupDetails(curam.serviceplans.facade.struct.PlanGroupKey planGroupKey)
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

Displays details of a plan group with a list of any planned sub-goals or additional groups that have been added to the plan group.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

viewPlanItem

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ViewPlannedItemDetailsStruct viewPlanItem(curam.serviceplans.facade.struct.PlannedItemIDKey plannedItemIDKey)
                                                                                                 throws curam.util.exception.AppException,
                                                                                                        curam.util.exception.InformationalException

Resolves the details of the planned item.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

viewPlanItemApprovalRequest

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.PlannedItemApprovalRequestDetails viewPlanItemApprovalRequest(curam.serviceplans.facade.struct.PAApprovalRequestKey paApprovalRequestKey)
                                                                                                                     throws curam.util.exception.AppException,
                                                                                                                            curam.util.exception.InformationalException

Reads the planned item approval request.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

viewPlannedSubGoal

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ReadPlannedSubGoalDetailsForModification viewPlannedSubGoal(curam.serviceplans.facade.struct.PlannedSubGoalKey plannedSubGoalKey)
                                                                                                                   throws curam.util.exception.AppException,
                                                                                                                          curam.util.exception.InformationalException

reads the details of a planned sub-goal.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

viewPlannedSubGoalWithPlannedItems

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ReadPlannedSubGoalDetailsWithPlannedItemsDetails viewPlannedSubGoalWithPlannedItems(curam.serviceplans.facade.struct.PlannedSubGoalKey plannedSubGoalKey)
                                                                                                                                           throws curam.util.exception.AppException,
                                                                                                                                                  curam.util.exception.InformationalException

list details of planned sub-goal with it's corresponding planned items.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

viewServicePlanApprovalRequest

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ServicePlanApprovalRequestFullDetails viewServicePlanApprovalRequest(curam.serviceplans.facade.struct.SPApprovalRequestKey spApprovalRequestKey)
                                                                                                                            throws curam.util.exception.AppException,
                                                                                                                                   curam.util.exception.InformationalException

Reads the service plan approval request.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

viewServicePlanBaselinePlannedItemDetails

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ViewBaselinePlannedItemDetails viewServicePlanBaselinePlannedItemDetails(curam.serviceplans.sl.entity.struct.BaselinePlanItemKey baselinePlanItemKey)
                                                                                                                                throws curam.util.exception.AppException,
                                                                                                                                       curam.util.exception.InformationalException

Method to view the planned item details of a given base line

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

viewServicePlanBaselineSubGoalDetails

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.BaselineSubGoalDetails viewServicePlanBaselineSubGoalDetails(curam.serviceplans.facade.struct.BaselineSubGoalKey baselineSubGoalKey)
                                                                                                                    throws curam.util.exception.AppException,
                                                                                                                           curam.util.exception.InformationalException

Views the details of a baseline sub goal record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

viewServiceUnitPlannedItemDetails

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.PlannedItemAndServiceUnitDetails viewServiceUnitPlannedItemDetails(curam.serviceplans.facade.struct.PlannedItemIDKey key)
                                                                                                                          throws curam.util.exception.AppException,
                                                                                                                                 curam.util.exception.InformationalException

Reads the service unit delivery planned item details.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

viewTrackingGantt

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.TrackingGanttDetails viewTrackingGantt(curam.serviceplans.facade.struct.ServicePlanDeliveryKey servicePlanDeliveryKey)
                                                                                              throws curam.util.exception.AppException,
                                                                                                     curam.util.exception.InformationalException

View the Tracking Gantt for a Service Plan.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listClienParticipationForPlannedItem

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.PlannedItemClientParticipationList listClienParticipationForPlannedItem(curam.serviceplans.facade.struct.PlanItemClientParticipationSearchKey key)
                                                                                                                               throws curam.util.exception.AppException,
                                                                                                                                      curam.util.exception.InformationalException

Lists all client participation records with time absent information for selected planItem.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listClienParticipationForServicePlan

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ServicePlanClientParticipationList listClienParticipationForServicePlan(curam.serviceplans.facade.struct.CaseClientParticipationKey key)
                                                                                                                               throws curam.util.exception.AppException,
                                                                                                                                      curam.util.exception.InformationalException

List all client participation records with time absent information for all planItems of service plan delivery.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

plannedItemParticipationForWeekList

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.PIDailyAttendanceDetailsList plannedItemParticipationForWeekList(curam.serviceplans.facade.struct.PlanItemClientParticipationForDateRangeKey key)
                                                                                                                        throws curam.util.exception.AppException,
                                                                                                                               curam.util.exception.InformationalException

Lists all client participation records with time absent information for particular plan item for a week specified.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

getListOfApprovalCriteriaForPlannedItem

@AccessLevel(value=EXTERNAL)
curam.serviceplans.sl.struct.PlannedItemApprovalCriteriaLinkDetailsList getListOfApprovalCriteriaForPlannedItem(curam.serviceplans.facade.struct.PlannedItemIDKey key)
                                                                                                                                      throws curam.util.exception.AppException,
                                                                                                                                             curam.util.exception.InformationalException

Method to get the list of planned item approval criteria details.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

viewGroupTrackingGantt

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ServicePlanTrackingGanttDetails viewGroupTrackingGantt(curam.serviceplans.facade.struct.ServicePlanGroupDeliveryKey servicePlanGroupDeliveryKey)
                                                                                                              throws curam.util.exception.AppException,
                                                                                                                     curam.util.exception.InformationalException

Views Group Tracking Gantt

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

viewIntegratedTrackingGantt

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ServicePlanTrackingGanttDetails viewIntegratedTrackingGantt(curam.serviceplans.facade.struct.IntegratedServicePlanKey integratedServicePlanKey)
                                                                                                                   throws curam.util.exception.AppException,
                                                                                                                          curam.util.exception.InformationalException

Views Integrated Tracking Gantt

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

getServicePlanGroupContextDescription

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.SPDeliveryContextDescription getServicePlanGroupContextDescription(curam.serviceplans.facade.struct.ServicePlanGroupDeliveryKey servicePlanGroupDeliveryKey)
                                                                                                                          throws curam.util.exception.AppException,
                                                                                                                                 curam.util.exception.InformationalException

Retrieves Service Plan Group Context Description

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

getIntegratedServicePlanContextDescription

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.SPDeliveryContextDescription getIntegratedServicePlanContextDescription(curam.serviceplans.facade.struct.IntegratedServicePlanKey integratedServicePlanKey)
                                                                                                                               throws curam.util.exception.AppException,
                                                                                                                                      curam.util.exception.InformationalException

Gets Integrated Service Plan Context Description

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

getICServicePlanGroupMenuData

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ICServicePlanDeliveryMenuDataDetails getICServicePlanGroupMenuData(curam.serviceplans.facade.struct.ServicePlanGroupDeliveryKey servicePlanGroupDeliveryKey)
                                                                                                                          throws curam.util.exception.AppException,
                                                                                                                                 curam.util.exception.InformationalException

Gets IC Service Plan Group Menu Data

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

getICIntegratedServicePlanMenuData

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ICServicePlanDeliveryMenuDataDetails getICIntegratedServicePlanMenuData(curam.serviceplans.facade.struct.IntegratedServicePlanKey integratedServicePlanKey)
                                                                                                                               throws curam.util.exception.AppException,
                                                                                                                                      curam.util.exception.InformationalException

Retrieves IC Integrated Service Plan Menu Data

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

showServicePlanGroupStatement

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.SPStatementXMLString showServicePlanGroupStatement(curam.serviceplans.facade.struct.ServicePlanGroupDeliveryKey servicePlanGroupDeliveryKey)
                                                                                                          throws curam.util.exception.AppException,
                                                                                                                 curam.util.exception.InformationalException

Displays Service Plan Group Statement

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

showIntegratedServicePlanStatement

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.SPStatementXMLString showIntegratedServicePlanStatement(curam.serviceplans.facade.struct.IntegratedServicePlanKey integratedServicePlanKey)
                                                                                                               throws curam.util.exception.AppException,
                                                                                                                      curam.util.exception.InformationalException

Displays Integrated Service Plan Statement

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

ICCreateWithGroupDelivery

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ServicePlanDeliveryKey ICCreateWithGroupDelivery(curam.serviceplans.facade.struct.ICCreateServicePlanDeliveryAndGroupDetails dtls)
                                                                                                        throws curam.util.exception.AppException,
                                                                                                               curam.util.exception.InformationalException

Creates a new service plan delivery on the Integrated Case level and a link record between the service plan delivery and the service plan group delivery.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

getSPGDServicePlanMenuData

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ServicePlanDeliveryMenuDataDetails getSPGDServicePlanMenuData(curam.serviceplans.facade.struct.ServicePlanDeliveryMenuKey servicePlanDeliveryMenuKey)
                                                                                                                     throws curam.util.exception.AppException,
                                                                                                                            curam.util.exception.InformationalException

Returns the SPGD Service Plan menu data.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

getServicePlanMenuData

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ServicePlanDeliveryMenuDataDetails getServicePlanMenuData(curam.serviceplans.facade.struct.ServicePlanDeliveryMenuKey servicePlanDeliveryMenuKey)
                                                                                                                 throws curam.util.exception.AppException,
                                                                                                                        curam.util.exception.InformationalException

Returns the Service Plan menu data.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readEstimatedCostOfPlannedItemID

@AccessLevel(value=EXTERNAL)
curam.serviceplans.sl.entity.struct.PlannedItemEstimatedCost readEstimatedCostOfPlannedItemID(curam.serviceplans.facade.struct.PlannedItemIDKey key)
                                                                                                                    throws curam.util.exception.AppException,
                                                                                                                           curam.util.exception.InformationalException

Reads the estimated cost for the passed in planned item.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

servicePlanParticipationForWeekList

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ServicePlanClientParticipationList servicePlanParticipationForWeekList(curam.serviceplans.facade.struct.CaseClientParticipationForDateRangeKey key)
                                                                                                                              throws curam.util.exception.AppException,
                                                                                                                                     curam.util.exception.InformationalException

Lists all client participation records with time absent information for all planItems of the service plan for a week specified.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listContractswithCaseStatus

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.SPContractDetailsListwithCaseStatus listContractswithCaseStatus(curam.serviceplans.facade.struct.ServicePlanDeliveryKey key)
                                                                                                                       throws curam.util.exception.AppException,
                                                                                                                              curam.util.exception.InformationalException

Contains a list of contracts with service plan status for a specific service plan.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listByICCase

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ListServicePlanForIC listByICCase(curam.serviceplans.facade.struct.ServicePlanIntegratedCaseKey key)
                                                                                         throws curam.util.exception.AppException,
                                                                                                curam.util.exception.InformationalException

Lists service plan deliveries for all members of the integrated case.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listPlanContentforServicePlans

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ServicePlanContentDetailsList listPlanContentforServicePlans(curam.serviceplans.facade.struct.ServicePlanDeliveryKey key)
                                                                                                                    throws curam.util.exception.AppException,
                                                                                                                           curam.util.exception.InformationalException

Displays a list of all plan groups and sub-goals that have been added directly to a selected service plan goal.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listICServicePlanEventDetails1

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ListICServicePlanEventDetails1 listICServicePlanEventDetails1(curam.serviceplans.facade.struct.SearchCaseandEventKey key)
                                                                                                                     throws curam.util.exception.AppException,
                                                                                                                            curam.util.exception.InformationalException

Method to return the list of events on the service plan.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readHomePageDetails1

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ServicePlanDeliveryHomePageDetails1 readHomePageDetails1(curam.serviceplans.facade.struct.ServicePlanDeliveryKey key)
                                                                                                                throws curam.util.exception.AppException,
                                                                                                                       curam.util.exception.InformationalException

Replaces the deprecated method readServicePlanDeliveryHomeDetails(ServicePlanDeliveryKey).

Reads serviceplan delivery home page details, including indicators to denote which manage actions should be visible to the user.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

getWeeklyClientParticipationWizard

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.WizardProperties getWeeklyClientParticipationWizard()
                                                                                                   throws curam.util.exception.AppException,
                                                                                                          curam.util.exception.InformationalException

Returns the wizard details for the Weekly Client Participation wizard.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

displayServicePlanStatement

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ServicePlanStatementDisplayDetails displayServicePlanStatement(curam.serviceplans.facade.struct.ServicePlanDeliveryKey servicePlanDeliveryKey)
                                                                                                                      throws curam.util.exception.AppException,
                                                                                                                             curam.util.exception.InformationalException

Returns service plan statement if it is available, else it returns informational message.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readPossibleOutcomesAndSubGoalNameDetailsForPlanItem

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ExpectedOutcomesForPlanItemDtlsList readPossibleOutcomesAndSubGoalNameDetailsForPlanItem(curam.serviceplans.facade.struct.PlannedSubGoalKey plannedSubGoalKey,
                                                                                                                                                       curam.serviceplans.facade.struct.PlanItemKey planItemKey)
                                                                                                                                                throws curam.util.exception.AppException,
                                                                                                                                                       curam.util.exception.InformationalException

Reads the outcomes and goal name for an plan item based on the plan item id and planned sub goal id.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readDtlsForAddServiceUnitPlannedItem

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ReadDtlsForAddServiceUnitPlannedItem readDtlsForAddServiceUnitPlannedItem(curam.serviceplans.facade.struct.PlannedSubGoalKey plannedSubGoalKey,
                                                                                                                                        curam.serviceplans.facade.struct.PlanItemKey key)
                                                                                                                                 throws curam.util.exception.AppException,
                                                                                                                                        curam.util.exception.InformationalException

Reads the details necessary to display the add service unit plan item to sub-goal screen.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

viewPlannedGroupAndSubGoalDetails

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.ReadPlannedGroupAndSubGoalDetails viewPlannedGroupAndSubGoalDetails(curam.serviceplans.facade.struct.PlanGroupKey planGroupKey)
                                                                                                                           throws curam.util.exception.AppException,
                                                                                                                                  curam.util.exception.InformationalException

Displays details of a plan group with a list of any planned sub-goals or additional groups that have been added to the plan group. It also returns plan content type along with the sub-goal details for the planned group.

This method is intended to be used by users responsible for maintaining service plan case.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listPlanParticipants1

@AccessLevel(value=EXTERNAL)
curam.serviceplans.facade.struct.PlanParticipantList1 listPlanParticipants1(curam.serviceplans.facade.struct.ServicePlanDeliveryKey key)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

This method lists all the plan participant records for a service plan delivery.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createBasicPlanItemToSubGoal

@AccessLevel(value=EXTERNAL)
void createBasicPlanItemToSubGoal(curam.serviceplans.facade.struct.PlannedItemDetailsStruct createPlannedItemDetailsStruct)
                                                        throws curam.util.exception.AppException,
                                                               curam.util.exception.InformationalException

Adds a service plan basic plan item to a planned subgoal.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createServiceUnitDeliveryPlanItemToSubGoal

@AccessLevel(value=EXTERNAL)
void createServiceUnitDeliveryPlanItemToSubGoal(curam.serviceplans.facade.struct.PlannedItemDetailsStruct details)
                                                                      throws curam.util.exception.AppException,
                                                                             curam.util.exception.InformationalException

Adds a service unit delivery plan item to a planned subgoal.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

viewBaselineMilestoneDetails

@AccessLevel(value=EXTERNAL)
curam.serviceplans.sl.entity.struct.BaselineMilestoneDtls viewBaselineMilestoneDetails(curam.serviceplans.sl.entity.struct.BaselineMilestoneKey key)
                                                                                                             throws curam.util.exception.AppException,
                                                                                                                    curam.util.exception.InformationalException

This method is used by the application to view the baseline milestone details for a service plan baseline.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

Interface ServicePlanDelivery