@AccessLevel(value=EXTERNAL) public interface ServiceAuthorization extends ServiceAuthorizationAccessor, curam.util.persistence.Insertable, curam.util.persistence.helper.LogicallyDeleteable, curam.util.persistence.OptimisticLockModifiable
Modifier and Type | Interface and Description |
---|---|
static interface |
ServiceAuthorization.ServiceAuthorizationAddLineItemEvents
Interface to the service authorization events functionality surrounding the
addLineItem method.
|
static interface |
ServiceAuthorization.ServiceAuthorizationAddSALIToSAUsingFrequencyAndAnchorDateEvents
Interface to the service authorization events functionality surrounding the
addSALIToSAUsingFrequencyAndAnchorDate method.
|
static interface |
ServiceAuthorization.ServiceAuthorizationAddSALIToSAUsingFrequencyEvents
Interface to the service authorization events functionality surrounding the
addSALIToSAUsingFrequency method.
|
static interface |
ServiceAuthorization.ServiceAuthorizationAddVoucherToServiceAuthorizationEvents
Interface to the service authorization events functionality surrounding the
addVoucherToServiceAuthorization method.
|
static interface |
ServiceAuthorization.ServiceAuthorizationCancelEvents
Interface to the service authorization events functionality surrounding the
cancel method.
|
static interface |
ServiceAuthorization.ServiceAuthorizationCreateServiceAuthorizationEvents
Interface to the service authorization events functionality surrounding the
createServiceAuthorization method.
|
static interface |
ServiceAuthorization.ServiceAuthorizationDeleteVoucherForServiceAuthorizationEvents
Interface to the service authorization events functionality surrounding the
deleteVoucherForServiceAuthorization method.
|
static interface |
ServiceAuthorization.ServiceAuthorizationFindLineItemByServiceProvisionDetailsEvents
Interface to the service authorization events functionality surrounding the
findLineItemByServiceProvisionDetails method.
|
static interface |
ServiceAuthorization.ServiceAuthorizationGetDerivedStatusEvents
Interface to the service authorization events functionality surrounding the
get derived status method.
|
static interface |
ServiceAuthorization.ServiceAuthorizationInsertEvents
Interface to the service authorization events functionality surrounding the
insert method.
|
static interface |
ServiceAuthorization.ServiceAuthorizationInsertServiceAuthorizationEvents
Interface to the service authorization events functionality surrounding the
insertServiceAuthorization method.
|
static interface |
ServiceAuthorization.ServiceAuthorizationMatchServiceAuthorizationEvents
Interface to the service authorization events functionality surrounding the
matchServiceAuthorization method.
|
static interface |
ServiceAuthorization.ServiceAuthorizationModifyEvents
Interface to the service authorization events functionality surrounding the
modify method.
|
static interface |
ServiceAuthorization.ServiceAuthorizatnAddLineItemEvents
Interface to the service authorization events functionality surrounding the
addLineItem method.
|
Modifier and Type | Method and Description |
---|---|
void |
addLineItem(curam.util.type.Money unitAmount,
long numberOfUnitsAuthorized,
long maximumUnits,
curam.util.type.DateRange authorizedPeriod,
curam.serviceoffering.impl.UnitFrequencyEntry unitFrequency,
Provider provider,
ServiceOffering serviceOffering,
boolean isStipulatedUnitAmount)
Adds the specified line item to this Service Authorization.
|
void |
addLineItem(curam.util.type.Money unitAmount,
long numberOfUnitsAuthorized,
long maximumUnits,
curam.util.type.DateRange authorizedPeriod,
curam.serviceoffering.impl.UnitFrequencyEntry unitFrequency,
Provider provider,
ServiceOffering serviceOffering,
boolean isStipulatedUnitAmount,
long nomineeID)
Adds the specified line item to this Service Authorization.
|
void |
addSALIToSAUsingFrequency(ServiceAuthorization serviceAuthorization,
curam.util.type.FrequencyPattern saliGenerationFrequency,
curam.cpm.sl.entity.struct.ServiceAuthorizationLineItemDtls authorizationLineItemDtls)
Deprecated.
Since Curam 6.0 SP2, replaced with
addSALIToSAUsingFrequencyAndAnchorDate(ServiceAuthorization,FrequencyPattern,ServiceAuthorizationLineItemDtls, Date )
.As part of frequency pattern enhancement to find frequency
occurrences using anchor date, method
addSALIToSAUsingFrequencyAndAnchorDate with anchor date as
parameter is introduced in ServiceAuthorization class . See
release note: CR00273612. |
void |
addSALIToSAUsingFrequencyAndAnchorDate(ServiceAuthorization serviceAuthorization,
curam.util.type.FrequencyPattern saliGenerationFrequency,
curam.cpm.sl.entity.struct.ServiceAuthorizationLineItemDtls authorizationLineItemDtls,
curam.util.type.Date anchorDate)
Generates and adds service authorization line items to a service
authorization based on the frequency pattern and date.
|
void |
addVoucherToServiceAuthorization(java.lang.String serviceAuthorizationReferenceNumber,
java.lang.String voucherNumber)
Adds voucher details to a service authorization.
|
void |
cancel()
Cancels a service authorization.
|
ServiceAuthorization |
createServiceAuthorization(java.util.Set<curam.piwrapper.casemanager.impl.CaseParticipantRole> caseParticipantRoleList)
Creates a service authorization for case participants.
|
void |
createsServiceAuthorizationLineItems(ServiceAuthorization serviceAuthorization,
curam.util.type.FrequencyPattern saliGenerationFrequency,
curam.cpm.sl.entity.struct.ServiceAuthorizationLineItemDtls authorizationLineItemDtls,
curam.util.type.Date anchorDate)
Creates a service authorization and the corresponding service authorization
line item based on the service authorization frequency pattern and anchor
date.
|
curam.cpm.facade.struct.InformationalMessageList |
deleteVoucherForServiceAuthorization(java.lang.String serviceAuthorizationReferenceNumber,
java.lang.String voucherNumber)
Cancels the voucher associated with service authorization.
|
java.util.Set<ServiceAuthorizationLineItem> |
findLineItemByServiceProvisionDetails(java.lang.Long serviceID,
curam.util.type.Date serviceDateFrom,
curam.util.type.Date serviceDateTo)
This method is used to find the service authorization line item by service
provision details like serviceID, serviceDateFrom, serviceDateTo
The returned objects are intentionally accessor-only.
|
java.util.Set<curam.piwrapper.casemanager.impl.CaseParticipantRole> |
getCaseparticipantRoles()
Gets the list of case participant roles for which the service authorization
is created.
|
curam.participant.impl.ConcernRole |
getClient()
Gets the client details(i.e concern role details)of the service
authorization.
|
java.util.Set<curam.participant.impl.ConcernRole> |
getConcernRoles()
Gets the list of concern roles for whom the service authorization is
created.
|
void |
insertServiceAuthorization()
Create the service authorization
|
ServiceAuthorization |
matchServiceAuthorization(java.lang.String serviceAuthorizationRefNo)
Matches the service authorization by reference number.
|
void |
setCaseParticipantRoleID(long value)
Sets the the case participant role ID of the service authorization.
|
void |
setCaseParticipantRoles(java.util.Set<curam.piwrapper.casemanager.impl.CaseParticipantRole> caseParticipantRoleList)
Sets the the list of case participant roles for which the service
authorization is created.
|
void |
setRecordStatus(curam.codetable.impl.RECORDSTATUSEntry values)
Set the record status of the service authorization
|
getCase, getCaseID, getCaseParticipantRoleID, getCaseReferenceNumber, getConcernRoleID, getCreationDate, getDerivedStatus, getRecordStatus, getReferenceNumber
@AccessLevel(value=EXTERNAL) curam.participant.impl.ConcernRole getClient()
getClient
in interface ServiceAuthorizationAccessor
ServiceAuthorization, ConcernRole |
void setCaseParticipantRoleID(long value) throws curam.util.exception.AppException, curam.util.exception.InformationalException
value
- the caseparticipantRoleID of the service authorization.curam.util.exception.InformationalException
curam.util.exception.AppException
The default implementation -
curam.serviceauthorization.impl.ServiceAuthorizationImpl#
setCaseParticipantRoleID(long)
@AccessLevel(value=EXTERNAL) java.util.Set<curam.piwrapper.casemanager.impl.CaseParticipantRole> getCaseparticipantRoles()
getCaseparticipantRoles
in interface ServiceAuthorizationAccessor
ServiceAuthorization, CaseParticipantRole |
@AccessLevel(value=EXTERNAL) java.util.Set<curam.participant.impl.ConcernRole> getConcernRoles()
getConcernRoles
in interface ServiceAuthorizationAccessor
ServiceAuthorization, ConcernRole |
@AccessLevel(value=EXTERNAL) ServiceAuthorization createServiceAuthorization(java.util.Set<curam.piwrapper.casemanager.impl.CaseParticipantRole> caseParticipantRoleList) throws curam.util.exception.AppException, curam.util.exception.InformationalException
caseParticipantRoleList
- The list of keys of the case participant.curam.util.exception.AppException
curam.util.exception.InformationalException
ServiceAuthorization |
void setCaseParticipantRoles(java.util.Set<curam.piwrapper.casemanager.impl.CaseParticipantRole> caseParticipantRoleList) throws curam.util.exception.AppException, curam.util.exception.InformationalException
caseParticipantRoleList
- Case participant role list.curam.util.exception.AppException
- Generic Exception Signature.curam.util.exception.InformationalException
- Generic Exception Signature.The default implementation -
curam.serviceauthorization.impl.ServiceAuthorizationImpl#
setCaseParticipantRoles(Set)
java.util.Set<ServiceAuthorizationLineItem> findLineItemByServiceProvisionDetails(java.lang.Long serviceID, curam.util.type.Date serviceDateFrom, curam.util.type.Date serviceDateTo)
ServiceAuthorizationAccessor
The returned objects are intentionally accessor-only. Calling code must not attempt to cast any of these objects to its mutator interface, nor use the object's ID to re-retrieve a mutable instance from the database.
findLineItemByServiceProvisionDetails
in interface ServiceAuthorizationAccessor
serviceID
- service idserviceDateFrom
- the start date of the period during which the service was
deliveredserviceDateTo
- the end date of the period during which the service was deliveredvoid addLineItem(curam.util.type.Money unitAmount, long numberOfUnitsAuthorized, long maximumUnits, curam.util.type.DateRange authorizedPeriod, curam.serviceoffering.impl.UnitFrequencyEntry unitFrequency, Provider provider, ServiceOffering serviceOffering, boolean isStipulatedUnitAmount, long nomineeID) throws curam.serviceauthorization.impl.DuplicateLineItemException, curam.serviceauthorization.impl.InvalidServiceSpecificationException, curam.serviceauthorization.impl.InvalidProviderSpecificationException, curam.util.exception.InformationalException, curam.util.exception.AppException
unitAmount
- unit Amount which might be the budgeted or stipulated unit costnumberOfUnitsAuthorized
- the number of units that is authorized.maximumUnits
- maximum Units Frequency attribute to define the number of units
that a client is authorized to receive during a specific periodauthorizedPeriod
- the period during which the service can be providedunitFrequency
- Maximum Units Frequency attribute to define the number of units
that a client is authorized to receive during a specific periodprovider
- the provider who is authorized to provide the service. It is not
mandatory to specify a providerserviceOffering
- the service offering that is being authorized.isStipulatedUnitAmount
- the unit cost specified is taken as stipulated cost if
unitCostFixedIndicator is true and as budgeted otherwisenomineeID
- The unique identifier of the nominee who will receive the provider
paymentcuram.util.exception.InformationalException
- Generic Exception Signature.InvalidProviderSpecificationException
- Generic Exception Signature.DuplicateLineItemException
- Generic Exception Signature.curam.util.exception.AppException
- Generic Exception Signature.InvalidServiceSpecificationException
- Generic Exception Signature.The default implementation -
curam.serviceauthorization.impl.ServiceAuthorizationImpl#addLineItem(Money
,
long , long , DateRange , UnitFrequencyEntry , Provider ,
ServiceOffering , boolean , long)
void addLineItem(curam.util.type.Money unitAmount, long numberOfUnitsAuthorized, long maximumUnits, curam.util.type.DateRange authorizedPeriod, curam.serviceoffering.impl.UnitFrequencyEntry unitFrequency, Provider provider, ServiceOffering serviceOffering, boolean isStipulatedUnitAmount) throws curam.serviceauthorization.impl.DuplicateLineItemException, curam.serviceauthorization.impl.InvalidServiceSpecificationException, curam.serviceauthorization.impl.InvalidProviderSpecificationException, curam.util.exception.InformationalException, curam.util.exception.AppException
unitAmount
- unit Amount which might be the budgeted or stipulated unit costnumberOfUnitsAuthorized
- the number of units that is authorized.maximumUnits
- maximum Units Frequency attribute to define the number of units
that a client is authorized to receive during a specific periodauthorizedPeriod
- the period during which the service can be providedunitFrequency
- Maximum Units Frequency attribute to define the number of units
that a client is authorized to receive during a specific periodprovider
- the provider who is authorized to provide the service. It is not
mandatory to specify a providerserviceOffering
- the service offering that is being authorized.isStipulatedUnitAmount
- the unit cost specified is taken as stipulated cost if
unitCostFixedIndicator is true and as budgeted otherwisecuram.util.exception.InformationalException
- Generic Exception Signature.InvalidProviderSpecificationException
- Generic Exception Signature.DuplicateLineItemException
- Generic Exception Signature.curam.util.exception.AppException
- Generic Exception Signature.InvalidServiceSpecificationException
- Generic Exception Signature.The default implementation -
curam.serviceauthorization.impl.ServiceAuthorizationImpl#addLineItem(Money
,
long , long , DateRange , UnitFrequencyEntry , Provider ,
ServiceOffering , boolean )
@AccessLevel(value=EXTERNAL) void cancel() throws curam.util.exception.InformationalException
curam.util.exception.InformationalException
ServiceAuthorization |
void setRecordStatus(curam.codetable.impl.RECORDSTATUSEntry values)
values
- the record status of the service authorization.The default implementation -
curam.serviceauthorization.impl.ServiceAuthorizationImpl#setRecordStatus(
RECORDSTATUSEntry)
void insertServiceAuthorization() throws curam.util.exception.AppException, curam.util.exception.InformationalException
curam.util.exception.AppException
curam.util.exception.InformationalException
The default implementation -
curam.serviceauthorization.impl.ServiceAuthorizationImpl#
insertServiceAuthorization()
@AccessLevel(value=EXTERNAL) void addVoucherToServiceAuthorization(java.lang.String serviceAuthorizationReferenceNumber, java.lang.String voucherNumber) throws curam.util.exception.InformationalException
serviceAuthorizationReferenceNumber
- The service authorization reference number.voucherNumber
- The voucher reference number.curam.util.exception.InformationalException
ServiceAuthorizationVoucher |
@AccessLevel(value=EXTERNAL) curam.cpm.facade.struct.InformationalMessageList deleteVoucherForServiceAuthorization(java.lang.String serviceAuthorizationReferenceNumber, java.lang.String voucherNumber) throws curam.util.exception.InformationalException
serviceAuthorizationReferenceNumber
- The service authorization reference number.voucherNumber
- The voucher number.curam.util.exception.InformationalException
ServiceAuthorizationVoucher |
ServiceAuthorization matchServiceAuthorization(java.lang.String serviceAuthorizationRefNo)
serviceAuthorizationRefNo
- Service Authorization reference number that authorizes payment for
a service delivered to a client.The default implementation -
curam.serviceauthorization.impl.ServiceAuthorizationImpl#
matchServiceAuthorization(String)
@Deprecated void addSALIToSAUsingFrequency(ServiceAuthorization serviceAuthorization, curam.util.type.FrequencyPattern saliGenerationFrequency, curam.cpm.sl.entity.struct.ServiceAuthorizationLineItemDtls authorizationLineItemDtls) throws curam.util.exception.AppException, curam.util.exception.InformationalException
addSALIToSAUsingFrequencyAndAnchorDate(ServiceAuthorization,FrequencyPattern,ServiceAuthorizationLineItemDtls, Date )
.As part of frequency pattern enhancement to find frequency
occurrences using anchor date, method
addSALIToSAUsingFrequencyAndAnchorDate with anchor date as
parameter is introduced in ServiceAuthorization class . See
release note: CR00273612.serviceAuthorization
- Service authorization for which the line items should be added.saliGenerationFrequency
- Frequency on which the service authorization should be generated.authorizationLineItemDtls
- Service authorization line item details.curam.util.exception.AppException
- Generic Exception Signature.curam.util.exception.InformationalException
- Generic Exception Signature.The default
implementation -
curam.serviceauthorization.impl.ServiceAuthorizationImpl
#addSALIToSAUsingFrequency(ServiceAuthorization, FrequencyPattern,
ServiceAuthorizationLineItemDtls)
@AccessLevel(value=EXTERNAL) void addSALIToSAUsingFrequencyAndAnchorDate(ServiceAuthorization serviceAuthorization, curam.util.type.FrequencyPattern saliGenerationFrequency, curam.cpm.sl.entity.struct.ServiceAuthorizationLineItemDtls authorizationLineItemDtls, curam.util.type.Date anchorDate) throws curam.util.exception.AppException, curam.util.exception.InformationalException
serviceAuthorization
- Contains the details of Service authorization.saliGenerationFrequency
- The frequency on which the service authorization line item should
be generated.authorizationLineItemDtls
- Contains the details of service authorization line item.anchorDate
- The start date from which the service authorization line item
occurrences should be generated. )curam.util.exception.AppException
curam.util.exception.InformationalException
ServiceAuthorizationLineItem |
void createsServiceAuthorizationLineItems(ServiceAuthorization serviceAuthorization, curam.util.type.FrequencyPattern saliGenerationFrequency, curam.cpm.sl.entity.struct.ServiceAuthorizationLineItemDtls authorizationLineItemDtls, curam.util.type.Date anchorDate) throws curam.util.exception.AppException, curam.util.exception.InformationalException
serviceAuthorization
- Service authorization for which the line items should be added.saliGenerationFrequency
- Frequency on which the service authorization should be generated.authorizationLineItemDtls
- Service authorization line item details.anchorDate
- Anchor date on which the service authorization should be
generated.curam.util.exception.AppException
- Generic Exception Signature.curam.util.exception.InformationalException
- SERVICEAUTHORIZATION.ERR_SERVICERAUTHORIZATION_FV_FREQUENCY_MUST_BE_ENTERED
If frequency is not entered.
SERVICEAUTHORIZATION.ERR_SERVICERAUTHORIZATION_FV_TO_DATE_MUST_BE_ENTERED
If to date is not entered.
SERVICEAUTHORIZATION.ERR_SERVICERAUTHORIZATION_XRV_SA_MUST_ACTIVE
If service authorization status is not active.
SERVICEAUTHORIZATION.ERR_SERVICERAUTHORIZATION_XRV_NO_SALI_CAN_BE_GENRATED_BETWEEN_DATES
If no service authorization line item could be generated between
the dates.