curam.cpm.facade.intf

Interface MaintainRosterLineItem

All Known Implementing Classes:

MaintainRosterLineItem, curam.cpm.facade.impl.MaintainRosterLineItem, MaintainRosterLineItemFactory

@AccessLevel(value=EXTERNAL)
public interface MaintainRosterLineItem

This business interface maintains roster line items for a provider. A roster line item allows an organization to record a client's receipt of a service from a provider for a period of time, such as a week or a month. Therefore a roster will usually have as many line items as the provider has clients for a period. Attendance can be recorded at the roster line item level where the organization is interested only in the total number of units delivered in the roster line item period, and not the breakdown of attendance at the daily level.

Method Summary

Modifier and Type	Method and Description
void	addAbsence(curam.cpm.facade.struct.CreateAbsenceDetails details) Adds an absence reason for a provider roster line item.
void	approveRosterLineItem(curam.cpm.facade.struct.PRLIApprovalDetails details) Approves a provider roster line item.
void	cancelRosterLineItem(curam.cpm.facade.struct.PRLICancellationDetails details) Cancels a provider roster line item.
void	deleteAbsenceReason(curam.cpm.facade.struct.KeyVersionDetails key) Cancels the absence reason that is associated with a provider roster line item.
void	deleteRosterLineItem(curam.cpm.facade.struct.PRLICancellationDetails details) Cancels a provider roster line item.
void	denyRosterLineItem(curam.cpm.facade.struct.PRLIDenialDetails details) Denies a provider roster line item and updates the status to Denied.
curam.cpm.facade.struct.AbsenceDetailsList	listAbsences(curam.cpm.sl.entity.struct.ProviderRosterLineItemKey key) Returns the list of absences for a provider roster line item.
curam.cpm.facade.struct.DailyAttendanceHistoryList	listDailyAttendanceHistory(curam.cpm.sl.entity.struct.ProviderRosterLineItemKey providerRosterLineItemKey) Returns the history of daily attendance associated with a roster line item.
curam.cpm.facade.struct.AbsencePeriodHistoryDetailsList	listHistoryForAbsencePeriod(curam.cpm.sl.entity.struct.ProviderRosterLineItemKey key) Returns the history of an absence period associated with a roster line item.
curam.cpm.facade.struct.PRLIHistoryWithStatusDetailsList	listHistoryForPRLI(curam.cpm.sl.entity.struct.ProviderRosterLineItemKey providerRosterLineItemKey) Returns the history of a provider roster line item.
curam.cpm.facade.struct.PRLITransactionDetailsList	listTransactionsForRosterLineItem(curam.cpm.sl.entity.struct.ProviderRosterLineItemKey key) Returns a list of transactions for a provider roster line item.
curam.core.struct.InformationalMsgDtlsList	submitRosterLineItem(curam.cpm.facade.struct.KeyVersionDetails key) Submits a provider roster line item for processing and updates the status to "Pending Approval".
void	updateRosterLineItem(curam.cpm.facade.struct.ProviderRosterLineItemDetails details) Modifies a provider roster line item.
curam.cpm.facade.struct.ViewReportingDailyAttendanceDetails	viewDailyAttendanceDetailsForReporting(curam.cpm.sl.entity.struct.ProviderRosterLineItemKey key) Returns the list of daily attendance records for a provider roster line item which uses the Attendance reporting type and has hours enabled.
curam.core.struct.InformationalMsgDtlsList	viewRLIExceptionTask(curam.cpm.sl.entity.struct.ProviderRosterLineItemKey key) Reads the exception task details associated with a provider roster line item.
curam.cpm.facade.struct.PRLISummaryDetails	viewRosterLineItem(curam.cpm.sl.entity.struct.ProviderRosterLineItemKey key) Reads the details of a provider roster line item.

Method Detail

viewRosterLineItem

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.PRLISummaryDetails viewRosterLineItem(curam.cpm.sl.entity.struct.ProviderRosterLineItemKey key)
                                                                                    throws curam.util.exception.AppException,
                                                                                           curam.util.exception.InformationalException

Reads the details of a provider roster line item.

Parameters:

key - The key of the provider roster line item.

Returns:

The details of the roster line item.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

RosterLineItem, ProviderRosterLineItem

listTransactionsForRosterLineItem

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.PRLITransactionDetailsList listTransactionsForRosterLineItem(curam.cpm.sl.entity.struct.ProviderRosterLineItemKey key)
                                                                                                           throws curam.util.exception.AppException,
                                                                                                                  curam.util.exception.InformationalException

Returns a list of transactions for a provider roster line item.

Parameters:

key - The key of the provider roster line item.

Returns:

The list of transactions for the roster line item.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProviderRosterLineItemTransaction

updateRosterLineItem

@AccessLevel(value=EXTERNAL)
void updateRosterLineItem(curam.cpm.facade.struct.ProviderRosterLineItemDetails details)
                                                throws curam.util.exception.AppException,
                                                       curam.util.exception.InformationalException

Modifies a provider roster line item.

Parameters:

details - The details of the provider roster line item.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

ProviderRosterLineItem

deleteRosterLineItem

@AccessLevel(value=EXTERNAL)
void deleteRosterLineItem(curam.cpm.facade.struct.PRLICancellationDetails details)
                                                throws curam.util.exception.AppException,
                                                       curam.util.exception.InformationalException

Cancels a provider roster line item.

Parameters:

details - The key of the provider roster line item and version number.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

ProviderRosterLineItem, RosterLineItem

addAbsence

