@AccessLevel(value=EXTERNAL)
public interface FederalAllowableComponent
extends curam.util.persistence.StandardEntity, curam.util.persistence.Insertable, curam.util.persistence.OptimisticLockModifiable, curam.util.persistence.helper.LogicallyDeleteable
Modifier and Type | Method and Description |
---|---|
void |
addFederalAllowableComponentLink(long relatedID,
curam.codetable.impl.FEDALLOWCOMPRELATEDTYPEEntry relatedType)
Creates a link between the federal allowable component and the related
record.
|
curam.codetable.impl.CACLIENTPAIDSTATUSEntry |
getCAClientPaidStatus()
Gets the CA client paid status, federal allowable components can be either
in a status of paid or unpaid.
|
curam.codetable.impl.COUNTABLETYPEEntry |
getCountableType()
Gets the countable type code for the federal allowable component, e.g.Core,
Non core.
|
java.lang.String |
getDescription()
Reads the localizable description of the
FederalAllowableComponent
in the current program locale. |
curam.workspaceservices.localization.impl.LocalizableText |
getDescriptionLocalizableText()
Reads the localizable description of the
FederalAllowableComponent . |
curam.util.type.Date |
getEndDate()
Gets the end date of the federal allowable component.
|
java.lang.String |
getName()
Reads the localizable name of the
FederalAllowableComponent in the
current program locale. |
curam.workspaceservices.localization.impl.LocalizableText |
getNameLocalizableText()
Reads the localizable name of the
FederalAllowableComponent . |
curam.util.type.Date |
getStartDate()
Gets the start date of the federal allowable component.
|
boolean |
isProjectionAllowed()
Gets the boolean property for whether or not projection is allowed for the
federal allowable component.
|
java.util.List<curam.federalallowablecomponent.impl.FederalAllowableComponentLink> |
listLinksByRelatedType(curam.codetable.impl.FEDALLOWCOMPRELATEDTYPEEntry relatedType)
Returns a list of the
curam.outcomeplanning.outcomeplan.impl.OutcomePlanActionAdmin
records which are linked to the federal allowable component. |
java.util.List<curam.piwrapper.caseconfiguration.impl.Product> |
listPrograms()
Returns a list of
Product
records linked to the federal allowable component. |
void |
removeActivityLink(long activityID,
curam.codetable.impl.FEDALLOWCOMPRELATEDTYPEEntry relatedType)
Removes a link between a federal allowable component and an activity.
|
void |
setCAClientPaidStatus(curam.codetable.impl.CACLIENTPAIDSTATUSEntry caClientPaidStatus)
Sets the CA client paid status, federal allowable components can be either
in a status of paid or unpaid.
|
void |
setCountableType(curam.codetable.impl.COUNTABLETYPEEntry countableType)
Sets the countable type code for the federal allowable component, e.g.Core,
Non core.
|
void |
setDescription(java.lang.String description)
Sets the localizable description of the
FederalAllowableComponent . |
void |
setEndDate(curam.util.type.Date endDate)
Sets the end date for the federal allowable component.
|
void |
setName(java.lang.String name)
Sets the localizable name of the
FederalAllowableComponent . |
void |
setProjectionAllowed(boolean projectionAllowedInd)
Sets the boolean property for whether or not projection is allowed for the
federal allowable component.
|
void |
setStartDate(curam.util.type.Date startDate)
Sets the start date for the federal allowable component.
|
void |
updateFederalAllowableComponentLinks(java.lang.String tabbedRelatedIDList,
curam.codetable.impl.FEDALLOWCOMPRELATEDTYPEEntry relatedType)
Updates the records of the specified type, which are linked to the federal
allowable component.
|
java.lang.String getName()
FederalAllowableComponent
in the
current program locale.FederalAllowableComponent
in
the current program localecuram.workspaceservices.localization.impl.LocalizableText getNameLocalizableText()
FederalAllowableComponent
.FederalAllowableComponent
void setName(java.lang.String name)
FederalAllowableComponent
.
Whitespace is trimmed
from the
name before it is saved. This is a mandatory field and must be unique.name
- The name of the FederalAllowableComponent
java.lang.String getDescription()
FederalAllowableComponent
in the current program locale.FederalAllowableComponent
in the current program localecuram.workspaceservices.localization.impl.LocalizableText getDescriptionLocalizableText()
FederalAllowableComponent
.FederalAllowableComponent
void setDescription(java.lang.String description)
FederalAllowableComponent
.
This is an optional field.description
- The description of the federal allowable componentcuram.util.type.Date getStartDate()
void setStartDate(curam.util.type.Date startDate)
startDate
- curam date for the start date of the federal allowable componentcuram.util.type.Date getEndDate()
void setEndDate(curam.util.type.Date endDate)
endDate
- curam date for the end date of the federal allowable componentboolean isProjectionAllowed()
void setProjectionAllowed(boolean projectionAllowedInd)
projectionAllowedInd
- boolean property for whether or not projection is allowed for the
federal allowable component.curam.codetable.impl.COUNTABLETYPEEntry getCountableType()
void setCountableType(curam.codetable.impl.COUNTABLETYPEEntry countableType)
countableType
- the countable type code for the federal allowable componentcuram.codetable.impl.CACLIENTPAIDSTATUSEntry getCAClientPaidStatus()
void setCAClientPaidStatus(curam.codetable.impl.CACLIENTPAIDSTATUSEntry caClientPaidStatus)
caClientPaidStatus
- the CA client paid status of the federal allowable componentvoid addFederalAllowableComponentLink(long relatedID, curam.codetable.impl.FEDALLOWCOMPRELATEDTYPEEntry relatedType) throws curam.util.exception.InformationalException
relatedID
- unique identifier of the related recordrelatedType
- code representing the type of the related recordcuram.util.exception.InformationalException
- Generic Exception Signaturevoid updateFederalAllowableComponentLinks(java.lang.String tabbedRelatedIDList, curam.codetable.impl.FEDALLOWCOMPRELATEDTYPEEntry relatedType) throws curam.util.exception.InformationalException
tabbedRelatedIDList
- tab delimited list of the related record identifiersrelatedType
- type of the related recordscuram.util.exception.InformationalException
- Generic Exception Signaturejava.util.List<curam.piwrapper.caseconfiguration.impl.Product> listPrograms()
Product
records linked to the federal allowable component.java.util.List<curam.federalallowablecomponent.impl.FederalAllowableComponentLink> listLinksByRelatedType(curam.codetable.impl.FEDALLOWCOMPRELATEDTYPEEntry relatedType)
curam.outcomeplanning.outcomeplan.impl.OutcomePlanActionAdmin
records which are linked to the federal allowable component.relatedType
- TODOFederalAllowableComponentLink
object instances for
the specified related typevoid removeActivityLink(long activityID, curam.codetable.impl.FEDALLOWCOMPRELATEDTYPEEntry relatedType) throws curam.util.exception.InformationalException
activityID
- unique identifier of the activityrelatedType
- type of the activitycuram.util.exception.InformationalException
- Generic Exception Signature