@AccessLevel(value=EXTERNAL) public interface Provider extends ProviderOrganization, curam.util.persistence.Insertable, curam.util.persistence.OptimisticLockModifiable, curam.util.persistence.helper.Lifecycle<curam.provider.impl.ProviderStatusEntry>, curam.util.type.DateTimeRanged, curam.waitlist.impl.Resource, ProviderAccessor
Modifier and Type | Interface and Description |
---|---|
static interface |
Provider.ProviderApproveEvents
Interface to the provider events functionality surrounding the approve
method.
|
static interface |
Provider.ProviderCloseEvents
Interface to the provider events functionality surrounding the close
method.
|
static interface |
Provider.ProviderEnrollEvents
Interface to the provider events functionality surrounding the enroll
method.
|
static interface |
Provider.ProviderGetAvailablePlacesInDateRangeEvents
Interface to the provider events functionality surrounding the get
available places in date range method.
|
static interface |
Provider.ProviderGetCommonApprovedProviderServiceOfferingsEvents
Interface to the provider events functionality surrounding the get common
approved provider service offerings.
|
static interface |
Provider.ProviderGetServiceOfferingsEvents
Interface to the provider events functionality surrounding the get service
offerings method.
|
static interface |
Provider.ProviderInsertEvents
Interface to the provider events functionality surrounding the insert
method.
|
static interface |
Provider.ProviderModifyEvents
Interface to the provider events functionality surrounding the modify
method.
|
static interface |
Provider.ProviderRejectEvents
Interface to the provider events functionality surrounding the reject
method.
|
static interface |
Provider.ProviderReopenEvents
Interface to the provider events functionality surrounding the reopen
method.
|
static interface |
Provider.ProviderSuspendEvents
Interface to the provider events functionality surrounding the suspend
method.
|
ProviderOrganization.ProviderOrganizationAddProviderMemberEvents
Modifier and Type | Method and Description |
---|---|
void |
approve(int versionNo)
Approves the provider for providing the services to an organization's
clients.
|
void |
approveWithSecurityCheck(int versionNo)
Approves the Provider for providing the services to an organization's
clients on the organization behalf, if the User has the rights to do so.
|
void |
close(int versionNo)
Ceases the provider business with the agency and raises a workflow
event.
|
void |
enroll(curam.core.struct.ConcernRoleDtls concernRoleDtls,
curam.core.struct.AddressDetails addressDetails,
curam.core.struct.ConcernRolePhoneDetails concernRolePhoneDetails,
curam.core.struct.BankAccountDetails bankAccountDetails)
Enrolls the provider in the organization and also, if required, to register
the provider as one or more person(s).
|
boolean |
getAcceptsCWReferral()
Gets the indicator that determines whether a provider will
accept a referral generated by CitizenWorkspace.
|
java.util.Set<curam.provider.impl.ProviderAccreditation> |
getAccreditations()
Gets the immutable set of accreditations for the provider.
|
curam.workspaceservices.localization.impl.LocalizableText |
getAreasServedInfo()
Gets the immutable localized text object for the attribute areas served
information.
|
java.util.Set<Place> |
getAvailablePlacesInDateRange(curam.util.type.DateRange dateRange)
Deprecated.
Since 6.0 SP1, replaced by
getAvailablePlacesInDateTimeRange(DateTimeRange) as part
of fixing making
a place that is just made available to be displayed in the search list of
available places. See release note : CR00260960. |
java.util.Set<Place> |
getAvailablePlacesInDateTimeRange(curam.util.type.DateTimeRange dateTimeRange)
Gets the immutable set of available places for a provider in the given date
time range.
|
curam.workspaceservices.localization.impl.LocalizableText |
getClientInfo()
Gets the immutable localized text object for the attribute, client
information.
|
java.util.Set<Compartment> |
getCompartments()
Gets the immutable set of compartments for the provider.
|
java.util.Set<curam.homestudy.impl.HomeStudy> |
getHomeStudies()
Gets the immutable set of home studies for provider.
|
curam.provider.impl.ProviderCategoryPeriod |
getPrimaryProviderCategoryPeriod()
Gets the immutable primary category periods for the provider.
|
java.util.Set<curam.provider.impl.ProviderBackgroundCheck> |
getProviderBackgroundChecks()
Gets the immutable set of BackgroundChecks for the provider.
|
java.util.Set<curam.provider.impl.ProviderCategoryPeriod> |
getProviderCategoryPeriods()
Gets the immutable set of provider category periods associated to the
provider.
|
curam.provider.impl.ProviderEnquiry |
getProviderEnquiry()
Gets the immutable Provider Enquiry if the Provider is enrolled from an
enquiry otherwise it returns a null.
|
java.util.Set<ProviderOffering> |
getProviderOfferings()
Gets the immutable set of provider offerings for the provider.
|
java.util.Set<curam.provider.impl.ProviderServiceCenter> |
getProviderServiceCenters()
Gets the immutable set of service centers for the provider.
|
java.util.Set<curam.provider.impl.ProviderSpecialty> |
getProviderSpecialties()
Gets the immutable set of provider specialties for the provider.
|
java.util.Set<ServiceInvoiceLineItem> |
getServiceInvoiceLineItems()
Gets the immutable set of service invoice line items for the provider.
|
java.util.Set<ServiceOffering> |
getServiceOfferings()
Gets the immutable set of service offerings for the provider.
|
curam.cpm.sl.entity.struct.ProviderInvestigationDetailsList |
listInvestigationsForProvider(curam.cpm.sl.entity.struct.ProviderConcernRoleKey providerConcernRoleKey)
Lists all the investigations the provider is part of and displays multiple
roles against each case if exists.
|
java.util.List<curam.cpm.sl.entity.struct.ProviderMembersBackgroundCheckDetails> |
readProviderMembersBackGroundCheckDetails()
Gets details of members of a provider with background check information.
|
void |
reject(java.lang.String rejectionReason,
int versionNo)
Rejects the provider seeking approval for providing the services to an
organization's clients.
|
void |
reopen(int versionNo)
Reopens the closed provider for the approval of providing the services to
an organization's clients and notifies the provider that they are re-opened
and raises a workflow event.
|
void |
setAcceptsCWReferral(boolean acceptReferral)
Sets the indicator that determines whether a Provider will
accept a referral generated by CitizenWorkspace.
|
void |
setAreasServedInfoTextID(long value)
Sets the localized text ID of the provider attribute areas served
information.
|
void |
setClientInfoTextID(long value)
Sets the localized text ID of the provider attribute client information
|
void |
setDateTimeRange(curam.util.type.DateTimeRange clientDateTimeRange)
Sets the start date time and the end date time of the provider.
|
void |
setOverrideMDRInd(boolean overrideMDRInd)
Sets the override maximum deduction rate indicator value to be used in all
the product deliveries of the provider.
|
void |
setPhysicalCapacity(int value)
Sets the physical capacity.
|
void |
setPreferredServiceEnquiryMethod(curam.codetable.impl.PREFERREDSERVICEENQUIRYMETHODEntry value)
Sets the preferred service enquiry method for the provider.
|
void |
setProviderEnquiry(curam.provider.impl.ProviderEnquiry value)
Sets the provider enquiry already created for this provider.
|
void |
setReservationGracePeriod(short value)
Sets the reservation grace period for the provider.
|
void |
suspend(java.lang.String suspensionReason,
int versionNo)
Suspends the provider from providing the services to an organization's
clients.
|
addProviderMember, getCommonApprovedProviderServiceOfferings, getContracts, getIncidents, getProviderMembers, getProviderParticipants, getProviderParties, setCurrencyType, setMethodOfPayment, setPaymentFrequency
checkSecurity, getEmailAddress, getPrimaryAddress, getPrimaryPhoneNumber, getWebAddress, listRelationships
getComments, getConcernRoleType, getCreationDate, getEndDate, getName, getPreferredCommunicationMethod, getPreferredLanguage, getPrimaryAddressID, getPrimaryAlternateID, getPrimaryEmailAddressID, getRegisteredUserName, getRegistrationDate, getSensitivity, getStartDate, getStatusCode
getContextContainer, getID, getPersistenceEventDispatcher
getCaseRole, getMeetingAttendeeInfo
getCurrencyType, getMethodOfPayment, getPaymentFrequency
getResourceID, getResourceType
getAreasServedInfoTextID, getClientInfoTextID, getDateTimeRange, getPhysicalCapacity, getPreferredServiceEnquiryMethod, getReservationGracePeriod, isAttendanceTrackingEnabled, isOverrideMDR, isPaperRosterRequired, isProviderApproved
void setPhysicalCapacity(int value)
value
- the actual capacity of the provider.void setProviderEnquiry(curam.provider.impl.ProviderEnquiry value)
value
- the provider enquiry created for this provider.void reject(java.lang.String rejectionReason, int versionNo) throws curam.util.exception.InformationalException, curam.util.exception.AppException
rejectionReason
- The reason for rejection.versionNo
- The version number as previously retrieved.curam.util.exception.InformationalException
- Generic Exception Signature.curam.util.exception.AppException
- Generic Exception Signature.The default
implementation - curam.provider.impl.ProviderImpl#reject(String,
int).
void approve(int versionNo) throws curam.util.exception.AppException, curam.util.exception.InformationalException
versionNo
- the version number as previously retrieved.curam.util.exception.AppException
- Generic Exception Signature.curam.util.exception.InformationalException
- Generic Exception Signature.The default
implementation - {@link curam.provider.impl.ProviderImpl#approve(int)}.
void approveWithSecurityCheck(int versionNo) throws curam.util.exception.AppException, curam.util.exception.InformationalException
versionNo
- the version number as previously retrieved.curam.util.exception.AppException
- Generic Exception Signature.curam.util.exception.InformationalException
- Generic Exception Signature.The
default
implementation -
{@link curam.provider.impl.ProviderImpl#approveWithSecurityCheck(int)}.
void suspend(java.lang.String suspensionReason, int versionNo) throws curam.util.exception.InformationalException, curam.util.exception.AppException
suspensionReason
- the reason for suspension.versionNo
- the version number as previously retrieved.curam.util.exception.InformationalException
- Generic Exception Signature.curam.util.exception.AppException
- Generic Exception Signature.The default
implementation -
{@link curam.provider.impl.ProviderImpl#suspend(String, int)}.
void close(int versionNo) throws curam.util.exception.InformationalException, curam.util.exception.AppException
versionNo
- the version number as previously retrieved.curam.util.exception.AppException
- Generic Exception Signature.curam.util.exception.InformationalException
- Generic Exception Signature.The default
implementation - {@link curam.provider.impl.ProviderImpl#close(int)}.
void reopen(int versionNo) throws curam.util.exception.InformationalException, curam.util.exception.AppException
versionNo
- The version number as previously retrieved.curam.util.exception.AppException
- Generic Exception Signature.curam.util.exception.InformationalException
- Generic Exception Signature.The default
implementation - {@link curam.provider.impl.ProviderImpl#reopen(int)}.
void enroll(curam.core.struct.ConcernRoleDtls concernRoleDtls, curam.core.struct.AddressDetails addressDetails, curam.core.struct.ConcernRolePhoneDetails concernRolePhoneDetails, curam.core.struct.BankAccountDetails bankAccountDetails) throws curam.util.exception.AppException, curam.util.exception.InformationalException
concernRoleDtls
- it contains concern role related values.addressDetails
- it contains address related details.concernRolePhoneDetails
- it contains concern role phone details.bankAccountDetails
- it contains bank related values.curam.util.exception.InformationalException
- Generic Exception Signature.curam.util.exception.AppException
- Generic Exception Signature.The
default implementation -
{@link curam.provider.impl.ProviderImpl#enroll(ConcernRoleDtls, AddressDetails, ConcernRolePhoneDetails, BankAccountDetails)}
.
java.util.Set<ServiceOffering> getServiceOfferings()
ProviderAccessor
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.
getServiceOfferings
in interface ProviderAccessor
java.util.Set<ProviderOffering> getProviderOfferings()
ProviderAccessor
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.
getProviderOfferings
in interface ProviderAccessor
java.util.Set<curam.provider.impl.ProviderSpecialty> getProviderSpecialties()
ProviderAccessor
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.
getProviderSpecialties
in interface ProviderAccessor
curam.provider.impl.ProviderCategoryPeriod getPrimaryProviderCategoryPeriod()
ProviderAccessor
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.
getPrimaryProviderCategoryPeriod
in interface ProviderAccessor
java.util.Set<curam.provider.impl.ProviderCategoryPeriod> getProviderCategoryPeriods()
ProviderAccessor
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.
getProviderCategoryPeriods
in interface ProviderAccessor
java.util.Set<Compartment> getCompartments()
ProviderAccessor
getCompartments
in interface ProviderAccessor
@Deprecated java.util.Set<Place> getAvailablePlacesInDateRange(curam.util.type.DateRange dateRange) throws curam.util.exception.AppException, curam.util.exception.InformationalException
getAvailablePlacesInDateTimeRange(DateTimeRange)
as part
of fixing making
a place that is just made available to be displayed in the search list of
available places. See release note : CR00260960.getAvailablePlacesInDateRange
in interface ProviderAccessor
dateRange
- Date range to be searched for.curam.util.exception.AppException
- Generic Exception Signature.curam.util.exception.InformationalException
- Generic Exception Signature.java.util.Set<Place> getAvailablePlacesInDateTimeRange(curam.util.type.DateTimeRange dateTimeRange) throws curam.util.exception.AppException, curam.util.exception.InformationalException
dateTimeRange
- Date time range to be searched for.curam.util.exception.AppException
- Generic Exception Signature.curam.util.exception.InformationalException
- Generic Exception Signature.java.util.Set<curam.provider.impl.ProviderAccreditation> getAccreditations()
ProviderAccessor
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.
getAccreditations
in interface ProviderAccessor
java.util.Set<curam.provider.impl.ProviderBackgroundCheck> getProviderBackgroundChecks()
ProviderAccessor
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.
getProviderBackgroundChecks
in interface ProviderAccessor
java.util.Set<curam.provider.impl.ProviderServiceCenter> getProviderServiceCenters()
ProviderAccessor
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.
getProviderServiceCenters
in interface ProviderAccessor
java.util.Set<curam.homestudy.impl.HomeStudy> getHomeStudies()
ProviderAccessor
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.
getHomeStudies
in interface ProviderAccessor
java.util.Set<ServiceInvoiceLineItem> getServiceInvoiceLineItems()
ProviderAccessor
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.
getServiceInvoiceLineItems
in interface ProviderAccessor
curam.provider.impl.ProviderEnquiry getProviderEnquiry()
ProviderAccessor
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.
getProviderEnquiry
in interface ProviderAccessor
void setReservationGracePeriod(short value)
value
- The reservation grace period in days.void setOverrideMDRInd(boolean overrideMDRInd)
overrideMDRInd
- Override maximum deduction rate indicator.curam.workspaceservices.localization.impl.LocalizableText getAreasServedInfo()
ProviderAccessor
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.
getAreasServedInfo
in interface ProviderAccessor
curam.workspaceservices.localization.impl.LocalizableText getClientInfo()
ProviderAccessor
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.
getClientInfo
in interface ProviderAccessor
boolean getAcceptsCWReferral()
true
if the provider accepts referrals
from CitizenWorkspace.void setAreasServedInfoTextID(long value)
value
- The localized text ID of the areas served information.void setClientInfoTextID(long value)
value
- The localized text ID of the client information.void setAcceptsCWReferral(boolean acceptReferral)
acceptReferral
- True if the Provider will accept a referral generated
by CitizenWorkspace.void setPreferredServiceEnquiryMethod(curam.codetable.impl.PREFERREDSERVICEENQUIRYMETHODEntry value)
value
- The preferred service enquiry method entry.@AccessLevel(value=EXTERNAL) java.util.List<curam.cpm.sl.entity.struct.ProviderMembersBackgroundCheckDetails> readProviderMembersBackGroundCheckDetails() throws curam.util.exception.AppException, curam.util.exception.InformationalException
provider
- Provider for which member's background check details will be
retrieved.curam.util.exception.AppException
- Generic Exception Signature.curam.util.exception.InformationalException
- Generic Exception Signature.The
default implementation -
ProviderImpl#getProviderMembersBackGroundCheckDetails(Provider).
void setDateTimeRange(curam.util.type.DateTimeRange clientDateTimeRange)
clientDateTimeRange
- The "lifetime" of the provider in the client time zone.curam.cpm.sl.entity.struct.ProviderInvestigationDetailsList listInvestigationsForProvider(curam.cpm.sl.entity.struct.ProviderConcernRoleKey providerConcernRoleKey) throws curam.util.exception.AppException, curam.util.exception.InformationalException
providerConcernRoleKey
- The Concern Role ID for the Provider for whom the related
investigations are to be retrieved.curam.util.exception.InformationalException
- Generic Exception Signature.curam.util.exception.AppException
- Generic Exception Signature.