@AccessLevel(value=EXTERNAL) public interface OutcomePlanActionAdmin extends curam.util.persistence.StandardEntity, curam.util.persistence.helper.Lifecycle<curam.codetable.impl.RECORDSTATUSEntry>, curam.util.persistence.Insertable, curam.util.persistence.OptimisticLockModifiable, curam.util.persistence.helper.LogicallyDeleteable, java.lang.Comparable<OutcomePlanActionAdmin>, curam.piwrapper.outcomeplan.impl.OutcomePlanActivityAdmin
Outcome Plan
. This interface is focused on the
configuration of different OutcomePlanAction records within the
administration component.
The following exception messages are thrown by this entity:
OUTCOMEPLANACTIONADMIN#ERR_FV_NAME_MUST_BE_ENTERED
- If the name
field is empty.
OUTCOMEPLANACTIONADMIN#ERR_XRV_NAME_MUST_BE_UNIQUE
- If another
OutcomePlanAdmin
exists with the same name.
OUTCOMEPLANACTIONADMIN#ERR_XRV_REFERENCE_MUST_BE_UNIQUE
- If the
reference has been specified and another OutcomePlanAdmin
exists with
the same reference.
OUTCOMEPLANACTIONADMIN#ERR_FV_CREATE_SID_TOO_LONG
- If a value
greater than OutcomePlanActionAdminAdapter#kMaxLength_createSID
is
given. OUTCOMEPLANACTIONADMIN#ERR_FV_MODIFY_SID_TOO_LONG
- If a
value greater than OutcomePlanActionAdminAdapter#kMaxLength_modifySID
is given.
OUTCOMEPLANACTIONADMIN#ERR_FV_REFERENCE_CANNOT_CONTAIN_SPACES
- If
the reference entered contains spaces.
OUTCOMEPLANACTIONADMIN#ERR_FV_REFERENCE_TOO_LONG
- If a value greater
than OutcomePlanActionAdminAdapter#kMaxLength_reference
is
given.
OUTCOMEPLANACTIONADMIN#ERR_XFV_FIXED_ACTUAL_COST_MODEL_MANDATORY_IF_FIXED_COST_ENTERED
- If a fixed cost has been entered but the cost model is not
OPACTIONCOSTMODELEntry.FIXEDACTUAL
.
OUTCOMEPLANACTIONADMIN#ERR_XFV_FIXED_COST_MANDATORY_IF_FIXED_ACTUAL_COST_MODEL
- If the OPACTIONCOSTMODELEntry.FIXEDACTUAL
cost model has been
selected but no fixed cost has been entered.
OUTCOMEPLANACTIONADMIN#ERR_FV_HOME_PAGE_TOO_LONG
- If the home page
exceeds the maximum length for the field,
OutcomePlanActionAdminAdapter#kMaxLength_homePage
.
OUTCOMEPLANACTIONADMIN#ERR_FV_HOME_PAGE_CANNOT_CONTAIN_SPACES
- If
the home page field contains whitespace.
The following exception messages are added by this method:
OUTCOMEPLANACTIONADMIN#ERR_FV_LIST_PREVIEW_PAGE_TOO_LONG
- If the
list preview page exceeds the maximum length for the field,
OutcomePlanActionAdminAdapter#kMaxLength_listDropdownPane
.
OUTCOMEPLANACTIONADMIN#ERR_FV_LIST_PREVIEW_PAGE_CANNOT_CONTAIN_SPACES
- If the list preview page field contains whitespace.
OUTCOMEPLANACTIONADMIN#ERR_FV_START_DATE_DAYS_MUST_BE_NUMERIC
- if
the passed in value the method #setStartDateDays(String)
is not
numeric
OUTCOMEPLANACTIONADMIN#ERR_FV_START_DATE_DAYS_MUST_BE_WHOLE_NUMBER
-
if the passed in value to the method #setStartDateDays(String)
is not
a whole number
OUTCOMEPLANACTIONADMIN#ERR_FV_START_DATE_DAYS_MUST_BE_ZERO_OR_GREATER
- if the passed in value for the method #setStartDateDays(String)
is
a negative number
OUTCOMEPLANACTIONADMIN#ERR_FV_DURATION_DAYS_MUST_BE_NUMERIC
- - if
the passed in value for the method #setDurationDays(String)
is not
numeric
OUTCOMEPLANACTIONADMIN#ERR_FV_DURATION_DAYS_MUST_BE_WHOLE_NUMBER
- if
the passed in value for the method #setDurationDays(String)
not a
whole number
OUTCOMEPLANACTIONADMIN#ERR_FV_DURATION_DAYS_MUST_BE_ZERO_OR_GREATER
-
if the passed in value for the method #setDurationDays(String)
is a
negative number
curam.outcomeplanning.outcomeplan.entity.intf.OutcomePlanActionAdmin}
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getActivityName() |
curam.outcomeplanning.codetable.impl.OPACTIONCOSTMODELEntry |
getCostModel()
Indicates the cost information to be captured on this type of
action . |
java.lang.String |
getCreateSID()
Returns the creation rights for this type of
action . |
curam.util.type.Date |
getCreationDate()
Returns the date on which this
OutcomePlanActionAdmin was created. |
java.lang.String |
getDescription() |
curam.util.type.Money |
getFixedCost()
Returns the fixed cost of this type of
action . |
java.lang.String |
getHomePage()
Reads the home page value entered by the administration user during the
configuration of this outcome plan action.
|
curam.piwrapper.impl.ClientURI |
getHomePageURI()
Retrieves the home page used for this outcome plan administration action.
|
java.lang.String |
getListPreviewPage()
Reads the list preview page value entered by the administration user during
the configuration of this administration outcome plan action.
|
curam.piwrapper.impl.ClientURI |
getListPreviewPageURI()
Retrieves the list preview page used for this administration outcome plan
action.
|
java.lang.String |
getModifySID()
Returns the modification rights for this type of
action . |
curam.outcomeplanning.codetable.impl.OPACTIONOWNEREntry |
getOwner()
Indicates who can own this type of
action . |
java.lang.String |
getReference()
Reads the unique reference of the
OutcomePlanActionAdmin . |
curam.outcomeplanning.codetable.impl.OPACTIONRESPONSIBILITYEntry |
getResponsibility()
Indicates who can be responsible for this type of
action . |
boolean |
hasClientParticipation()
Indicates if client participation should be captured for this type of
action . |
boolean |
hasMultipleClients()
Returns true if multiple clients can be specified when creating an
action . |
boolean |
isExcludedFromAvailabilityCheck()
Indicates if
actions of this type should be
excluded from the list of scheduled appointments returned when a user
checks the availability of a client. |
boolean |
isNameEditable()
Indicates if the name of the action can be updated on the
action . |
void |
setHomePage(java.lang.String homePage)
Sets the home page of this outcome plan action.
|
void |
setListPreviewPage(java.lang.String listPreviewPage)
Sets the list preview page for this administration outcome plan action.
|
getOutcomePlanActivityType
java.lang.String getActivityName()
getActivityName
in interface curam.piwrapper.outcomeplan.impl.OutcomePlanActivityAdmin
java.lang.String getReference()
OutcomePlanActionAdmin
.boolean hasMultipleClients()
action
.curam.outcomeplanning.codetable.impl.OPACTIONRESPONSIBILITYEntry getResponsibility()
action
. E.g. User
Creating Action
, Any User
,
Client
,
Either User or
Client
. This dictates what get displayed to the user when creating the
action
.curam.outcomeplanning.codetable.impl.OPACTIONOWNEREntry getOwner()
action
. E.g.
User Creating Action
,
Any User
. This dictates what gets
displayed to the user when creating an action
.curam.outcomeplanning.codetable.impl.OPACTIONCOSTMODELEntry getCostModel()
action
.curam.util.type.Money getFixedCost()
action
.java.lang.String getCreateSID()
action
.java.lang.String getModifySID()
action
.boolean hasClientParticipation()
action
.curam.util.type.Date getCreationDate()
OutcomePlanActionAdmin
was created.java.lang.String getDescription()
getDescription
in interface curam.piwrapper.outcomeplan.impl.OutcomePlanActivityAdmin
boolean isExcludedFromAvailabilityCheck()
actions
of this type should be
excluded from the list of scheduled appointments returned when a user
checks the availability of a client.boolean isNameEditable()
action
.action
, false otherwisevoid setHomePage(java.lang.String homePage)
OutcomePlanAction
. Whitespace is
trimmed
from the home page before
it is saved. This is an optional field.
The following exception messages are added by this method:
OUTCOMEPLANACTIONADMIN#ERR_FV_HOME_PAGE_TOO_LONG
- If the home page
exceeds the maximum length for the field.
OUTCOMEPLANACTIONADMIN#ERR_FV_HOME_PAGE_CANNOT_CONTAIN_SPACES
- If
the home page field contains whitespace.
homePage
- The home page of this outcome plan actionjava.lang.String getHomePage()
getHomePageURI()
.getHomePageURI()
curam.piwrapper.impl.ClientURI getHomePageURI()
OutcomePlanAction
created in relation to this administration outcome plan action. If the home
page has not been set, a default value is read from the properties and is
returned by this method. No parameter values are appended as part of this
method.
The property used to retrieve the action home page from when this value is not set is:
EnvVars#ENV_OUTCOME_PLAN_ACTION_HOME_URI
OutcomePlanAction
created
in relation to this administration outcome plan actionvoid setListPreviewPage(java.lang.String listPreviewPage)
trimmed
from the
entered list preview page before it is saved. This is an optional field.
The following exception messages are added by this method:
OUTCOMEPLANACTIONADMIN#ERR_FV_LIST_PREVIEW_PAGE_TOO_LONG
- If the
list preview page exceeds the maximum length for the field.
OUTCOMEPLANACTIONADMIN#ERR_FV_LIST_PREVIEW_PAGE_CANNOT_CONTAIN_SPACES
- If the list preview page field contains whitespace.
listPreviewPage
- The list preview pane page of this administration outcome plan
actionjava.lang.String getListPreviewPage()
getListPreviewPageURI()
.getListPreviewPageURI()
curam.piwrapper.impl.ClientURI getListPreviewPageURI()
OutcomePlanAction
created in relation to this administration
outcome plan action. If no list preview page is entered by a administration
user, a default value is read from the properties and is returned by this
method. No parameter values are appended as part of this method.
The property used to retrieve the action list preview pane page from when this value is not set is:
EnvVars#ENV_OUTCOME_PLAN_ACTION_LIST_DROPDOWN_PANE_URI