@AccessLevel(value=EXTERNAL)
public interface ServiceDelivery
extends curam.util.persistence.StandardEntity, curam.util.persistence.helper.Lifecycle<curam.codetable.impl.SERVICEDELIVERYSTATUSEntry>, curam.util.persistence.OptimisticLockModifiable, curam.piwrapper.outcomeplan.impl.OutcomePlanActivity, curam.progress.impl.Progressable, curam.piwrapper.attendance.impl.DailyAttendanceRelatedItem, curam.clientdiary.impl.ScheduledAppointment, curam.piwrapper.outcomeplan.impl.Reviewable, curam.piwrapper.outcomeplan.impl.OutcomePlanDateTrackableItem
Modifier and Type | Interface and Description |
---|---|
static interface |
ServiceDelivery.ServiceDeliveryApprovalEvents
A ServiceDeliveryApprovalEvents class is used for managing the service
delivery
events for approving a service delivery.
|
static interface |
ServiceDelivery.ServiceDeliveryCompleteEvents
A ServiceDeliveryCompleteEvents class is used for managing the service
delivery
events triggered during completing the service delivery.
|
static interface |
ServiceDelivery.ServiceDeliveryRejectApprovalEvents
A ServiceDeliveryRejectApprovalEvents class is used for managing the
service delivery
events triggered during rejecting the service delivery.
|
static interface |
ServiceDelivery.ServiceDeliveryStartEvents
A ServiceDeliveryStartEvents class is used for managing the service
delivery
events triggered during starting the delivery of service.
|
static interface |
ServiceDelivery.ServiceDeliverySubmitEvents
A ServiceDeliverySubmitEvents class is used for managing the service
delivery
events triggered during submitting the service delivery.
|
static interface |
ServiceDelivery.ServiceDeliveryValidator
A ServiceDeliveryValidator class is used for managing validations on a
service delivery.
|
Modifier and Type | Method and Description |
---|---|
void |
addComment(java.lang.String comment,
int versionNo)
Adds a comments to a service delivery.
|
void |
approve(int versionNo)
Approves a service delivery.
|
void |
cancel(int versionNo)
Cancels a service delivery.
|
void |
checkViewSecurityRights()
Checks if the current user has view access rights to this service delivery.
|
void |
complete(int versionNo)
Completes a service delivery.
|
curam.util.type.Money |
getActualCost()
Reads the actual cost for a service delivery.
|
curam.util.type.Money |
getAuthorizedRate()
Reads the authorized rate for a service delivery.
|
curam.piwrapper.user.impl.User |
getCompletedBy()
Reads the user who completed a service delivery.
|
java.lang.String |
getCompletionComments()
Reads the comments added on completion of a service delivery.
|
curam.util.type.Date |
getCompletionDate()
Reads the date on which a service delivery was completed.
|
curam.util.type.Date |
getCoverPeriodEndDate()
Reads the date the service is expected to end.
|
curam.util.type.Date |
getCoverPeriodStartDate()
Reads the date the service is expected to start.
|
curam.piwrapper.user.impl.User |
getCreatedBy()
Reads the used who created a service delivery.
|
curam.util.type.Date |
getCreationDate()
Reads the date on which a service delivery was created.
|
curam.serviceoffering.impl.SODELIVERYTYPEEntry |
getDeliveryType()
Reads the type of delivery provided by a service.
|
java.lang.Long |
getDeliveryTypeRelatedID()
Reads the key of the related object used to store information about the
service delivery.
|
curam.util.type.Money |
getEstimatedCost()
Reads the estimated cost of a service delivery.
|
FederalAllowableComponent |
getFederalAllowableComponent()
Reads a federal allowable component associated with a service delivery.
|
PaymentInformation |
getLatestPayment()
Reads the latest payment details among the set of payments made for a
service delivery.
|
curam.participant.impl.ConcernRole |
getNomineeConcernRole()
The key of a nominee.
|
curam.piwrapper.impl.Note |
getNote()
Reads the comments on a service delivery.
|
curam.piwrapper.outcomeplan.codetable.impl.ACTIVITYOUTCOMEACHIEVEDEntry |
getOutcomeAchieved()
Indicates whether the expected outcome was achieved i.e.
|
curam.piwrapper.outcomeplan.codetable.impl.ACTIVITYOUTCOMEREASONEntry |
getOutcomeReason()
Reads the outcome reason for a service delivery.
|
curam.piwrapper.user.impl.User |
getOwner()
Reads the owner of a service delivery.
|
Provider |
getProvider()
Reads the provider associated with a service delivery.
|
curam.provider.impl.ProviderTypeNameEntry |
getProviderType()
Reads the type of provider associated with the service.
|
java.lang.String |
getReason()
Reads the reason of creating a service delivery.
|
curam.piwrapper.caseheader.impl.CaseHeader |
getRelatedCase()
Reads the related case associated with a service delivery.
|
curam.codetable.impl.SENSITIVITYEntry |
getSensitivity()
Reads the sensitivity level associated with a service delivery.
|
ServiceAuthorization |
getServiceAuthorization()
Reads a service authorization associated with a service delivery.
|
ServiceDeliveryEvaluation |
getServiceDeliveryEvaluation()
Reads the evaluation details associated with a service delivery.
|
curam.util.type.FrequencyPattern |
getServiceFrequencyPattern()
Reads the frequency pattern for the delivery of units of a service.
|
ServiceOffering |
getServiceOffering()
Reads the service details related to a service delivery.
|
curam.piwrapper.user.impl.User |
getSupervisor()
Reads the supervisor of a service delivery.
|
int |
getTotalUnitsAuthorized()
Reads the total number of units authorized for a service delivery.
|
int |
getUnitsAuthorized()
Reads the number of units authorized for a service delivery.
|
int |
getUnitsConsumed()
Reads the number of units consumed by a service delivery.
|
int |
getUnitsRemaining()
Reads the remaining number of units of a service delivery.
|
void |
inProgress(int versionNo)
Sets the status of service delivery from 'Completed' to 'In Progress' and
reverts the service delivery completion details such CompletedBy and
CompletionDate.
|
void |
insert(java.util.List<curam.piwrapper.casemanager.impl.CaseParticipantRole> serviceRecipientList)
Creates a service delivery for the case participants.
|
void |
modifyParticipants(java.util.List<curam.piwrapper.casemanager.impl.CaseParticipantRole> serviceRecipientList,
int versionNo)
Modifies the participants of a service delivery.
|
void |
reject(int versionNo)
Rejects a service delivery.
|
void |
setAuthorizedRate(curam.util.type.Money authorizedRate)
Sets the authorized rate for the service delivery.
|
void |
setCaseHeader(curam.piwrapper.caseheader.impl.CaseHeader caseHeader)
Sets the case details to a service delivery.
|
void |
setCompletionComments(java.lang.String completionComments)
Sets the comments for completing a service delivery.
|
void |
setCoverPeriodEndDate(curam.util.type.Date coverPeriodEndDate)
Sets the date when the service is expected to end.
|
void |
setCoverPeriodStartDate(curam.util.type.Date coverPeriodStartDate)
Sets the date when the service is expected to start.
|
void |
setDeliveryTypeRelatedID(java.lang.Long deliveryTypeRelatedID)
Sets the details of related object.
|
void |
setDuration(int numberOfHours,
int numberOfMinutes)
Sets the duration of time a client should participate in the a service.
|
void |
setFederalAllowableComponent(FederalAllowableComponent federalAllowableComponent)
Sets the federal allowable component for a service delivery.
|
void |
setFrequencyPattern(java.lang.String frequencyPattern)
Sets the frequency pattern for a service delivery.
|
void |
setNomimeeConcernRole(curam.participant.impl.ConcernRole nomineeConcernRole)
Sets the nominee for a service delivery.
|
void |
setOutcomeAchieved(curam.piwrapper.outcomeplan.codetable.impl.ACTIVITYOUTCOMEACHIEVEDEntry outcomeAchieved)
Sets the outcome achieved for a service delivery.
|
void |
setOutcomeReason(curam.piwrapper.outcomeplan.codetable.impl.ACTIVITYOUTCOMEREASONEntry outcomeUnsuccessfulReason)
Sets the outcome reason for a service delivery.
|
void |
setOwner(java.lang.String owner)
Sets the owner for a service delivery.
|
void |
setParticipationFrequencyPattern(java.lang.String participationFrequency)
Sets the frequency pattern for the number of times the client(s) is
expected to
participate in a service.
|
void |
setProvider(Provider serviceProvider)
Sets the service provider for a service delivery.
|
void |
setProviderType(curam.provider.impl.ProviderTypeNameEntry serviceProviderType)
Sets the service provider type for a service delivery.
|
void |
setReason(java.lang.String reason)
Sets the reason for a service delivery.
|
void |
setSensitivity(curam.codetable.impl.SENSITIVITYEntry sensitivity)
Sets the service for delivery.
|
void |
setServiceAuthorization(ServiceAuthorization serviceAuthorization)
Sets the service authorization to a service delivery.
|
void |
setServiceDeliveryEvaluation(ServiceDeliveryEvaluation serviceDeliveryEvaluation)
Sets the service delivery evaluation for a service delivery.
|
void |
setServiceOffering(ServiceOffering serviceOffering)
Sets the service for delivery.
|
void |
setSupervisor(java.lang.String supervisor)
Sets the supervisor for a service delivery.
|
void |
setUnitsAuthorized(int unitsAuthorized)
Sets the number of units authorized for a service delivery.
|
void |
start(int versionNo)
Starts a service delivery.
|
void |
submit(int versionNo)
Submits a service delivery.
|
void |
updateProvider(Provider provider,
int versionNo)
Modifies the service provider of a service delivery.
|
void |
updateProviderType(curam.provider.impl.ProviderTypeNameEntry providerType,
int versionNo)
Modifies the type of service provider for a service delivery.
|
getActivityStatus, getActivityType, getListSummaryURI, getName, getOutcomePlanActivityAdmin, getServiceOfferingID, getTabURI, getWorkspaceSummaryURI, isActive, isParticipationAllowed, listCaseParticipantRoles
getProgressableRelatedType, isProgressUpdateAllowed
getAttendanceRelatedType, getDurationHours, getDurationMinutes, getFrequencyPattern, listParticipation
getClientDiaryRelatedType, getDescription, getEnd, getFrequencyAndDuration, getOwnerName, getOwnerOrgObjectReference, getOwnerOrgObjectType, getStart
getCompletionURI, getName, getOutcome, getReviewRelatedType, getTabURI, isCompleted, isCompletionAllowed
getCase, getClients, getDateTrackableItemType, getDaysOverDue, getExpectedEndDate, getItemName, getItemsOverDueCompletionConfigType, getItemsToCompleteConfigType, getStartDate, getTabURI, isCompleted, isDueToCompleteOnOrBefore, isDueToStartOnOrBefore, isOverdueCompletion
@AccessLevel(value=EXTERNAL) @Implementable void approve(int versionNo) throws curam.util.exception.InformationalException, curam.util.exception.AppException
versionNo
- The version number of the service delivery.curam.util.exception.InformationalException
curam.util.exception.AppException
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable void reject(int versionNo) throws curam.util.exception.InformationalException, curam.util.exception.AppException
versionNo
- The version number of the service delivery.curam.util.exception.InformationalException
curam.util.exception.AppException
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable void submit(int versionNo) throws curam.util.exception.InformationalException, curam.util.exception.AppException
versionNo
- The version number of the service delivery.curam.util.exception.InformationalException
curam.util.exception.AppException
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable void start(int versionNo) throws curam.util.exception.InformationalException, curam.util.exception.AppException
versionNo
- The version number of the service delivery.curam.util.exception.InformationalException
curam.util.exception.AppException
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable void complete(int versionNo) throws curam.util.exception.InformationalException, curam.util.exception.AppException
versionNo
- The version number of the service delivery.curam.util.exception.InformationalException
curam.util.exception.AppException
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable void inProgress(int versionNo) throws curam.util.exception.InformationalException, curam.util.exception.AppException
versionNo
- The version number of the service delivery.curam.util.exception.InformationalException
curam.util.exception.AppException
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable void insert(java.util.List<curam.piwrapper.casemanager.impl.CaseParticipantRole> serviceRecipientList) throws curam.util.exception.AppException, curam.util.exception.InformationalException
serviceRecipientList
- The list of case participant keys.curam.util.exception.AppException
curam.util.exception.InformationalException
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable void setServiceOffering(ServiceOffering serviceOffering)
serviceOffering
- Contains service details.ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable void setSensitivity(curam.codetable.impl.SENSITIVITYEntry sensitivity)
serviceOffering
- Contains service details.ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable void setOwner(java.lang.String owner)
owner
- The owner details.ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable void setSupervisor(java.lang.String supervisor)
supervisor
- The supervisor for the service delivery.ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable void setCoverPeriodStartDate(curam.util.type.Date coverPeriodStartDate)
coverPeriodStartDate
- The start date of the service.ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable void setCoverPeriodEndDate(curam.util.type.Date coverPeriodEndDate)
coverPeriodEndDate
- The end date of the service.ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable void setUnitsAuthorized(int unitsAuthorized)
unitsAuthorized
- The number of units authorized.ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable void setServiceAuthorization(ServiceAuthorization serviceAuthorization)
serviceAuthorization
- Contains the service authorization details.ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable void modifyParticipants(java.util.List<curam.piwrapper.casemanager.impl.CaseParticipantRole> serviceRecipientList, int versionNo) throws curam.util.exception.AppException, curam.util.exception.InformationalException
serviceRecipientList
- The list of participants.versionNo
- The version number of the service delivery.curam.util.exception.AppException
curam.util.exception.InformationalException
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable void cancel(int versionNo) throws curam.util.exception.InformationalException, curam.util.exception.AppException
versionNo
- The version number of the service delivery.curam.util.exception.InformationalException
curam.util.exception.AppException
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable void setFrequencyPattern(java.lang.String frequencyPattern)
frequencyPattern
- The frequency pattern for the service delivery.ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable void setAuthorizedRate(curam.util.type.Money authorizedRate)
authorizedRate
- The authorized rate for the service delivery.ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable void setReason(java.lang.String reason)
reason
- The reason for the service delivery.ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable void setProvider(Provider serviceProvider)
serviceProvider
- The provide service details for the service delivery.ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable void setProviderType(curam.provider.impl.ProviderTypeNameEntry serviceProviderType)
serviceProviderType
- The service provider type for the service delivery.ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable void setNomimeeConcernRole(curam.participant.impl.ConcernRole nomineeConcernRole)
nomineeConcernRole
- The details of the nominee.ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable void setOutcomeAchieved(curam.piwrapper.outcomeplan.codetable.impl.ACTIVITYOUTCOMEACHIEVEDEntry outcomeAchieved)
outcomeAchieved
- The outcome achieved code.ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable void setParticipationFrequencyPattern(java.lang.String participationFrequency)
participationFrequency
- The participation frequency pattern for the client(s) for the
service.ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable void setDuration(int numberOfHours, int numberOfMinutes)
numberOfHours
- The number of hours of participation.numberOfMinutes
- The number of minutes of participation.ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable void addComment(java.lang.String comment, int versionNo) throws curam.util.exception.InformationalException, curam.util.exception.AppException
comment
- The comment on the service delivery.versionNo
- The version number of the service delivery.curam.util.exception.InformationalException
curam.util.exception.AppException
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable curam.piwrapper.caseheader.impl.CaseHeader getRelatedCase()
getRelatedCase
in interface curam.piwrapper.outcomeplan.impl.OutcomePlanActivity
getRelatedCase
in interface curam.piwrapper.outcomeplan.impl.Reviewable
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable curam.util.type.Date getCoverPeriodStartDate()
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable curam.util.type.Date getCoverPeriodEndDate()
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable int getUnitsAuthorized()
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable int getTotalUnitsAuthorized()
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable int getUnitsConsumed()
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable int getUnitsRemaining()
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable curam.util.type.Money getAuthorizedRate()
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable curam.util.type.Money getActualCost() throws curam.util.exception.AppException, curam.util.exception.InformationalException
curam.util.exception.AppException
curam.util.exception.InformationalException
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable curam.util.type.Money getEstimatedCost()
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable curam.piwrapper.impl.Note getNote() throws curam.util.exception.InformationalException
curam.util.exception.InformationalException
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable java.lang.String getReason()
getReason
in interface curam.piwrapper.outcomeplan.impl.Reviewable
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable curam.piwrapper.outcomeplan.codetable.impl.ACTIVITYOUTCOMEACHIEVEDEntry getOutcomeAchieved()
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable curam.codetable.impl.SENSITIVITYEntry getSensitivity()
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable ServiceOffering getServiceOffering()
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable curam.piwrapper.user.impl.User getOwner()
getOwner
in interface curam.piwrapper.outcomeplan.impl.OutcomePlanActivity
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable curam.piwrapper.user.impl.User getSupervisor()
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable Provider getProvider()
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable curam.provider.impl.ProviderTypeNameEntry getProviderType()
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable curam.participant.impl.ConcernRole getNomineeConcernRole()
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable ServiceAuthorization getServiceAuthorization()
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable FederalAllowableComponent getFederalAllowableComponent()
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable void setFederalAllowableComponent(FederalAllowableComponent federalAllowableComponent)
federalAllowableComponent
- The details of federal allowable component.ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable void setCaseHeader(curam.piwrapper.caseheader.impl.CaseHeader caseHeader)
caseHeader
- The details of the case.ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable curam.util.type.FrequencyPattern getServiceFrequencyPattern()
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable void updateProvider(Provider provider, int versionNo) throws curam.util.exception.InformationalException
provider
- Contains the provider details.versionNo
- The version number of the service delivery.curam.util.exception.InformationalException
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable void updateProviderType(curam.provider.impl.ProviderTypeNameEntry providerType, int versionNo) throws curam.util.exception.InformationalException
providerType
- The type of service provider.versionNo
- The version number of the service delivery.curam.util.exception.InformationalException
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable void setServiceDeliveryEvaluation(ServiceDeliveryEvaluation serviceDeliveryEvaluation)
serviceDeliveryEvaluation
- Contains service delivery evaluation details.ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable ServiceDeliveryEvaluation getServiceDeliveryEvaluation()
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable java.lang.String getCompletionComments()
getCompletionComments
in interface curam.piwrapper.outcomeplan.impl.Reviewable
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable curam.piwrapper.outcomeplan.codetable.impl.ACTIVITYOUTCOMEREASONEntry getOutcomeReason()
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable void setOutcomeReason(curam.piwrapper.outcomeplan.codetable.impl.ACTIVITYOUTCOMEREASONEntry outcomeUnsuccessfulReason)
outcomeUnsuccessfulReason
- The outcome reason for a service delivery.ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable void setCompletionComments(java.lang.String completionComments)
completionComments
- The comments for completing the service delivery.ServiceDelivery |
void checkViewSecurityRights() throws curam.util.exception.InformationalException, curam.util.exception.AppException
curam.util.exception.InformationalException
- Generic Exception Signature.curam.util.exception.AppException
- Generic Exception Signature.@AccessLevel(value=EXTERNAL) @Implementable void setDeliveryTypeRelatedID(java.lang.Long deliveryTypeRelatedID)
deliveryTypeRelatedID
- The key of the related object.ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable java.lang.Long getDeliveryTypeRelatedID()
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable curam.serviceoffering.impl.SODELIVERYTYPEEntry getDeliveryType()
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable curam.util.type.Date getCreationDate()
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable curam.piwrapper.user.impl.User getCreatedBy()
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable curam.util.type.Date getCompletionDate()
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable curam.piwrapper.user.impl.User getCompletedBy()
ServiceDelivery |
@AccessLevel(value=EXTERNAL) @Implementable PaymentInformation getLatestPayment() throws curam.util.exception.AppException, curam.util.exception.InformationalException
curam.util.exception.AppException
curam.util.exception.InformationalException
ServiceDelivery, ServiceAuthorization, ServiceAuthorizationLineItem, ServiceInvoiceLineItem, FinancialInstruction, ProviderRosterLineItem, PaymentInstrument, InstructionLineItem |