@AccessLevel(value=EXTERNAL)
public interface ScheduledAppointmentHandler
ScheduledAppointment
and ClientDiary
functionality.Modifier and Type | Method and Description |
---|---|
void |
cancel(ConcernRole concernRole,
ScheduledAppointment scheduledAppointment)
|
void |
cancel(ScheduledAppointment scheduledAppointment)
Cancels all
ClientDiary records for the given
ScheduledAppointment if any exist. |
java.lang.String |
getFrequencyDuration(curam.util.type.FrequencyPattern frequencyPattern,
int durationInMinutes)
Returns a description of the frequency of the scheduled appointment to be
converted on the client.
|
void |
insert(ConcernRole concernRole,
ScheduledAppointment scheduledAppointment,
curam.util.type.DateRange dateRange)
|
void |
modify(ConcernRole concernRole,
ScheduledAppointment scheduledAppointment,
curam.util.type.DateRange dateRange)
Modifies the
ClientDiary record for the given ConcernRole ,
ScheduledAppointment and date range if one exists. |
void |
modify(ScheduledAppointment scheduledAppointment,
curam.util.type.DateRange dateRange)
Modifies all
ClientDiary records for the given
ScheduledAppointment and date range. |
void cancel(ConcernRole concernRole, ScheduledAppointment scheduledAppointment) throws curam.util.exception.InformationalException
concernRole
- The concern role to search byscheduledAppointment
- The scheduled appointment to search bycuram.util.exception.InformationalException
- Generic Exception Signaturevoid cancel(ScheduledAppointment scheduledAppointment) throws curam.util.exception.InformationalException
ClientDiary
records for the given
ScheduledAppointment
if any exist.scheduledAppointment
- The scheduled appointment to search bycuram.util.exception.InformationalException
- Generic Exception Signaturevoid insert(ConcernRole concernRole, ScheduledAppointment scheduledAppointment, curam.util.type.DateRange dateRange) throws curam.util.exception.InformationalException
concernRole
- The client the appointment is forscheduledAppointment
- The details of the scheduled appointmentdateRange
- The date range of the appointmentcuram.util.exception.InformationalException
- Generic Exception Signaturevoid modify(ConcernRole concernRole, ScheduledAppointment scheduledAppointment, curam.util.type.DateRange dateRange) throws curam.util.exception.InformationalException
ClientDiary
record for the given ConcernRole
,
ScheduledAppointment
and date range if one exists.concernRole
- The client the appointment is forscheduledAppointment
- The details of the scheduled appointmentdateRange
- The date range of the appointmentcuram.util.exception.InformationalException
- Generic Exception Signaturevoid modify(ScheduledAppointment scheduledAppointment, curam.util.type.DateRange dateRange) throws curam.util.exception.InformationalException
ClientDiary
records for the given
ScheduledAppointment
and date range.scheduledAppointment
- The details of the scheduled appointmentdateRange
- The date range of the appointmentcuram.util.exception.InformationalException
- Generic Exception Signaturejava.lang.String getFrequencyDuration(curam.util.type.FrequencyPattern frequencyPattern, int durationInMinutes)
This is intended for use with the FREQUENCY_DURATION_STRING domain
definition, which is converted to a textual description of the frequency of
the scheduled appointment on the client. The string is made up of the
frequency pattern, plus CuramConst#gkPipeDelimiter
, plus duration
as a client formatted LocalisableString. The frequency and duration are
optional and an empty string is returned if none are set.
E.g. Input string:
'000120100|3::curam.clientdiary.message.ScheduledAppointment:INFO_FREQUENCY_DURATION_STRING:(3|17
) ' is converted to the output string 'Every 1 day(s) for 3 hours 17
minutes' on the client.
frequencyPattern
- The frequency pattern to be converted,
FrequencyPattern.kZeroFrequencyPattern
or null
should
be used if this is not requireddurationInMinutes
- The duration in minutes to be converted, 0 should be used if this
is not required