@AccessLevel(value=EXTERNAL) public interface ProviderOffering extends ProviderOfferingAccessor, curam.util.persistence.Insertable, curam.util.persistence.helper.Lifecycle<curam.providerservice.impl.ProviderOfferingStatusEntry>, curam.util.persistence.helper.Commented, curam.util.type.DateRanged, curam.util.persistence.OptimisticLockModifiable, curam.waitlist.impl.Resource
Modifier and Type | Interface and Description |
---|---|
static interface |
ProviderOffering.ProviderOfferingApproveEvents
Interface to the provider offering events functionality surrounding the
approve method.
|
static interface |
ProviderOffering.ProviderOfferingCancelEvents
Interface to the provider offering events functionality surrounding the
cancel method.
|
static interface |
ProviderOffering.ProviderOfferingCheckApprovalCriteriaEvents
Interface to the provider offering events functionality surrounding the
checkApprovalCriteria method.
|
static interface |
ProviderOffering.ProviderOfferingDenyEvents
Interface to the provider offering events functionality surrounding the
deny method.
|
static interface |
ProviderOffering.ProviderOfferingGetContractsEvents
Interface to the provider offering events functionality surrounding the
getContracts method.
|
static interface |
ProviderOffering.ProviderOfferingInsertEvents
Interface to the provider offering events functionality surrounding the
insert method.
|
static interface |
ProviderOffering.ProviderOfferingModifyEvents
Interface to the provider offering events functionality surrounding the
modify method.
|
Modifier and Type | Method and Description |
---|---|
void |
approve(int versionNo)
Approves a Provider Offering entity.
|
void |
cancel(int versionNo)
Logically deletes a Provider Offering entity.
|
curam.cpm.facade.struct.InformationalMessageList |
checkApprovalCriteria(curam.cpm.facade.struct.KeyVersionDetails keyVersionDetails)
This method is used to display the warnings to the user about approval
criteria required for provider offering, before he approves a provider
offering.
|
void |
deny(int versionNo,
curam.providerservice.impl.ProviderOfferingDenialReasonEntry denialReason)
Denies approval to a Provider Offering entity.
|
curam.workspaceservices.localization.impl.LocalizableText |
getClientFeeInfo()
Returns the immutable localized text object for the attribute, client fee
information.
|
java.util.Set<ContractVersion> |
getContracts()
Returns the immutable set of contracts for the provider offering.
|
curam.workspaceservices.localization.impl.LocalizableText |
getDocumentsRequiredInfo()
Returns the immutable localized text object for the attribute, documents
required information.
|
curam.workspaceservices.localization.impl.LocalizableText |
getEligibilityInfo()
Gets the immutable localized text object for the attribute, eligibility
information.
|
curam.workspaceservices.localization.impl.LocalizableText |
getIntakeProcedureInfo()
Gets the immutable localized text object for the attribute, intake
procedure information.
|
Provider |
getProvider()
The returned object is intentionally accessor-only.
|
java.util.Set<ProviderOfferingPlaceLimit> |
getProviderOfferingPlaceLimits()
The returned objects are intentionally accessor-only.
|
java.util.Set<curam.providerservice.impl.ProviderOfferingRate> |
getProviderOfferingRates()
The returned objects are intentionally accessor-only.
|
ServiceOffering |
getServiceOffering()
The returned object is intentionally accessor-only.
|
boolean |
isProviderOfferingApproved()
Method to check if provider offering is 'Approved'.
|
boolean |
isProviderOfferingEnded()
Method to check if provider offering has ended.
|
void |
setClientFeeInfoTextID(long value)
Sets the localized text ID of the provider offering attribute client fee
information.
|
void |
setDateRange(curam.util.type.DateRange value)
Sets the date range for the provider offering.
|
void |
setDocumentsRequiredInfoTextID(long value)
Sets the localized text ID of the provider offering attribute documents
required information.
|
void |
setEligibilityInfoTextID(long value)
Sets the localized text ID of the provider offering attribute eligibility
information.
|
void |
setEndReason(curam.providerservice.impl.ProviderOfferingEndReasonEntry value)
Sets the end reason for the provider offering.
|
void |
setIntakeProcedureInfoTextID(long value)
Sets the localized text ID of the provider offering attribute intake
procedure information.
|
void |
setProvider(Provider value)
Sets the provider for the provider offering.
|
void |
setServiceOffering(ServiceOffering value)
Sets the service offering for the provider offering.
|
getClientFeeInfoTextID, getDenialReason, getDocumentsRequiredInfoTextID, getEligibilityInfoTextID, getEndReason, getIntakeProcedureInfoTextID
void setEndReason(curam.providerservice.impl.ProviderOfferingEndReasonEntry value)
value
- The end reason for the provider offering.The
default implementation -
curam.providerservice.impl.ProviderOfferingImpl#setEndReason(
ProviderOfferingEndReasonEntry).
void setDateRange(curam.util.type.DateRange value)
value
- The "lifetime" of the provider offering. This provider
offering cannot be offered to clients outside of the date
range.Provider getProvider()
ProviderOfferingAccessor
The returned object is intentionally accessor-only. Calling code must not attempt to cast the object to its mutator interface, nor use the object's ID to re-retrieve a mutable instance from the database.
getProvider
in interface ProviderOfferingAccessor
void setProvider(Provider value)
value
- Provider for the provider offering.ServiceOffering getServiceOffering()
ProviderOfferingAccessor
The returned object is intentionally accessor-only. Calling code must not attempt to cast the object to its mutator interface, nor use the object's ID to re-retrieve a mutable instance from the database.
getServiceOffering
in interface ProviderOfferingAccessor
void setServiceOffering(ServiceOffering value)
value
- Service offering for the provider offering.java.util.Set<curam.providerservice.impl.ProviderOfferingRate> getProviderOfferingRates()
ProviderOfferingAccessor
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.
getProviderOfferingRates
in interface ProviderOfferingAccessor
java.util.Set<ProviderOfferingPlaceLimit> getProviderOfferingPlaceLimits()
ProviderOfferingAccessor
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.
getProviderOfferingPlaceLimits
in interface ProviderOfferingAccessor
java.util.Set<ContractVersion> getContracts()
ProviderOfferingAccessor
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.
getContracts
in interface ProviderOfferingAccessor
void cancel(int versionNo) throws curam.util.exception.InformationalException
versionNo
- The version number as previously retrieved.curam.util.exception.InformationalException
- Generic Exception Signature.The default
implementation -
curam.providerservice.impl.ProviderOfferingImpl#cancel(int).
void approve(int versionNo) throws curam.util.exception.InformationalException, curam.util.exception.DatabaseException, curam.util.exception.AppRuntimeException, curam.util.exception.AppException
versionNo
- The version number as previously retrieved.curam.util.exception.InformationalException
- Generic Exception Signature.curam.util.exception.AppRuntimeException
- Generic Exception Signature.curam.util.exception.DatabaseException
- Generic Exception Signature.curam.util.exception.AppException
- Generic Exception Signature.The default
implementation -
curam.providerservice.impl.ProviderOfferingImpl#approve(int).
void deny(int versionNo, curam.providerservice.impl.ProviderOfferingDenialReasonEntry denialReason) throws curam.util.exception.InformationalException
versionNo
- The version number as previously retrieved.denialReason
- Reason for the denial.curam.util.exception.InformationalException
- Generic Exception Signature.The default
implementation -
curam.providerservice.impl.ProviderOfferingImpl#deny(int,
ProviderOfferingDenialReasonEntry).
curam.cpm.facade.struct.InformationalMessageList checkApprovalCriteria(curam.cpm.facade.struct.KeyVersionDetails keyVersionDetails) throws curam.util.exception.AppException, curam.util.exception.InformationalException
keyVersionDetails
- Details of the version key.curam.util.exception.AppException
- Generic Exception Signature.curam.util.exception.InformationalException
- Generic Exception Signature.boolean isProviderOfferingApproved()
boolean isProviderOfferingEnded()
curam.workspaceservices.localization.impl.LocalizableText getClientFeeInfo()
ProviderOfferingAccessor
The returned object is intentionally accessor-only. Calling code must not attempt to cast the object to its mutator interface, nor use the object's ID to re-retrieve a mutable instance from the database.
getClientFeeInfo
in interface ProviderOfferingAccessor
curam.workspaceservices.localization.impl.LocalizableText getDocumentsRequiredInfo()
ProviderOfferingAccessor
The returned object is intentionally accessor-only. Calling code must not attempt to cast the object to its mutator interface, nor use the object's ID to re-retrieve a mutable instance from the database.
getDocumentsRequiredInfo
in interface ProviderOfferingAccessor
curam.workspaceservices.localization.impl.LocalizableText getEligibilityInfo()
ProviderOfferingAccessor
The returned object is intentionally accessor-only. Calling code must not attempt to cast the object to its mutator interface, nor use the object's ID to re-retrieve a mutable instance from the database.
getEligibilityInfo
in interface ProviderOfferingAccessor
curam.workspaceservices.localization.impl.LocalizableText getIntakeProcedureInfo()
ProviderOfferingAccessor
The returned object is intentionally accessor-only. Calling code must not attempt to cast the object to its mutator interface, nor use the object's ID to re-retrieve a mutable instance from the database.
getIntakeProcedureInfo
in interface ProviderOfferingAccessor
void setIntakeProcedureInfoTextID(long value)
value
- The localized text ID of the intake procedure information.void setDocumentsRequiredInfoTextID(long value)
value
- The localized text ID of the documents required information.void setClientFeeInfoTextID(long value)
value
- The localized text ID of the client fee information.void setEligibilityInfoTextID(long value)
value
- The localized text ID of the eligibility information.