@AccessLevel(value=EXTERNAL)
void addAbsence(curam.cpm.facade.struct.CreateAbsenceDetails details)
                                      throws curam.util.exception.AppException,
                                             curam.util.exception.InformationalException

Adds an absence reason for a provider roster line item.

Parameters:

details - Contains the provider roster line item and the absence reason details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

AbsencePeriod

listAbsences

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.AbsenceDetailsList listAbsences(curam.cpm.sl.entity.struct.ProviderRosterLineItemKey key)
                                                                              throws curam.util.exception.AppException,
                                                                                     curam.util.exception.InformationalException

Returns the list of absences for a provider roster line item.

Parameters:

key - The key of the provider roster line item.

Returns:

The list of absences for the provider roster line item.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProviderRosterLineItem, AbsencePeriod

submitRosterLineItem

@AccessLevel(value=EXTERNAL)
curam.core.struct.InformationalMsgDtlsList submitRosterLineItem(curam.cpm.facade.struct.KeyVersionDetails key)
                                                                                      throws curam.util.exception.AppException,
                                                                                             curam.util.exception.InformationalException

Submits a provider roster line item for processing and updates the status to "Pending Approval".

Parameters:

key - Contains the provider roster line item key and version number.

Returns:

The list of informational message.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

ProviderRosterLineItem, RosterLineItem

approveRosterLineItem

@AccessLevel(value=EXTERNAL)
void approveRosterLineItem(curam.cpm.facade.struct.PRLIApprovalDetails details)
                                                 throws curam.util.exception.AppException,
                                                        curam.util.exception.InformationalException

Approves a provider roster line item.

Parameters:

details - Contains the provider roster line item key and the version number.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

DailyAttendance

Business Object Write:

ProviderRosterLineItem, RosterLineItem

denyRosterLineItem

@AccessLevel(value=EXTERNAL)
void denyRosterLineItem(curam.cpm.facade.struct.PRLIDenialDetails details)
                                              throws curam.util.exception.AppException,
                                                     curam.util.exception.InformationalException

Denies a provider roster line item and updates the status to Denied.

Parameters:

details - Contains a provider roster line item key, version number and denial reason.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

ProviderRosterLineItem, RosterLineItem

cancelRosterLineItem

@AccessLevel(value=EXTERNAL)
void cancelRosterLineItem(curam.cpm.facade.struct.PRLICancellationDetails details)
                                                throws curam.util.exception.AppException,
                                                       curam.util.exception.InformationalException

Cancels a provider roster line item.

Parameters:

details - Contains the provider roster line item key, version number and cancellation reason.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

ProviderRosterLineItem, RosterLineItem

deleteAbsenceReason

@AccessLevel(value=EXTERNAL)
void deleteAbsenceReason(curam.cpm.facade.struct.KeyVersionDetails key)
                                               throws curam.util.exception.AppException,
                                                      curam.util.exception.InformationalException

Cancels the absence reason that is associated with a provider roster line item.

Parameters:

key - Contains the absence reason key and version number.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

AbsencePeriod

listHistoryForAbsencePeriod

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.AbsencePeriodHistoryDetailsList listHistoryForAbsencePeriod(curam.cpm.sl.entity.struct.ProviderRosterLineItemKey key)
                                                                                                          throws curam.util.exception.AppException,
                                                                                                                 curam.util.exception.InformationalException

Returns the history of an absence period associated with a roster line item. The list is ordered by creation date, earliest first.

Parameters:

key - The key of the provider roster line item.

Returns:

The history of the absence period.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

AbsencePeriod, ProviderRosterLineItem

viewRLIExceptionTask

@AccessLevel(value=EXTERNAL)
curam.core.struct.InformationalMsgDtlsList viewRLIExceptionTask(curam.cpm.sl.entity.struct.ProviderRosterLineItemKey key)
                                                                                      throws curam.util.exception.AppException,
                                                                                             curam.util.exception.InformationalException

Reads the exception task details associated with a provider roster line item.

Parameters:

key - The key of a provider roster line item.

Returns:

The details of an exception task.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProviderRosterLineItem

viewDailyAttendanceDetailsForReporting

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.ViewReportingDailyAttendanceDetails viewDailyAttendanceDetailsForReporting(curam.cpm.sl.entity.struct.ProviderRosterLineItemKey key)
                                                                                                                         throws curam.util.exception.AppException,
                                                                                                                                curam.util.exception.InformationalException

Returns the list of daily attendance records for a provider roster line item which uses the Attendance reporting type and has hours enabled.

Parameters:

key - The key of a provider roster line item.

Returns:

The list of daily attendance for a roster line item.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

DailyAttendance, ProviderRosterLineItem

listDailyAttendanceHistory

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.DailyAttendanceHistoryList listDailyAttendanceHistory(curam.cpm.sl.entity.struct.ProviderRosterLineItemKey providerRosterLineItemKey)
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

Returns the history of daily attendance associated with a roster line item. The list is ordered by the creation date, earliest first.

Parameters:

key - The key of a roster line item.

Returns:

The history of daily attendance.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

DailyAttendance, ProviderRosterLineItem

listHistoryForPRLI

@AccessLevel(value=EXTERNAL)
curam.cpm.facade.struct.PRLIHistoryWithStatusDetailsList listHistoryForPRLI(curam.cpm.sl.entity.struct.ProviderRosterLineItemKey providerRosterLineItemKey)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Returns the history of a provider roster line item.

Parameters:

providerRosterLineItemKey - The key of the provider roster line item.

Returns:

The history of the provider roster line item.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

ProviderRosterLineItem