curam.core.facade.intf

Interface Auditor

All Known Implementing Classes:

Auditor, curam.core.facade.impl.Auditor, AuditorFactory

@AccessLevel(value=EXTERNAL)
public interface Auditor

Method Summary

Modifier and Type	Method and Description
void	addToNewOrExistingAuditTeam(curam.core.facade.struct.NewOrExistingTeamDetails details) Allows and audit coordinator add a selected set of auditor users to a new or existing audit team on an audit plan.
curam.core.facade.struct.AuditorDetailsList	createAuditors(curam.core.facade.struct.CreateAuditorsDetails details) Method to add a list of users to an audit plan as auditors.
void	createAuditTeam(curam.core.facade.struct.CreateAuditTeamDetails details) Method to create an audit team for an audit plan.
curam.core.facade.struct.AuditorDetailsList	getAuditorsOnPlan(curam.caseaudit.entity.struct.AuditPlanKey key) Method to get all the auditors associated with a given audit plan.
curam.core.facade.struct.AuditTeamDetailsList	getAuditTeamsOnPlanList(curam.caseaudit.entity.struct.AuditPlanKey key) Searches the list of audit teams by specified search criteria.
curam.core.facade.struct.AuditorFilter	listAuditorAndTeams() Retrieves a list of auditor details for the current user and any teams they are a member of.
curam.core.facade.struct.UserSearchDetails	listSelectedAuditors(curam.core.facade.struct.CreateAuditorsDetails details) Retrieves a parsed list of users that have previously been selected as auditors for an audit plan.
void	modifyAuditTeam(curam.core.facade.struct.ModifyAuditTeamDetails details) Method to modify an audit team record.
curam.core.facade.struct.AuditorRemovalDetails	readAuditorForRemoval(curam.caseaudit.entity.struct.AuditorKey key) Method to read auditor details for display.
curam.core.facade.struct.AuditTeamDetails	readAuditTeam(curam.caseaudit.entity.struct.AuditorKey key) Method to view the details of an audit team.
void	removeAuditorFromPlan(curam.core.facade.struct.RemoveAuditorDetails details) Method to remove an auditor or audit team from an audit plan.
curam.core.facade.struct.AuditorHomePageName	resolveAuditorHomePage(curam.caseaudit.entity.struct.AuditorKey key) Method to resolve the auditor home page.
curam.core.facade.struct.AuditUserSearchDetails	searchExistingAuditorsOrCreateNewAuditor(curam.core.facade.struct.SearchOrCreateAuditorsDetails details) Method to search for users with an audit coordinator or auditor role and to also create auditors from the selected search results.

Method Detail

createAuditTeam

@AccessLevel(value=EXTERNAL)
void createAuditTeam(curam.core.facade.struct.CreateAuditTeamDetails details)
                                           throws curam.util.exception.AppException,
                                                  curam.util.exception.InformationalException

Method to create an audit team for an audit plan.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

modifyAuditTeam

@AccessLevel(value=EXTERNAL)
void modifyAuditTeam(curam.core.facade.struct.ModifyAuditTeamDetails details)
                                           throws curam.util.exception.AppException,
                                                  curam.util.exception.InformationalException

Method to modify an audit team record.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

removeAuditorFromPlan

@AccessLevel(value=EXTERNAL)
void removeAuditorFromPlan(curam.core.facade.struct.RemoveAuditorDetails details)
                                                 throws curam.util.exception.AppException,
                                                        curam.util.exception.InformationalException

Method to remove an auditor or audit team from an audit plan.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

createAuditors

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.AuditorDetailsList createAuditors(curam.core.facade.struct.CreateAuditorsDetails details)
                                                                                 throws curam.util.exception.AppException,
                                                                                        curam.util.exception.InformationalException

Method to add a list of users to an audit plan as auditors.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

getAuditorsOnPlan

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.AuditorDetailsList getAuditorsOnPlan(curam.caseaudit.entity.struct.AuditPlanKey key)
                                                                                    throws curam.util.exception.AppException,
                                                                                           curam.util.exception.InformationalException

Method to get all the auditors associated with a given audit plan.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listAuditorAndTeams

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.AuditorFilter listAuditorAndTeams()
                                                                                 throws curam.util.exception.AppException,
                                                                                        curam.util.exception.InformationalException

Retrieves a list of auditor details for the current user and any teams they are a member of. Called during processing when an auditor user selects to view a list of their assigned case audits.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readAuditorForRemoval

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.AuditorRemovalDetails readAuditorForRemoval(curam.caseaudit.entity.struct.AuditorKey key)
                                                                                           throws curam.util.exception.AppException,
                                                                                                  curam.util.exception.InformationalException

Method to read auditor details for display.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readAuditTeam

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.AuditTeamDetails readAuditTeam(curam.caseaudit.entity.struct.AuditorKey key)
                                                                              throws curam.util.exception.AppException,
                                                                                     curam.util.exception.InformationalException

Method to view the details of an audit team.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

resolveAuditorHomePage

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.AuditorHomePageName resolveAuditorHomePage(curam.caseaudit.entity.struct.AuditorKey key)
                                                                                          throws curam.util.exception.AppException,
                                                                                                 curam.util.exception.InformationalException

Method to resolve the auditor home page. This could be an auditor user or an audit team.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listSelectedAuditors

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.UserSearchDetails listSelectedAuditors(curam.core.facade.struct.CreateAuditorsDetails details)
                                                                                      throws curam.util.exception.AppException,
                                                                                             curam.util.exception.InformationalException

Retrieves a parsed list of users that have previously been selected as auditors for an audit plan. Called during processing when an audit coordinator is creating an audit team for a selected set of auditor users.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

addToNewOrExistingAuditTeam

@AccessLevel(value=EXTERNAL)
void addToNewOrExistingAuditTeam(curam.core.facade.struct.NewOrExistingTeamDetails details)
                                                       throws curam.util.exception.AppException,
                                                              curam.util.exception.InformationalException

Allows and audit coordinator add a selected set of auditor users to a new or existing audit team on an audit plan. Called during processing when an audit coordinator is configuring an audit plan.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

searchExistingAuditorsOrCreateNewAuditor

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.AuditUserSearchDetails searchExistingAuditorsOrCreateNewAuditor(curam.core.facade.struct.SearchOrCreateAuditorsDetails details)
                                                                                                               throws curam.util.exception.AppException,
                                                                                                                      curam.util.exception.InformationalException

Method to search for users with an audit coordinator or auditor role and to also create auditors from the selected search results.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

getAuditTeamsOnPlanList

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.AuditTeamDetailsList getAuditTeamsOnPlanList(curam.caseaudit.entity.struct.AuditPlanKey key)
                                                                                            throws curam.util.exception.AppException,
                                                                                                   curam.util.exception.InformationalException

Searches the list of audit teams by specified search criteria.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException