@AccessLevel(value=EXTERNAL)
public interface ScheduledAppointment
extends curam.util.persistence.StandardEntity
Modifier and Type | Method and Description |
---|---|
curam.clientdiary.codetable.impl.CLIENTDIARYRELATEDTYPEEntry |
getClientDiaryRelatedType()
Get the related type for the scheduled appointment.
|
java.lang.String |
getDescription()
Returns a description of the scheduled appointment.
|
curam.util.exception.LocalisableString |
getEnd()
Returns a
LocalisableString with a textual description of the end
date and also the end time if specified. |
java.lang.String |
getFrequencyAndDuration()
Returns a description of the frequency of the scheduled appointment to be
converted on the client.
|
java.lang.String |
getOwnerName()
Returns the name of the owner of the scheduled appointment.
|
java.lang.Object |
getOwnerOrgObjectReference()
Returns the unique identifier of the owner of the
ScheduledAppointment . |
curam.codetable.impl.ORGOBJECTTYPEEntry |
getOwnerOrgObjectType()
Returns the
ORGOBJECTTYPEEntry of the owner of the
ScheduledAppointment . |
curam.util.exception.LocalisableString |
getStart()
Returns a
LocalisableString with a textual description of the start
date and also the start time if specified. |
java.lang.String getDescription()
java.lang.String getOwnerName()
curam.codetable.impl.ORGOBJECTTYPEEntry getOwnerOrgObjectType()
ORGOBJECTTYPEEntry
of the owner of the
ScheduledAppointment
. E.g. for an Activity
, this may be a
User
or an Organisation
.java.lang.Object getOwnerOrgObjectReference()
ScheduledAppointment
. This should be used in conjunction with
getOwnerOrgObjectType()
. E.g. where the owner
is an Organisation
, a
Long
is returned.curam.util.exception.LocalisableString getStart()
LocalisableString
with a textual description of the start
date and also the start time if specified. E.g. For a calendar activity
this would be dd/mm/yyyy at hh:mm, whereas for an action this would simply
be dd/mm/yyyy.curam.util.exception.LocalisableString getEnd()
LocalisableString
with a textual description of the end
date and also the end time if specified. E.g. For a calendar activity this
would be dd/mm/yyyy at hh:mm, whereas for an action this would simply be
dd/mm/yyyy. If no end date or time is specified, an empty string should be
returned.java.lang.String getFrequencyAndDuration()
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.
curam.clientdiary.codetable.impl.CLIENTDIARYRELATEDTYPEEntry getClientDiaryRelatedType()
curam.outcomeplanning.outcomeplan.impl.OutcomePlanAction
,
curam.servicedelivery.impl.ServiceDelivery
,
curam.referral.impl.Referral
or Activity
.