@AccessLevel(value=EXTERNAL)
public interface Application
extends curam.util.persistence.StandardEntity, curam.util.persistence.Insertable, curam.util.persistence.OptimisticLockModifiable, curam.util.persistence.helper.LogicallyDeleteable
ProgramApplication
. Similarly it can contain one or more
IntakeApplicant
s, where one is the primary applicant. The general
lifecycle of an application is:
Modifier and Type | Method and Description |
---|---|
void |
assignToMe()
Assigns the application to the current user.
|
void |
dispose()
Sets the status of the application to
APPLICATIONSTATUSEntry.DISPOSED . |
curam.codetable.impl.APPLICATIONMETHODEntry |
getApplicationMethod()
Gets the method of application.
|
curam.codetable.impl.APPLICATIONTYPEEntry |
getApplicationType()
Gets the
APPLICATIONTYPEEntry . |
java.lang.String |
getAuthorizationInformationText()
Gets the authorization information text configured for this application.
|
curam.piwrapper.caseheader.impl.CaseHeader |
getCase()
Gets the case that is associated with this application.
|
java.lang.String |
getDepartmentPolicyText()
Gets the department policy text configured for this application.
|
boolean |
getDisableMenuOptionsOnDisposedApplication()
Indicates if the menu options on a disposed application
should be enabled or disabled.
|
curam.util.type.Date |
getFilingDate()
Gets the filing date of the application.
|
java.lang.String |
getFullReference()
Gets the full application reference number.
|
long |
getIEGExecutionID()
Gets the ID of the IEG execution for this application.
|
curam.codetable.impl.LANGUAGEEntry |
getInterpreterLanguageCode()
Gets the interpreter language required for this application.
|
boolean |
getInterpreterRequestInd()
Gets a
boolean indicating whether or not an interpreter
has been requested for this application. |
int |
getNumberOfDeadlineDays()
Determines the minimum number of days left, across all programs on the
application, within which time the processing of the application should be
completed.
|
ApplicationRoleObject |
getOwner()
Retrieves the owner of the application.
|
long |
getPdfID()
Gets the ID of the PDF associated with this application.
|
IntakeApplicant |
getPrimaryIntakeApplicant()
Gets the primary
IntakeApplicant for the application. |
ProgramApplication |
getProgramApplication(curam.codetable.impl.PROGRAMTYPEEntry programType)
Gets the
ProgramApplication of the specified type on this
application, or null if no application has been made for that
type of program. |
ProgramApplication |
getProgramApplication(curam.codetable.impl.PROGRAMTYPEEntry programType,
curam.codetable.impl.PROGRAMSTATUSEntry programStatus)
Gets the
ProgramApplication of the specified type with the status
on this
application, or null if no application has been made for that
type of program. |
java.util.List<ProgramApplication> |
getProgramApplications()
Gets a
list of ProgramApplication s associated with
this application. |
java.lang.String |
getProgramApplicationsAsString()
Gets a localized
string representation of the
ProgramApplication s associated with this application. |
java.lang.String |
getReference()
Gets the application reference number.
|
java.lang.String |
getReferenceAddendum()
Gets the reference addendum.
|
java.lang.String |
getRightsAndResponsibilitiesText()
Gets the rights and responsibilities text configured for this application.
|
long |
getRootEntityID()
Gets the ID of the datastore root entity for this application.
|
java.lang.String |
getSchemaName()
Gets the datastore schema name for this application.
|
boolean |
getSpecialAssistanceInd()
Gets a
boolean indicating whether or not special
assistance is required for the applicant of this application. |
java.lang.String |
getSpecialAssistanceRequirements()
Gets a
string detailing the special assistance required by
the application. |
curam.application.codetable.impl.APPLICATIONSTATUSEntry |
getStatus()
Gets the
APPLICATIONSTATUSEntry of this application. |
curam.util.type.DateTime |
getSubmittedDateTime()
Gets the date time recorded when the application transitioned into
APPLICATIONSTATUSEntry.SUBMITTED . |
void |
insert(ApplicationRoleObject applicationRoleObject)
Inserts the application record and sets its owner to the specified
ApplicationRoleObject . |
boolean |
isTransferrable()
Determines if the application can be transferred.
|
boolean |
isUndoTransferAvailable()
Gets a
boolean indicating whether or the undo transfer
application functionality is available or not for this application. |
void |
modifyOwner(curam.codetable.impl.ORGOBJECTTYPEEntry type,
java.lang.String orgObjectReference,
curam.codetable.impl.APPLICATIONREASSIGNREASONEntry reason,
java.lang.String comments)
Modifies the owner of the application.
|
void |
modifyOwner(java.lang.String username,
curam.codetable.impl.APPLICATIONREASSIGNREASONEntry reason,
java.lang.String comments)
Modifies the owner of the application.
|
void |
setApplicationMethod(curam.codetable.impl.APPLICATIONMETHODEntry applicationMethod)
Sets the method of application.
|
void |
setApplicationType(curam.codetable.impl.APPLICATIONTYPEEntry applicationType)
Sets the type of application.
|
void |
setCase(curam.piwrapper.caseheader.impl.CaseHeader caseHeader)
Sets the case to be associated with this application.
|
void |
setFilingDate(curam.util.type.Date filingDate)
Sets filing date of the application.
|
void |
setIEGExecutionID(java.lang.Long iEGExecutionID)
Sets the ID of the IEG execution for this application.
|
void |
setInterpreterLanguageCode(curam.codetable.impl.LANGUAGEEntry language)
Sets the interpreter language required for this application.
|
void |
setInterpreterRequestInd(boolean interpreterRequestInd)
Sets a
boolean indicating whether or not an interpreter
has been requested for this application. |
void |
setPdfID(java.lang.Long pdfID)
Sets ID of the PDF associated with this application.
|
void |
setReadyForDetermination()
Sets the application to a state of
APPLICATIONSTATUSEntry.READY_FOR_DETERMINATION but also:
Raises the ReadyForDetermination.APPLICATION_READY_FOR_DETERMINATION
event. |
void |
setReference(java.lang.String reference)
Sets the application reference.
|
void |
setReferenceAddendum(java.lang.String referenceAddendum)
Sets the reference addendum.
|
void |
setRootEntityID(long rootEntityID)
Sets the ID of the datastore root entity for this application.
|
void |
setSchemaName(java.lang.String schemaName)
Sets the datastore schema name for this application.
|
void |
setSpecialAssistanceInd(boolean specialAssistanceInd)
Sets a
boolean indicating whether or not special
assistance is required for the applicant of this application. |
void |
setSpecialAssistanceRequirements(java.lang.String specialAssistanceRequirements)
Sets a
string detailing the special assistance required by
the application. |
void |
setSubmittedDateTime(curam.util.type.DateTime submittedDateTime)
Sets the date time recorded when the application transitioned into
APPLICATIONSTATUSEntry.SUBMITTED . |
long |
start(curam.codetable.impl.APPLICATIONTYPEEntry applicationType,
java.util.List<curam.codetable.impl.PROGRAMTYPEEntry> programTypes,
curam.participant.impl.ConcernRole concernRole)
Sets up the
Application based on the information supplied. |
void |
start(curam.workspaceservices.intake.impl.IntakeApplication intakeApplication)
Starts an
Application based on the information extracted from the
related IntakeApplication . |
long |
startForCase(curam.codetable.impl.APPLICATIONTYPEEntry applicationType,
java.util.List<curam.codetable.impl.PROGRAMTYPEEntry> programTypes,
curam.participant.impl.ConcernRole concernRole,
curam.piwrapper.caseheader.impl.CaseHeader caseHeader)
Sets up the
Application for a case based on the information
supplied. |
void |
submit()
Submitting an application causes a number of processes to be invoked.
|
void |
submitForCase()
Submits an application for an existing integrated case.
|
void assignToMe() throws curam.util.exception.AppException, curam.util.exception.InformationalException
curam.util.exception.AppException
curam.util.exception.InformationalException
boolean getDisableMenuOptionsOnDisposedApplication() throws curam.util.exception.AppException, curam.util.exception.InformationalException
curam.util.exception.AppException
curam.util.exception.InformationalException
curam.codetable.impl.APPLICATIONMETHODEntry getApplicationMethod()
APPLICATIONMETHODEntry
.curam.codetable.impl.APPLICATIONTYPEEntry getApplicationType()
APPLICATIONTYPEEntry
.APPLICATIONTYPEEntry
.java.lang.String getAuthorizationInformationText() throws curam.util.exception.AppException, curam.util.exception.InformationalException
curam.util.exception.AppException
curam.util.exception.InformationalException
curam.piwrapper.caseheader.impl.CaseHeader getCase()
java.lang.String getDepartmentPolicyText() throws curam.util.exception.AppException, curam.util.exception.InformationalException
curam.util.exception.AppException
curam.util.exception.InformationalException
curam.util.type.Date getFilingDate()
java.lang.String getFullReference()
getReference()
+ " - " +
getReferenceAddendum()
.
If getReferenceAddendum()
is empty then the full
reference number is simply getReference()
.long getIEGExecutionID()
curam.codetable.impl.LANGUAGEEntry getInterpreterLanguageCode()
LANGUAGEEntry
required for this
application.boolean getInterpreterRequestInd()
boolean
indicating whether or not an interpreter
has been requested for this application.True
if an interpreter has been requested for this
application, otherwise false
.long getPdfID()
IntakeApplicant getPrimaryIntakeApplicant() throws curam.util.exception.AppException, curam.util.exception.InformationalException
IntakeApplicant
for the application.curam.util.exception.AppException
curam.util.exception.InformationalException
ProgramApplication getProgramApplication(curam.codetable.impl.PROGRAMTYPEEntry programType)
ProgramApplication
of the specified type on this
application, or null
if no application has been made for that
type of program.programType
- The type of program application being sought.null
if one doesn't exist.java.util.List<ProgramApplication> getProgramApplications() throws curam.util.exception.AppException, curam.util.exception.InformationalException
list
of ProgramApplication
s associated with
this application.list
of ProgramApplication
s associated
with this application.curam.util.exception.AppException
curam.util.exception.InformationalException
java.lang.String getProgramApplicationsAsString() throws curam.util.exception.AppException, curam.util.exception.InformationalException
string
representation of the
ProgramApplication
s associated with this application. The
string
is a comma separated one, containing the localized
description of the ProgramApplication
s, it takes the form:
"ProgramDescription1, ProgramDescription2, and ProgramDescription3."
where three different programs where applied for. If only one
ProgramApplication
was made then the string
would
take the form:
"ProgramDescription1."
string
representation of
the ProgramApplication
s associated with this application.curam.util.exception.AppException
curam.util.exception.InformationalException
java.lang.String getReference()
java.lang.String getReferenceAddendum()
java.lang.String getRightsAndResponsibilitiesText() throws curam.util.exception.AppException, curam.util.exception.InformationalException
curam.util.exception.AppException
curam.util.exception.InformationalException
long getRootEntityID()
java.lang.String getSchemaName()
boolean getSpecialAssistanceInd()
boolean
indicating whether or not special
assistance is required for the applicant of this application.True
if special assistance is required for the
applicant of this application, otherwise false
.java.lang.String getSpecialAssistanceRequirements()
string
detailing the special assistance required by
the application.string
detailing the special assistance required by
the application.curam.application.codetable.impl.APPLICATIONSTATUSEntry getStatus() throws curam.util.exception.AppException, curam.util.exception.InformationalException
APPLICATIONSTATUSEntry
of this application.APPLICATIONSTATUSEntry
of this application.curam.util.exception.AppException
curam.util.exception.InformationalException
curam.util.type.DateTime getSubmittedDateTime()
APPLICATIONSTATUSEntry.SUBMITTED
.APPLICATIONSTATUSEntry.SUBMITTED
.boolean isTransferrable()
True
if the application can be transferred, otherwise
false
.boolean isUndoTransferAvailable()
boolean
indicating whether or the undo transfer
application functionality is available or not for this application. One
reason in may not be available is that the evidence has been modified post
transfer.True
the undo transfer application functionality is
available, otherwise false
.void setApplicationMethod(curam.codetable.impl.APPLICATIONMETHODEntry applicationMethod)
APPLICATIONMETHODEntry
.applicationMethod
- The method of application.void setApplicationType(curam.codetable.impl.APPLICATIONTYPEEntry applicationType)
applicationType
- The type of application.void setCase(curam.piwrapper.caseheader.impl.CaseHeader caseHeader) throws curam.util.exception.AppException, curam.util.exception.InformationalException
caseHeader
- The case to be associated with the application.curam.util.exception.AppException
curam.util.exception.InformationalException
void setFilingDate(curam.util.type.Date filingDate)
filingDate
- The filing date of the application.void setIEGExecutionID(java.lang.Long iEGExecutionID)
iEGExecutionID
- The ID of the IEG execution for this application.void setInterpreterLanguageCode(curam.codetable.impl.LANGUAGEEntry language)
language
- The interpreter LANGUAGEEntry
required for this
application.void setInterpreterRequestInd(boolean interpreterRequestInd)
boolean
indicating whether or not an interpreter
has been requested for this application.interpreterRequestInd
- Whether an interpreter has been requested for
this application.void setPdfID(java.lang.Long pdfID) throws curam.util.exception.InformationalException
pdfID
- TheID of the PDF associated with this application.curam.util.exception.InformationalException
void setReadyForDetermination() throws curam.util.exception.AppException, curam.util.exception.InformationalException
APPLICATIONSTATUSEntry.READY_FOR_DETERMINATION
but also:
curam.util.exception.AppException
curam.util.exception.InformationalException
void setReference(java.lang.String reference)
reference
- The application reference.void setReferenceAddendum(java.lang.String referenceAddendum)
referenceAddendum
- The reference addendum for this application.void setRootEntityID(long rootEntityID)
rootEntityID
- The ID of the datastore root entity for this
application.void setSchemaName(java.lang.String schemaName)
schemaName
- The datastore schema name for this application.void setSpecialAssistanceInd(boolean specialAssistanceInd)
boolean
indicating whether or not special
assistance is required for the applicant of this application.specialAssistanceInd
- Whether or not special
assistance is required for the applicant of this application.void setSpecialAssistanceRequirements(java.lang.String specialAssistanceRequirements)
string
detailing the special assistance required by
the application.specialAssistanceRequirements
- A string
detailing the
special assistance required by the application.void setSubmittedDateTime(curam.util.type.DateTime submittedDateTime)
APPLICATIONSTATUSEntry.SUBMITTED
.submittedDateTime
- The date time recorded when the application
transitioned into APPLICATIONSTATUSEntry.SUBMITTED
.void start(curam.workspaceservices.intake.impl.IntakeApplication intakeApplication) throws curam.util.exception.AppException, curam.util.exception.InformationalException
Application
based on the information extracted from the
related IntakeApplication
. The application will only be started if
a mapping between the two application types has been configured, otherwise
nothing is done. This method is normally invoked once the submission of
an IntakeApplication
has been recognized.
Starting an application in this manner will mean:
Application
to the integrated case associated with
the IntakeApplication
.ProgramApplication
s.IntakeApplicant
s.intakeApplication
- The IntakeApplication
for which this
application should gather its data from.curam.util.exception.AppException
curam.util.exception.InformationalException
long start(curam.codetable.impl.APPLICATIONTYPEEntry applicationType, java.util.List<curam.codetable.impl.PROGRAMTYPEEntry> programTypes, curam.participant.impl.ConcernRole concernRole) throws curam.util.exception.AppException, curam.util.exception.InformationalException
Application
based on the information supplied.
This involves the creation of:
ProgramApplication
s.IntakeApplicant
.applicationType
- The type of application to set up.programTypes
- A list
of program types to be associated
with the application.concernRole
- The concern role of the primary applicant.curam.util.exception.AppException
curam.util.exception.InformationalException
long startForCase(curam.codetable.impl.APPLICATIONTYPEEntry applicationType, java.util.List<curam.codetable.impl.PROGRAMTYPEEntry> programTypes, curam.participant.impl.ConcernRole concernRole, curam.piwrapper.caseheader.impl.CaseHeader caseHeader) throws curam.util.exception.AppException, curam.util.exception.InformationalException
Application
for a case based on the information
supplied. This involves the creation of:
ProgramApplication
s.IntakeApplicant
.applicationType
- The type of application to set up.programTypes
- A list
of program types to be associated
with the application.concernRole
- The concern role of the primary applicant.caseHeader
- The case for which the application should be associated
with.curam.util.exception.AppException
curam.util.exception.InformationalException
void submit() throws curam.util.exception.AppException, curam.util.exception.InformationalException
APPLICATIONSTATUSEntry.SUBMITTING
until the result of the attempted
submit is available.APPLICATIONSTATUSEntry.SUBMITTED
.APPLICATIONSTATUSEntry.SUBMIT_FAILED
.
A number of events are raised as part of the submit processing, reference
ApplicationEvents
for more detail on these events.
Note: The submission of an application can actually result in the
creation of other applications depending on its configuration.curam.util.exception.AppException
curam.util.exception.InformationalException
void submitForCase() throws curam.util.exception.AppException, curam.util.exception.InformationalException
APPLICATIONSTATUSEntry.SUBMITTED
.curam.util.exception.AppException
curam.util.exception.InformationalException
int getNumberOfDeadlineDays() throws curam.util.exception.AppException, curam.util.exception.InformationalException
curam.util.exception.AppException
curam.util.exception.InformationalException
ApplicationRoleObject getOwner()
void modifyOwner(java.lang.String username, curam.codetable.impl.APPLICATIONREASSIGNREASONEntry reason, java.lang.String comments) throws curam.util.exception.AppException, curam.util.exception.InformationalException
username
- The user's name whom will become the owner of the
application post modification.reason
- The APPLICATIONREASSIGNREASONEntry
why the change of ownership has
occurred.comments
- Comments relating to the application change of ownership.curam.util.exception.AppException
curam.util.exception.InformationalException
void modifyOwner(curam.codetable.impl.ORGOBJECTTYPEEntry type, java.lang.String orgObjectReference, curam.codetable.impl.APPLICATIONREASSIGNREASONEntry reason, java.lang.String comments) throws curam.util.exception.AppException, curam.util.exception.InformationalException
type
- The ORGOBJECTTYPEEntry
of the new owner.orgObjectReference
- The reference to the OrgObject
of the new owner.reason
- The APPLICATIONREASSIGNREASONEntry
why the change of ownership has
occurred.comments
- Comments relating to the application change of ownership.curam.util.exception.AppException
curam.util.exception.InformationalException
void insert(ApplicationRoleObject applicationRoleObject) throws curam.util.exception.AppException, curam.util.exception.InformationalException
ApplicationRoleObject
.applicationRoleObject
- The ApplicationRoleObject
to be assigned to the application.curam.util.exception.AppException
curam.util.exception.InformationalException
void dispose() throws curam.util.exception.InformationalException, curam.util.exception.AppException
APPLICATIONSTATUSEntry.DISPOSED
.curam.util.exception.InformationalException
curam.util.exception.AppException
ProgramApplication getProgramApplication(curam.codetable.impl.PROGRAMTYPEEntry programType, curam.codetable.impl.PROGRAMSTATUSEntry programStatus)
ProgramApplication
of the specified type with the status
on this
application, or null
if no application has been made for that
type of program.programType
- The type of program application being sought.null
if one doesn't exist.