@AccessLevel(value=EXTERNAL) public interface ServiceOffering extends curam.util.persistence.Insertable, curam.util.persistence.helper.LogicallyDeleteable, curam.util.persistence.helper.Named, curam.util.persistence.helper.Commented, curam.util.type.DateRanged, curam.util.persistence.OptimisticLockModifiable, ServiceOfferingAccessor
Modifier and Type | Interface and Description |
---|---|
static interface |
ServiceOffering.ServiceOfferingAddDescriptionTextTranslationEvents
Interface to the ServiceOffering API events functionality surrounding the
addDescriptionTextTranslation method.
|
static interface |
ServiceOffering.ServiceOfferingAddNameTextTranslationEvents
Interface to the ServiceOffering API events functionality surrounding the
addNameTextTranslation method.
|
static interface |
ServiceOffering.ServiceOfferingCancelEvents
Interface to the service offering events functionality surrounding the
cancel method.
|
static interface |
ServiceOffering.ServiceOfferingGetServiceRatesForPeriodEvents
Interface to the service offering events functionality surrounding the
getServiceRatesForPeriod method.
|
static interface |
ServiceOffering.ServiceOfferingInsertEvents
Interface to the service offering events functionality surrounding the
insert method.
|
static interface |
ServiceOffering.ServiceOfferingModifyDescriptionTextTranslationEvents
Interface to the ServiceOffering API events functionality surrounding the
modifyDescriptionTextTranslation method.
|
static interface |
ServiceOffering.ServiceOfferingModifyEvents
Interface to the service offering events functionality surrounding the
modify method.
|
static interface |
ServiceOffering.ServiceOfferingModifyNameTextTranslationEvents
Interface to the ServiceOffering API events functionality surrounding the
modifyNameTextTranslation method.
|
Modifier and Type | Method and Description |
---|---|
void |
addDescriptionTextTranslation(boolean isLocalizationExist)
Creates a text translation for the service offering attribute, description.
|
void |
addNameTextTranslation(boolean isLocalizationExist)
Creates a text translation for the service offering attribute, name.
|
java.util.Set<curam.serviceoffering.impl.ServiceOfferingApprovalCriterion> |
getApprovalCriteria()
Gets the immutable approval criteria for service offering.
|
curam.workspaceservices.localization.impl.LocalizableText |
getDescriptionText()
Gets the immutable localized text object for the attribute, description
|
curam.workspaceservices.localization.impl.LocalizableText |
getNameText()
Gets the immutable localized text object for the attribute, name.
|
java.util.Set<curam.serviceoffering.impl.SOEvaluationCriterion> |
getServiceEvaluationCriteria()
Gets the immutable set of evaluation criteria for the service offering.
|
java.util.Set<ServiceGroup> |
getServiceGroups()
Gets the immutable service groups for service offerings.
|
java.util.Set<curam.serviceoffering.impl.ServiceRate> |
getServiceRates()
Gets the immutable service rates for service offering.
|
java.util.Set<curam.serviceoffering.impl.ServiceRate> |
getServiceRatesForPeriod(curam.util.type.DateRange dateRange)
Gets the immutable service rates for the period
The returned objects are intentionally accessor-only.
|
java.util.Set<curam.serviceoffering.impl.SOTrainingRequirement> |
getTrainingRequirements()
Gets the immutable Training Requirements for a Service Offering.
|
void |
modifyDescriptionTextTranslation(boolean isLocalizationExist)
Modifies the text translation details for the service offering attribute,
description.
|
void |
modifyNameTextTranslation(boolean isLocalizationExist)
Modifies the text translation details for the service offering attribute,
name.
|
ServiceOffering |
retrieveServiceOfferingByReference(java.lang.String reference)
Reads the details of a service for a specified reference.
|
void |
setAvailabilityCheckExcludeInd(boolean availabilityCheckExcludeInd)
Sets the availability check indicator on the service offering, which
indicates if
the service period should be included when checking a clients availability.
|
void |
setDateRange(curam.util.type.DateRange value)
Sets the date range of service offering.
|
void |
setDeliveryFrequency(java.lang.String frequencyPattern)
Sets the frequency at which the service offering can be delivered to the
client.
|
void |
setDeliveryType(curam.serviceoffering.impl.SODELIVERYTYPEEntry deliveryType)
Sets the delivery type code for the service offering, i.e.
|
void |
setDescription(java.lang.String value)
Deprecated.
Since Curam 6.0, replaced with
(String)
.In order to handle the exception it has
been reintroduced with setLocalizedDescription method which supports
localization and throws AppException and Informational
Exception. See release note: CR00180149. |
void |
setDescriptionTextID(long value)
Sets the localizable text ID for the service offering description.
|
void |
setLocale(java.lang.String locale)
Sets the locale for the localizable fields of service offering.
|
void |
setLocalizedDescription(java.lang.String value)
Sets the localizable description of the service offering.
|
void |
setLocalizedName(java.lang.String value)
Sets the localizable name of the service offering.
|
void |
setLocalizedText(java.lang.String text)
Sets the localizable text of the service offering.
|
void |
setMaximumUnits(long value)
Sets the maximum units.
|
void |
setNameTextID(long value)
Sets the localizable text ID for the service offering name.
|
void |
setPayBasedOnAttendanceInd(boolean payBasedOnAttendanceInd)
Sets pay based on attendance indicator.
|
void |
setPlacementPaymentInd(boolean value)
Sets the placement payment indicator.
|
void |
setProvisionMethod(curam.codetable.impl.PROVISIONMETHODEntry provisionMethod)
Sets the provision method to identify whether the service
offering delivery is monitored and paid for by the agency or
is just a referral.
|
void |
setReference(java.lang.String value)
Sets the reference for the service offering.
|
void |
setReferredBy(curam.codetable.impl.REFERRALREFERREDBYEntry referredBy)
Sets the referred by attribute which is used to identify the who referred
the referral.
|
void |
setSAPlmtInhibitInd(boolean value)
Sets the inhibit service authorization via placement indicator.
|
void |
setSingleOrMultipleClients(curam.codetable.impl.SOSINGLEORMULTIPLECLIENTSEntry singleOrMultipleClients)
Sets the multiple clients code.
|
void |
setSpecialConditionType(curam.codetable.impl.SPECIALCONDITIONTYPEEntry specialConditionType)
Sets special condition type.
|
void |
setTrainingInd(boolean value)
Sets the training indicator.
|
void |
setUnitFrequency(curam.serviceoffering.impl.UnitFrequencyEntry value)
Sets the unit frequency.
|
void |
setUnitOfMeasure(curam.serviceoffering.impl.UnitOfMeasureEntry value)
Sets the unit of measure.
|
getAvailabilityCheckExcludeInd, getCreoleRuleSetConfiguration, getDeliveryFrequency, getDeliveryType, getDescription, getDescriptionTextID, getLocale, getLocalizedText, getMaximumUnits, getNameTextID, getPlacementPaymentInd, getProvisionMethod, getReference, getReferredBy, getSAPlmtInhibitInd, getServiceDeliveryConfiguration, getSingleOrMultipleClients, getSpecialConditionType, getTrainingInd, getUnitFrequency, getUnitOfMeasure, isPayBasedOnAttendance
getActivityName, getOutcomePlanActivityType
java.util.Set<ServiceGroup> getServiceGroups()
ServiceOfferingAccessor
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.
getServiceGroups
in interface ServiceOfferingAccessor
java.util.Set<curam.serviceoffering.impl.ServiceRate> getServiceRates()
ServiceOfferingAccessor
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.
getServiceRates
in interface ServiceOfferingAccessor
java.util.Set<curam.serviceoffering.impl.SOEvaluationCriterion> getServiceEvaluationCriteria()
ServiceOfferingAccessor
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.
getServiceEvaluationCriteria
in interface ServiceOfferingAccessor
void setDateRange(curam.util.type.DateRange value)
value
- The "lifetime" of the service offering. This service cannot be
offered to clients outside of the date range.The default implementation-
curam.serviceoffering.impl.ServiceOfferingImpl#setDateRange(DateRange).
@Deprecated void setDescription(java.lang.String value)
(String)
.In order to handle the exception it has
been reintroduced with setLocalizedDescription method which supports
localization and throws AppException and Informational
Exception. See release note: CR00180149.value
- The description of the service offering.The default implementation-
curam.serviceoffering.impl.ServiceOfferingImpl#setDescription(String).
void setMaximumUnits(long value)
value
- The maximum number of units that can be delivered to a client
receiving the service. The Unit Frequency attribute determines the
period (e.g. Daily, Weekly etc.) over which the Maximum Units
value is applied.The default implementation-
curam.serviceoffering.impl.ServiceOfferingImpl#setMaximumUnits(long).
void setUnitFrequency(curam.serviceoffering.impl.UnitFrequencyEntry value)
value
- The frequency at which the maximum number of units can be
delivered to each client.void setPlacementPaymentInd(boolean value)
value
- The indicator used to identify whether or not payment can be made
for the service offering only through the generation of payments
based on placement data.void setUnitOfMeasure(curam.serviceoffering.impl.UnitOfMeasureEntry value)
value
- The unit of measure for the service offering. This could be for
example a Place (bed) in a foster home, a Session with a
physiotherapist or a Dose of medicine.java.util.Set<curam.serviceoffering.impl.ServiceOfferingApprovalCriterion> getApprovalCriteria()
ServiceOfferingAccessor
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.
getApprovalCriteria
in interface ServiceOfferingAccessor
java.util.Set<curam.serviceoffering.impl.ServiceRate> getServiceRatesForPeriod(curam.util.type.DateRange dateRange)
ServiceOfferingAccessor
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.
getServiceRatesForPeriod
in interface ServiceOfferingAccessor
dateRange
- The date range with in which the rate effective are required.java.util.Set<curam.serviceoffering.impl.SOTrainingRequirement> getTrainingRequirements()
ServiceOfferingAccessor
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.
getTrainingRequirements
in interface ServiceOfferingAccessor
void setTrainingInd(boolean value)
value
- Indicator for the training type service.void setSAPlmtInhibitInd(boolean value)
value
- The indicator is to identify whether creation of service
authorization will be inhibited for placement services.void setPayBasedOnAttendanceInd(boolean payBasedOnAttendanceInd)
payBasedOnAttendanceInd
- An indicator used to identify whether or not payment calculations
will be based on attendance information for the service offering.void setSpecialConditionType(curam.codetable.impl.SPECIALCONDITIONTYPEEntry specialConditionType)
specialConditionType
- Indicates Special Condition Type of a Service Offering such as
restrictive, non-restrictive etc.This is to differentiate between
lock-down/secure/restrictive facilities (e.g. jail, prison, etc.)
that a client might be placed in, versus a non-restrictive setting
(e.g. foster home, group home, residential center, etc.). Clients
in receipt of restrictive service offerings could undergo
different processing, e.g. they would require a different
placement (admission) process.void setReferredBy(curam.codetable.impl.REFERRALREFERREDBYEntry referredBy)
referredBy.
- The value of the referral referred by such as MDT member, Any User or User
Creating.void setProvisionMethod(curam.codetable.impl.PROVISIONMETHODEntry provisionMethod)
provisionMethod
- The provision method is to identify whether the service offering delivery
is
monitored and paid for by the agency or is just a referral.void setDeliveryFrequency(java.lang.String frequencyPattern)
frequencyPattern
- Delivery frequency of the service offering.void setSingleOrMultipleClients(curam.codetable.impl.SOSINGLEORMULTIPLECLIENTSEntry singleOrMultipleClients)
singleOrMultipleClients
- The single or multiple client is to identify whether service offering is
applicable
to multiple clients to enable multiple clients to be selected for a
service delivery.curam.workspaceservices.localization.impl.LocalizableText getDescriptionText()
getDescriptionText
in interface ServiceOfferingAccessor
curam.workspaceservices.localization.impl.LocalizableText getNameText()
getNameText
in interface ServiceOfferingAccessor
void setReference(java.lang.String value)
value
- A unique identifier for the service offering which allows it to be
referenced by, for example, a rule set.void setDescriptionTextID(long value)
value
- The localizable text ID.void setNameTextID(long value)
value
- The localizable text ID.@AccessLevel(value=EXTERNAL) ServiceOffering retrieveServiceOfferingByReference(java.lang.String reference) throws curam.util.exception.InformationalException, curam.util.exception.AppException
reference
- The reference of the service.curam.util.exception.InformationalException
curam.util.exception.AppException
Service |
void setLocalizedName(java.lang.String value) throws curam.util.exception.AppException, curam.util.exception.InformationalException
value
- The name of the service offering.curam.util.exception.AppException
- Generic Exception Signature.curam.util.exception.InformationalException
- Generic Exception Signature.The default implementation -
ServiceOfferingImpl#setLocalizedName(String).
void setLocalizedDescription(java.lang.String value) throws curam.util.exception.AppException, curam.util.exception.InformationalException
value
- The description of the service offering.curam.util.exception.AppException
- Generic Exception Signature.curam.util.exception.InformationalException
- Generic Exception Signature.The default
implementation - ServiceOfferingImpl#setLocalizedDescription(String).
void addNameTextTranslation(boolean isLocalizationExist) throws curam.util.exception.AppException, curam.util.exception.InformationalException
isLocalizationExist
- Indicator to decide if localization exists for text.curam.util.exception.AppException
- Generic Exception Signature.curam.util.exception.InformationalException
- Generic Exception Signature.void setLocale(java.lang.String locale)
locale
- The locale for which service offering name will be entered.void setLocalizedText(java.lang.String text)
text
- The localizable text.void addDescriptionTextTranslation(boolean isLocalizationExist) throws curam.util.exception.AppException, curam.util.exception.InformationalException
isLocalizationExist
- Indicator to decide if localization exists for text.curam.util.exception.AppException
- Generic Exception Signature.curam.util.exception.InformationalException
- Generic Exception Signature.void modifyNameTextTranslation(boolean isLocalizationExist) throws curam.util.exception.AppException, curam.util.exception.InformationalException
isLocalizationExist
- Indicator to decide if localization exists for text.curam.util.exception.AppException
- Generic Exception Signature.curam.util.exception.InformationalException
- Generic Exception Signature.void modifyDescriptionTextTranslation(boolean isLocalizationExist) throws curam.util.exception.AppException, curam.util.exception.InformationalException
isLocalizationExist
- Indicator to decide if localization exists for text.curam.util.exception.AppException
- Generic Exception Signature.curam.util.exception.InformationalException
- Generic Exception Signature.void setDeliveryType(curam.serviceoffering.impl.SODELIVERYTYPEEntry deliveryType)
deliveryType
- code representing the delivery type of the service offeringvoid setAvailabilityCheckExcludeInd(boolean availabilityCheckExcludeInd)
availabilityCheckInd
- true, if the service offering should be included in the availability
checks, false if not.