curam.piwrapper.outcomeplan.impl

Interface OutcomePlanActivity

All Superinterfaces:

curam.util.type.DateRanged, curam.util.persistence.Entity<java.lang.Long>, curam.util.persistence.StandardEntity

All Known Implementing Classes:

OutcomePlanActivitySingleTableEntityImpl, OutcomePlanActivitySingleTableLogicallyDeletableEntityImpl

@AccessLevel(value=EXTERNAL)
 @Implementable
public interface OutcomePlanActivity
extends curam.util.persistence.StandardEntity, curam.util.type.DateRanged

Common interface that all activities that can be added to curam.outcomeplanning.outcomeplan.impl.OutcomePlan must implement.

All implementations/extensions of this interface must extend from either OutcomePlanActivitySingleTableEntityImpl or OutcomePlanActivitySingleTableLogicallyDeletableEntityImpl in order to avoid upgrade impact as new operations may be added to the interface overtime.

Since:

6.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	OutcomePlanActivity.OutcomePlanActivityEvents Business events for the OutcomePlanActivity processing that allows customers to add additional processing at various points in the life cycle of an outcome plan activity.
static interface	OutcomePlanActivity.SortByStartDate Comparator used to sort OutcomePlanActivities based on the start date of the activity.

Method Summary

Modifier and Type	Method and Description
curam.util.type.CodeTableEntry	getActivityStatus() Returns the status of the activity.
curam.piwrapper.outcomeplan.codetable.impl.OUTCOMEPLANACTIVITYTYPEEntry	getActivityType() Returns the type of the activity.
ClientURI	getListSummaryURI() Returns the client URI for opening the list summary panel.
java.lang.String	getName() Retrieves the name of the activity.
OutcomePlanActivityAdmin	getOutcomePlanActivityAdmin() Retrieves the OutcomePlanActivityAdmin administration record which is associated with this OutcomePlanActivity.
User	getOwner() Retrieves the user who is the owner of the activity.
CaseHeader	getRelatedCase() Retrieves the case for the activity.
long	getServiceOfferingID() Retrieves the service offering identifier.
ClientURI	getTabURI() Returns the client URI for opening the activity tab.
ClientURI	getWorkspaceSummaryURI() Returns the client URI for opening the workspace summary panel. the workspace summary panel is the UIM page that gets displayed at the bottom of the activity workspace when ever a user selects the activity from within the workspace widget.
boolean	isActive() Indicates if the activity is active, i.e. the activity is not Cancelled or Completed and where the activity is not ended.
boolean	isParticipationAllowed() Indicates if participation can be recorded for this activity.
java.util.List<CaseParticipantRole>	listCaseParticipantRoles() Returns a list of the CaseParticipantRole instances that this activity is related to.

Methods inherited from interface curam.util.persistence.Entity

getContextContainer, getID, getPersistenceEventDispatcher

Methods inherited from interface curam.util.type.DateRanged

getDateRange

Method Detail

getName

java.lang.String getName()

Retrieves the name of the activity.

Returns:

The name of the activity.

getRelatedCase

CaseHeader getRelatedCase()

Retrieves the case for the activity. The related case is typically the OutcomePlan that the activity is on, however certain activities (Stand alone Services) can be related to different types of cases.

Returns:

The case the activity is on.

listCaseParticipantRoles

java.util.List<CaseParticipantRole> listCaseParticipantRoles()

Returns a list of the CaseParticipantRole instances that this activity is related to.

Returns:

A list of all case participant roles for this activity.

getActivityStatus

curam.util.type.CodeTableEntry getActivityStatus()

Returns the status of the activity.

Returns:

The current statue of the planned activity.

getActivityType

curam.piwrapper.outcomeplan.codetable.impl.OUTCOMEPLANACTIVITYTYPEEntry getActivityType()

Returns the type of the activity.

Returns:

The the of the planned activity.

isParticipationAllowed

boolean isParticipationAllowed()

Indicates if participation can be recorded for this activity. If participation is required for this type of activity the activity must also extend the DailyAttendanceRelatedItem interface.

Returns:

true if participation can be recorded for this activity, false otherwise.

getTabURI

ClientURI getTabURI()

Returns the client URI for opening the activity tab.

Returns:

The URI for the activity tab.

getListSummaryURI

ClientURI getListSummaryURI()

Returns the client URI for opening the list summary panel.

Returns:

The URI for the activity list summary panel.

getWorkspaceSummaryURI

ClientURI getWorkspaceSummaryURI()

Returns the client URI for opening the workspace summary panel. the workspace summary panel is the UIM page that gets displayed at the bottom of the activity workspace when ever a user selects the activity from within the workspace widget.

Returns:

The URI for the workspace activity summary panel.

getOwner

User getOwner()

Retrieves the user who is the owner of the activity.

Returns:

the owner of the activity

getOutcomePlanActivityAdmin

OutcomePlanActivityAdmin getOutcomePlanActivityAdmin()

Retrieves the OutcomePlanActivityAdmin administration record which is associated with this OutcomePlanActivity.

Returns:

the administration record corresponding to this OutcomePlanActivity.

isActive

boolean isActive()

Indicates if the activity is active, i.e. the activity is not Cancelled or Completed and where the activity is not ended. This includes activities that are Not Started also.
The default implementation of this method simply checks that the activity has not ended. Each class that implements this interface should override isActive to also check the status of the activity type itself.

Returns:

true if the activity is active and not ended, false otherwise

getServiceOfferingID

long getServiceOfferingID()

Retrieves the service offering identifier.

Returns:

The service offering identifier