@AccessLevel(value=EXTERNAL)
@Implementable
public interface CitizenActivity
Modifier and Type | Method and Description |
---|---|
void |
addComment(java.lang.String comment,
ConcernRole concernRole)
Adds a comment relating to this citizen activity to the ParticipantComment
table.
|
User |
getAgencyContact()
Returns a
User representing the Agency Contact for this activity. |
curam.codetable.impl.COMMENTRELATEDTYPEEntry |
getCommentRelatedType()
A participant can comment on many different things, i.e. different types
of record.
|
java.lang.Long |
getID()
Returns the primary key for this activity database record, as a Long.
|
java.lang.String |
getName()
Returns the name to be displayed for this Citizen Activity.
|
java.lang.String |
getParticipation()
Returns a formatted string representing the frequency and duration of this
activity.
|
curam.util.type.DateRange |
getPeriod()
The period of this activity.
|
java.lang.String |
getProviderName()
Returns the name of the Provider, or an empty String if none is specified
for this Citizen Activity.
|
java.lang.Long |
getProviderOfferingID()
Returns the CPM ProviderOffering ID for this activity, if it is related to
a CPM ServiceDelivery or another Citizen Activity type that is related to a
CPM ProviderOffering.
|
java.io.ByteArrayOutputStream |
getReferralDocument()
Returns the referral document as a ByteArrayOutputStream.
|
curam.citizenactivity.codetable.impl.CITIZENACTIVITYTYPEEntry |
getType()
Returns a code table entry representing the type of this activity i.e.
|
java.lang.Boolean |
hasReferralLetter()
Returns whether or not this citizen activity has an associated referral
letter.
|
java.util.List<ConcernRole> |
listConcernRoles()
Lists the ConcernRoles associated with this citizen activity.
|
java.lang.String getName()
curam.util.type.DateRange getPeriod()
java.lang.String getParticipation()
User getAgencyContact()
User
representing the Agency Contact for this activity.curam.citizenactivity.codetable.impl.CITIZENACTIVITYTYPEEntry getType()
java.lang.Long getID()
java.lang.String getProviderName()
java.lang.Long getProviderOfferingID()
java.util.List<ConcernRole> listConcernRoles()
java.lang.Boolean hasReferralLetter()
java.io.ByteArrayOutputStream getReferralDocument() throws curam.util.exception.InformationalException, curam.util.exception.AppException
curam.util.exception.InformationalException
- Generic Exception Signaturecuram.util.exception.AppException
- Generic Exception Signaturevoid addComment(java.lang.String comment, ConcernRole concernRole) throws curam.util.exception.AppException, curam.util.exception.InformationalException
comment
- the comment the citizen has added relating to this citizen
activity.concernRole
- the participant making this comment.curam.util.exception.InformationalException
- Generic Exception Signaturecuram.util.exception.AppException
- Generic Exception Signaturecuram.codetable.impl.COMMENTRELATEDTYPEEntry getCommentRelatedType()