Organization (core)

All Known Implementing Classes:

Organization, curam.core.facade.impl.Organization, OrganizationFactory
```
@AccessLevel(value=EXTERNAL)
public interface Organization
```
This process class provides the functionality for the Organization facade.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`activateLocationStructure(curam.core.facade.struct.ActivateLocationStructureDetails dtls)` Method to activate the Location Structure, assigns an activation date to the Structure.
`void`	`activateOrganisationStructure(curam.core.facade.struct.ActivateOrgStructureKey activateOrgStructureKey)` Method to activate organization structure.
`curam.core.facade.struct.UserSearchDetailsResults`	`activeUserDetailsSearch(curam.core.facade.struct.UserSearchKey key)` Deprecated. Since Curam 6.0 SP2, replaced with `searchActiveUserDetails(UserSearchKey)`. This method is deprecated as informational messages are not returned. This method is replaced by searchActiveUserDetails(UserSearchKey) which returns the informational message along with user details as well. See release note: CS-09152/CR00282028.
`void`	`addCashExclusionDate(curam.core.facade.struct.AddExclusionDateKey key)` To add a Cash exclusion date to the FinancialCalendar.
`void`	`addChequeExclusionDate(curam.core.facade.struct.AddExclusionDateKey key)` To add a Check exclusion date to the FinancialCalendar.
`void`	`addChildUnit(curam.core.facade.struct.ChildOrganisationUnitDetails childOrganisationUnitDetails)` Method to create new child organization unit for organization unit.
`void`	`addDescriptionTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails localizableTextDetails)` This method is intended to be used by users responsible for creating text translations for Organisation description.
`void`	`addEFTExclusionDate(curam.core.facade.struct.AddExclusionDateKey key)` To add an EFT exclusion date to the FinancialCalendar.
`void`	`addInvoiceExclusionDate(curam.core.facade.struct.AddExclusionDateKey key)` To add an Invoice exclusion date to the FinancialCalendar.
`void`	`addNameTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails localizableTextDetails)` This method is intended to be used by users responsible for creating text translations for Organisation name.
`void`	`addQuickLinkForApplicationCode(curam.core.facade.struct.QuickLinkApplicationLinkDtls details)` Creates an association between a quick link and a user security role.
`void`	`addReportForUser(curam.core.facade.struct.ReportUserLinkDetails dtls)` Creates an association between a report and a user.
`void`	`addReportToSecurityRole(curam.core.facade.struct.ReportSecurityRoleLinkDetails details)` Creates an association between a report and a security role.
`void`	`addUserForPosition(curam.core.facade.struct.UserForPositionDetails userForPositionDetails)` Method to add user for specified position.
`void`	`addVoucherExclusionDate(curam.core.facade.struct.AddExclusionDateKey key)` To add a Voucher exclusion date to the FinancialCalendar.
`void`	`assignLocationAccess(curam.core.facade.struct.LocationAccessDetails details)` Assign additional location access
`void`	`assignLocationtoOrgUnit(curam.core.facade.struct.OrgUnitLocationDetails key)` Method used to assign a location to an organization unit.
`void`	`assignLocationToPosition(curam.core.facade.struct.PositionLocationDetails details)` This method assigns a location to a position
`void`	`assignResourceToLocation(curam.core.facade.struct.AssignResourceDetails details)` Assign Resource to Location
`void`	`assignResourceToOrgUnit(curam.core.facade.struct.AddOrgUnitResourceDetails key)` Presentation layer operation to assign a resource to a org unit
`void`	`cancelAdminIntegratedCase(curam.core.facade.struct.CancelAdminIntegratedCaseKey_fo key)` Cancels an Admin Integrated Case record.
`void`	`cancelAnnouncement(curam.core.sl.entity.struct.AnnouncementKey key)` This method will change the record status of an announcement from Active to Canceled.
`void`	`cancelBank(curam.core.facade.struct.CancelBankKey key)` This method will change the recordStatus of Bank from Active to Canceled
`void`	`cancelBankAccount(curam.core.facade.struct.CancelBankAccountKey key)` This method will change the recordStatus of OrgBankaccountLink from Active to Canceled
`void`	`cancelBankBranch(curam.core.facade.struct.CancelBankBranchKey key)` This method will change the recordStatus of BankBranch from Active to Canceled
`void`	`cancelCurrencyExchange(curam.core.facade.struct.CancelCurrencyExchangeKey key)` This method will change the recordStatus of Currency Exchange from Active to Canceled
`void`	`cancelDailySchedule(curam.core.facade.struct.CancelDailyScheduleDetails cancelDailyScheduleDetails)` Cancels a daily schedule record
`void`	`cancelExclusionDate(curam.core.facade.struct.CancelExclusionDateKey_fo key)` To remove an exclusion date from the FinancialCalendar for a particular delivery method.
`void`	`cancelInternalUser(curam.core.facade.struct.CancelUserKey key)` This method will change the recordStatus of User from Active to Canceled.
`void`	`cancelInvestigationApprovalCheckForOrgUnit(curam.core.facade.struct.CancelInvestigationApprovalCheckKey key)` This method allows an administrator to cancel an Investigation Approval Check for an org unit.
`void`	`cancelInvestigationApprovalCheckForUser(curam.core.facade.struct.CancelInvestigationApprovalCheckKey key)` This method allows an administrator to cancel an Investigation Approval Check for a user.
`void`	`cancelJob(curam.core.facade.struct.CancelJobKey cancelJobKey)` Cancels a job record.
`void`	`cancelLocation(curam.core.facade.struct.CancelLocationKey key)` This method will change the recordStatus of Admin Location from Active to Canceled.
`void`	`cancelLocationHoliday(curam.core.facade.struct.CancelLocationHolidayKey key)` Cancels an existing location holiday.
`void`	`cancelLocationStructure(curam.core.facade.struct.CancelLocationStructureDetails dtls)` Method to set the Status of the Location Structure to be Canceled.
`void`	`cancelLocationWorkingPattern(curam.core.struct.WorkingPatternKey workingPatternKey)` This method cancels the specified working pattern for the location.
`void`	`cancelOrganisationStructure(curam.core.facade.struct.CancelOrgStructureKey cancelOrgStructureKey)` Method to cancel organization structure.
`void`	`cancelOrganizationUnit(curam.core.facade.struct.CancelOrgUnitKey cancelOrgUnitKey)` Method to cancel organization unit.
`void`	`cancelOrganizationWorkingPattern(curam.core.facade.struct.CancelOrganizationWorkingPatternKey key)` Cancels a working pattern for an organization.
`void`	`cancelOrgUnitCaseApproval(curam.core.facade.struct.CancelOrgUnitCaseApprovalKey key)` This method will change the recordStatus of Case Approval Check from Active to Canceled
`void`	`cancelOrgUnitEvidenceApproval(curam.core.facade.struct.CancelOrgUnitEvidenceApprovalKey canceOrgUnitEvidenceApprovalKey)` Updates the recordStatus of the EvidenceApprovalCheck record to be canceled.
`void`	`cancelPositionByWorkflow(curam.core.facade.struct.CancelPositionByWorkFlowKey cancelPositionKey)` Cancels a position by enacting a workflow process.
`void`	`cancelPositionSlotavailability(curam.core.facade.struct.CancelPositionSlotAvailabilityDetails cancelPositionSlotAvailabilityDetails)` Cancels a position slot availability record.
`void`	`cancelQuickLink(curam.core.sl.entity.struct.QuickLinkKey key)` This method will change the record status of a quick link from Active to Canceled.
`void`	`cancelResolutionApprovalCheckForOrgUnit(curam.core.facade.struct.CancelIssueResolutionApprovalCheckKey key)` This method allows an administrator to cancel an Issue Resolution Approval Check for an org unit.
`void`	`cancelResolutionApprovalCheckForUser(curam.core.facade.struct.CancelIssueResolutionApprovalCheckKey cancelIssueResolutionApprovalCheckKey)` This method allows an administrator to cancel an Issue Resolution Approval Check for a user.
`void`	`cancelResource(curam.core.facade.struct.CancelResourceKey key)` This method will change the recordStatus of Resources Record from Active to Canceled.
`void`	`cancelSlotDetails(curam.core.facade.struct.CancelSlotDetails cancelSlotDetails)` Cancels a slot record
`void`	`cancelTemporalEvidenceApprovalCheck(curam.core.facade.struct.TemporalEvidenceApprovalCheckKey key, curam.core.facade.struct.ModifyTemporalEvidenceApprovalCheck details)` Cancel an approval check for a single evidence type.
`void`	`cancelUser(curam.core.facade.struct.CancelUserKey key)` This method will change the recordStatus of Users from Active to Canceled.
`void`	`cancelUserCaseApproval(curam.core.facade.struct.CancelUserCaseApprovalKey key)` This method will change the recordStatus of Case Approval Check from Active to Canceled
`void`	`cancelUserEvidenceApproval(curam.core.facade.struct.CancelUserEvidenceApprovalKey cancelUserEvidenceApprovalKey)` Updates the recordStatus of the EvidenceApprovalCheck record to be canceled.
`void`	`cancelUserSkillDetails(curam.core.facade.struct.CancelUserSkillDetails cancelUserSkillDetails)` Deprecated. Since Curam 6.0.5.0, replaced with `#cancelUserSkillsDetails(UserLanguageSkillCreationDetails)` This method is deprecated because of the new requirement where informational has to be return when the redetermination of translator required runs on batch. See release note: CR00341851.
`curam.core.struct.InformationalMsgDtlsList`	`cancelUserSkillsDetails(curam.core.facade.struct.CancelUserSkillDetails kkey)` Cancels a user skill record.
`void`	`cancelUserWorkingPattern(curam.core.facade.struct.CancelUserWorkingPatternKey key)` Cancels a working pattern for a user.
`void`	`clearTaskRedirectionForUser(curam.core.sl.struct.ClearTaskRedirectionDetails key)` Clears an active or pending task redirection record.
`void`	`cloneOrganisationStructure(curam.core.facade.struct.CloneOrgStructureKey cloneOrgStructureKey)` Method to clone organization structure.
`curam.core.struct.InformationalMsgDtlsList`	`closeOrganizationUser(curam.core.facade.struct.CloseOrganizationUserDetails details)` The function of this method is to close the user account on the system.
`curam.core.sl.struct.RecordCount`	`countApplicationReferenceRecord(curam.core.facade.struct.ApplicationSearchKey key)` Allows User to count number of record matching reference across all defined Appplication Objects e.g.
`void`	`createAdminIntegratedCase1(curam.core.facade.struct.CreateAdminIntegratedCaseDetails1 details)` Creates an Admin Integrated Case record.
`void`	`createAndAddQuickLinkToApplicationCode(curam.core.facade.struct.QuickLinkDetails details)` Creates a new quick link record and associates it with a security role.
`void`	`createAndAssignUserForPosition(curam.core.facade.struct.CreateAndAssignUserForPosition details)` Method to create a user and assign them to an existing position.
`void`	`createAnnouncement(curam.core.facade.struct.AnnouncementDtls details)` This method allows an administrator to configure an organization wide announcement.
`void`	`createBank(curam.core.facade.struct.MaintainBankDetails details)` Insert a new bank
`void`	`createBankAccountWithTextSortCode(curam.core.facade.struct.MaintainBankAccountWithTextSortCodeDetails details)` Inserts a new Bank Account for an Organization.
`void`	`createBankBranch(curam.core.facade.struct.MaintainBankBranchDetails details)` Inserts a new bank branch.
`void`	`createCurrencyExchange(curam.core.facade.struct.MaintainCurrencyExchangeDetails details)` Inserts a new Currency Exchange for an Organization.
`curam.core.facade.struct.CreateDailyScheduleReturnKey`	`createDailySchedule(curam.core.facade.struct.DailyScheduleCreateDetails dailyScheduleCreateDetails)` Create a daily schedule record.
`void`	`createInvestigationApprovalCheckForOrgUnit(curam.core.facade.struct.InvestigationApprovalCheckDetails details)` Allows an administrator to configure an approval check for an org unit.
`void`	`createInvestigationApprovalCheckForUser(curam.core.facade.struct.InvestigationApprovalCheckDetails details)` This method allows an administrator to configure an approval check for a user.
`void`	`createJob(curam.core.facade.struct.JobDetails jobDetails)` Method to create new job.
`void`	`createLocation(curam.core.facade.struct.MaintainLocationDetails details)` Adds a location record to the database.
`curam.core.facade.struct.CreateLocationHolidayDetails`	`createLocationHoliday(curam.core.facade.struct.MaintainLocationHolidayDetails details)` Creates a new location holiday for the specified location on the specified date.
`void`	`createLocationResource(curam.core.facade.struct.ResourceLocationDetails details)` Creates a location resource
`void`	`createLocationStructure(curam.core.facade.struct.CreateLocationStructureDetails dtls)` Method to save the Location Structure details.
`void`	`createLocationWorkingPattern(curam.core.struct.WorkingPatternDetails details)` This method creates a new working pattern for the location.
`void`	`createModifyOrganizationNonStandardWorkingPattern(curam.core.facade.struct.MaintainNonStandardWorkingPatternDetails details)` Create/modifies a non standard working pattern for an organization.
`void`	`createModifyUserNonStandardWorkingPattern(curam.core.facade.struct.MaintainNonStandardWorkingPatternDetails details)` Create/modifies a non standard working pattern for a user.
`void`	`createOrganisationStructure(curam.core.facade.struct.OrganisationStructureDetails organisationStructureDetails)` Method to create new organization structure.
`void`	`createOrganisationUnit(curam.core.facade.struct.OrganisationUnitDetails organisationUnitDetails)` Method to create new organization unit.
`void`	`createOrganisationUnitResource(curam.core.facade.struct.ResourceOrganisationUnitDetail details)` Method to create a resource for an organization unit.
`void`	`createOrganizationWorkingPattern(curam.core.facade.struct.CreateOrganizationWorkingPatternDetails details)` Creates a working pattern for an organization.
`void`	`createOrgUnitCaseApproval(curam.core.facade.struct.CaseApprovalCheckDetails details)` Adds case approval check information for an organization unit.
`void`	`createOrgUnitEvidenceApproval(curam.core.facade.struct.EvidenceApprovalCheckDetails evidenceApprovalCheckDetails)` Adds evidence approval check information for an organization unit.
`void`	`createPosition(curam.core.facade.struct.CreatePositionDetails createPositionDetails)` Method to create new position.
`curam.core.facade.struct.CreatePositionSlotAvailabilityReturnKey`	`createPositionSlotAvailability(curam.core.facade.struct.PositionSlotAvailabilityCreateDetails positionSlotAvailabilityCreateDetails)` Inserts a position slot availability record.
`void`	`createQuickLink(curam.core.facade.struct.QuickLinkDetails details)` Creates a quick link for the organization.
`void`	`createResolutionApprovalCheckForOrgUnit(curam.core.facade.struct.IssueResolutionApprovalCheckDetails details)` This method allows an administrator to configure an approval check for an org unit.
`void`	`createResolutionApprovalCheckForUser(curam.core.facade.struct.IssueResolutionApprovalCheckDetails issueResolutionApprovalCheckDetails)` This method allows an administrator to configure an approval check for a user.
`void`	`createResource(curam.core.facade.struct.MaintainResourceDetails details)` Adds a new resource.
`void`	`createRootLocation(curam.core.facade.struct.MaintainLocationDetails details)` Create a Root Location for a Location Structure
`void`	`createRootUnit(curam.core.facade.struct.RootOrganisationUnitDetails rootOrganisationUnitDetails)` Method to create new root organization unit for organization structure.
`curam.core.facade.struct.CreateSlotReturnKey`	`createSlot(curam.core.facade.struct.SlotCreateDetails slotCreateDetails)` Create a slot record
`void`	`createTemporalEvidenceApprovalCheck(curam.core.facade.struct.CreateTemporalEvidenceApprovalCheck dtls)` Create an approval check for a single evidence type.
`void`	`createUser(curam.core.facade.struct.CreateUserDetails details)` Inserts a new user.
`void`	`createUserCaseApproval(curam.core.facade.struct.CaseApprovalCheckDetails details)` Adds case approval check information for a user.
`void`	`createUserEvidenceApproval(curam.core.facade.struct.EvidenceApprovalCheckDetails evidenceApprovalCheckDetails)` Adds evidence approval check information for a user.
`void`	`createUserSkill(curam.core.facade.struct.UserSkillCreateDetails userSkillCreateDetails)` Creates a user skill
`void`	`createUserSkillLanguages(curam.core.facade.struct.UserLanguageSkillCreationDetails key)` Deprecated. Since Curam 6.0.5.0, replaced with `createUserSkillsLanguages(UserLanguageSkillCreationDetails)` This method is deprecated because of the new requirement where informational has to be return when the redetermination of translator required runs on batch. See release note: CR00341851.
`curam.core.struct.InformationalMsgDtlsList`	`createUserSkillsLanguages(curam.core.facade.struct.UserLanguageSkillCreationDetails key)` This method is to create user skill language details.
`void`	`createUserWorkingPattern(curam.core.facade.struct.CreateUserWorkingPatternDetails details)` Creates a working pattern for a user.
`void`	`disableUser(curam.core.facade.struct.UserStatusDetails_fo userStatusDetails)` This method disables a user.
`void`	`enableUser(curam.core.facade.struct.UserStatusDetails_fo userStatusDetails)` This method enables a user.
`curam.core.facade.struct.AnnouncementsXML`	`getAnnouncementsAsXML()` Return the set of Announcements that fall in the current time frame as a String formatted in XML.
`curam.core.sl.struct.UserNameAndFullName`	`getCurrentUser()` Method to get current user details.
`curam.core.facade.struct.IntegratedCaseDefaultValuesDetails`	`getIntegratedCaseDefaultValues()` Returns default details to create new integrated case.
`curam.core.facade.struct.ReadXMLDetails`	`getLocationStructureTreeXML(curam.core.facade.struct.LocStructureAndLocKey key)` Method to return an xml string representing a location structure.
`curam.core.facade.struct.ReadXMLDetails`	`getOrganisationStructureTreeXML(curam.core.sl.struct.OrgStructureOrgUnitPositionKey key)` Method to return an xml string representing an organization structure.
`curam.core.facade.struct.OrganisationUnitContactDetails`	`getOrganisationUnitContactInformation(curam.core.facade.struct.OrgStructureAndOrgUnitKey key)` Method to return contact information for specified organization unit.
`curam.core.facade.struct.OrgStructureBreadCrumbDetails`	`getOrgStructureBreadCrumb(curam.core.facade.struct.OrgStructureBrowserKey orgStructureBrowserKey)` Returns bread crumb menu data for an organization unit.
`curam.core.facade.struct.OrgUnitBreadCrumbDetails`	`getOrgUnitBreadCrumb(curam.core.facade.struct.OrgUnitBrowserKey orgUnitBrowserKey)` Returns bread crumb menu data for an organization unit.
`curam.core.facade.struct.OrgStructureBreadCrumbDetails`	`getPositionBreadCrumb(curam.core.facade.struct.OrgStructureBrowserKey orgStructureBrowserKey)` Returns bread crumb menu data for a position
`curam.core.sl.supervisor.struct.TaskRedirectionsFromUserDetails`	`getTaskRedirectionHistoryForUser(curam.core.struct.UserNameKey key)` Returns a list of the task redirection records for a specified user.
`curam.core.facade.struct.UserApplicationHome`	`getUserApplicationHome()` Method to determine the Application home page (internal) using their user access name.
`curam.core.facade.struct.UserSkills`	`getUserSkills(curam.core.facade.struct.UserSkillListKey userSkillListKey)` Reads the user skills for a user.
`curam.core.sl.struct.UserType`	`getUserType(curam.core.struct.UsersKey key)` Method to determine the type of a user (internal or external) using their user access name.
`curam.core.facade.struct.BankBranchSearchResolver`	`isBankBranchSearchenabled()` Method to find if the bank branch search is enabled.
`curam.core.facade.struct.LocationSearchResolver`	`isLocationSearchenabled()` Method to find if the location search is enabled.
`curam.core.facade.struct.OrganisationUnitSearchInd`	`isOrganisationUnitSearchEnabled()` Method to find if the organization unit search is enabled.
`curam.core.facade.struct.PositionSearchResolver`	`isPositionSearchenabled()` Method to find if the position search is enabled.
`curam.core.facade.struct.CloseUserInd`	`isUserClosed(curam.core.struct.UserNameKey key)` Method to find whether the user is closed or not.
`curam.core.facade.struct.ListActiveAdminIntegratedCaseDetails`	`listActiveAdminIntegratedCase()` Returns a list of active Admin Integrated Case records.
`curam.core.facade.struct.ListPositionForOrgUnitDetails`	`listActiveLeadPositionForOrgUnit(curam.core.facade.struct.OrgStructureAndOrgUnitKey key)` Method to return all active lead positions for specified organization unit.
`curam.core.facade.struct.ListActiveLocationDetails`	`listActiveLocations(curam.core.facade.struct.LocationSearchKey key)` Search active locations by type
`curam.core.facade.struct.ListActiveLocationDetails`	`listActiveLocationsForOrg(curam.core.facade.struct.OrgLocationSearchKey key)` Search all active and operating locations for organization units
`curam.core.facade.struct.ListPositionForOrgUnitDetails`	`listActivePositionForOrgUnit(curam.core.facade.struct.OrgStructureAndOrgUnitKey key)` Method to return all active positions for specified organization unit.
`curam.core.facade.struct.ListAllAdminIntegratedCaseDetails`	`listAllAdminIntegratedCase()` Returns a list of all Admin Integrated Case records.
`curam.core.facade.struct.ICEvidenceTypeDetailsList`	`listAllEvidenceTypesByAdminIntegratedCaseID(curam.core.struct.AdminIntegratedCaseKey key)` Retrieves evidence types associated with a specified admin integrated case, both static and dynamic
`curam.core.facade.struct.AdminIntegratedCaseTypes`	`listAllIntegratedCaseTypes()` Method to list all integrated case types.
`curam.core.facade.struct.ListOrganisationUnitDetails`	`listAllOrgUnit()` Method to return all organization units.
`curam.core.facade.struct.ReportDetailsList`	`listAllReports()` This method lists all the reports recorded for the organization.
`curam.core.facade.struct.ReadSecurityRolesList`	`listAllSecurityRoles()` This method returns a list of users within the organization.
`curam.core.facade.struct.ListUserForPositionDetails`	`listAllUsersForPosition(curam.core.facade.struct.OrgStructureAndPositionKey key)` Method to return a list of users assigned to a position in the organization.
`curam.core.facade.struct.AnnouncementDtlsList`	`listAnnouncements()` Method to allow an administrator to list all active and cancelled announcements configured for the organization.
`curam.core.sl.struct.ApplicationCodeDetailsList`	`listApplicationCode()` Lists application codetable values.
`curam.core.facade.struct.InvestigationConfigurationTypeDetailsList`	`listAvailableInvestigationsForApprovalCheck()` Lists all investigations that are available to be selected for Investigation Resolution approval checks.
`curam.core.facade.struct.IssueConfigurationTypeDetailsList`	`listAvailableIssuesForApprovalCheck()` Lists all issues that are available to be selected for Issue Resolution approval checks.
`curam.core.facade.struct.ListBankDetails`	`listBank()` Lists all banks
`curam.core.facade.struct.ListBankAccountDetails`	`listBankAccount()` Returns a list of Public Offices for the specified Organization.
`curam.core.facade.struct.ListBankBranchDetails`	`listBankBranch(curam.core.facade.struct.ListBankBranchKey key)` Lists all Branches for the specified bank.
`curam.core.facade.struct.ReadBankBranchNameBankNameDtlsList`	`listBankBranchNameBankName(curam.core.facade.struct.ReadBankBranchNameBankNameKey key)` Method to return a list of bank branches with a normal status given a sort code.
`curam.core.facade.struct.ListChildLocationsDetails`	`listChildLocations(curam.core.facade.struct.ListChildLocationsKey key)` Method to return a list of child locations give the parent location.
`curam.core.facade.struct.ListOrganisationUnitForOrgUnitWithVersionNoDetails`	`listChildUnitForOrgUnitWithVersionNo(curam.core.facade.struct.OrgStructureAndOrgUnitKey key)` Method to return all child organization units for specified organization unit.
`curam.core.facade.struct.ListCurrencyExchangeDetails`	`listCurrencyExchange()` This process will read a currency exchange rate on a specified date
`curam.core.facade.struct.ListCurrencyExchangeDetails`	`listCurrencyExchangeByDates(curam.core.struct.OrgCurrencyExchangeSearchKey key)` Method to return a history of all currency exchange rates recorded on the system given a date range.
`curam.core.facade.struct.ListCurrencyExchangeHistoryDetails`	`listCurrencyExchangeHistory(curam.core.facade.struct.ListCurrencyExchangeHistoryKey_fo key)` This operation will read the history of currency exchange rates for a selected currency.
`curam.core.facade.struct.ListDailyScheduleDetails`	`listDailySchedule(curam.core.facade.struct.DailyScheduleListKey dailyScheduleListKey)` Lists Daily Schedule records for a location.
`curam.core.sl.infrastructure.entity.struct.EvidenceTypeList`	`listEvidenceTypes()` Method to return a list of evidence types registered with the system.
`curam.core.facade.struct.ListOrgUnitInvestigationApprovalCheckDetails`	`listInvestigationApprovalCheckForOrgUnit(curam.core.facade.struct.ListOrgUnitInvestigationApprovalCheckKey key)` This method lists all existing approval checks for an org unit.
`curam.core.facade.struct.ListUserInvestigationApprovalCheckDetails`	`listInvestigationApprovalCheckForUser(curam.core.facade.struct.ListUserInvestigationApprovalCheckKey key)` This method lists all existing approval checks for a user.
`curam.core.facade.struct.ListJobForOrgUnitWithVersionNoDetails`	`listJobForOrgUnitWithVersionNo(curam.core.facade.struct.OrgStructureAndOrgUnitKey key)` Method to return all jobs for specified organization unit.
`curam.core.facade.struct.ListJobWithVersionNoDetails`	`listJobWithVersionNo()` Method to return all jobs.
`curam.core.facade.struct.ListPositionForOrgStructureDetails`	`listLeadPositionForOrgStructure(curam.core.facade.struct.OrganisationStructureKey key)` Method to return all lead positions for specified organization structure.
`curam.core.facade.struct.ListPositionForOrgUnitDetails`	`listLeadPositionForOrgUnit(curam.core.facade.struct.OrgStructureAndOrgUnitKey key)` Method to return all lead positions for specified organization unit.
`curam.core.facade.struct.ListUserForOrgStructureDetails`	`listLeadUserForOrgStructure(curam.core.facade.struct.OrganisationStructureKey key)` Method to return all lead users for specified organization structure.
`curam.core.facade.struct.ListUserForOrgUnitDetails`	`listLeadUserForOrgUnit(curam.core.facade.struct.OrgStructureAndOrgUnitKey key)` Method to return all lead users for specified organization unit.
`curam.workspaceservices.facade.struct.ViewLocalizableTextDetails`	`listLocalizableDescriptionText(curam.workspaceservices.facade.struct.LocalizableTextDetails localizableTextDetails)` This method is intended to be used by users for listing the text translations for the Organisation attribute, description.
`curam.workspaceservices.facade.struct.ViewLocalizableTextDetails`	`listLocalizableNameText(curam.workspaceservices.facade.struct.LocalizableTextDetails localizableTextDetails)` This method is intended to be used by users for listing the text translations for the Organisation attribute, name.
`curam.core.facade.struct.ReadOrganizationLocationList`	`listLocation()` Returns a list of locations for the organization.
`curam.core.facade.struct.ListLocationHolidayDetails`	`listLocationHoliday(curam.core.facade.struct.ListLocationHolidayKey key)` Retrieves summary information for all holidays for the specified location, not including parent locations.
`curam.core.facade.struct.ReadLocationListForLocationStructure`	`listLocationsForLocationStructure(curam.core.facade.struct.LocationStructureKey key)` Returns a list of locations for the location structure.
`curam.core.facade.struct.SecurityIDList`	`listLocationSIDs()` Method to return a list of defined Security ID's for locations.
`curam.core.facade.struct.ListLocationStructureDetails`	`listLocationStructure(curam.core.struct.OrganisationKey key)` Method to list the location structure details.
`curam.core.facade.struct.ListLocationWorkingPatternDetails`	`listLocationWorkingPattern(curam.core.struct.LocationKey locationKey)` This method lists all of the working patterns for a specified location.
`curam.core.facade.struct.ListOrganisationStructureDetails1`	`listOrganisationStructure1()` Method to return all organization structures.
`curam.core.facade.struct.ListLocationForOrganisationUnit`	`listOrganisationUnitLocation(curam.core.facade.struct.OrgStructureAndOrgUnitKey key)` Method to return organization unit location details.
`curam.core.facade.struct.SecurityIDList`	`listOrganizationSIDs()` Method to return a list of defined Security ID's for the organization.
`curam.core.facade.struct.ListOrganizationWorkingPatternDetails`	`listOrganizationWorkingPattern()` Returns a list of working pattern for an organization
`curam.core.facade.struct.OrgStructureChildElementDetails`	`listOrgStructureChildElements(curam.core.facade.struct.OrgStructureBrowserKey orgStructureBrowserKey)` Lists child organization units and positions for an organization unit
`curam.core.facade.struct.ListOrgUnitCaseApprovalDetails`	`listOrgUnitCaseApproval(curam.core.facade.struct.ListOrgUnitCaseApprovalKey key)` Retrieves the case approval check information for the specified organization unit.
`curam.core.facade.struct.ListOrgUnitEvidenceApprovalDetails`	`listOrgUnitEvidenceApproval(curam.core.facade.struct.ListOrgUnitEvidenceApprovalKey listOrgUnitEvidenceApprovalKey)` Retrieves the evidence approval check information for the specified organization unit.
`curam.core.facade.struct.ListOrganisationUnitForOrgStructureWithVersionNoDetails`	`listOrgUnitForOrgStructureWithVersionNo(curam.core.facade.struct.OrganisationStructureKey key)` Method to return all organization units for specified organization structure.
`curam.core.facade.struct.ListOrgUnitDetailsForUser`	`listOrgUnitsForUser()` Returns a list of organization units for which the user is a member.
`curam.core.facade.struct.ListPositionForJobDetails`	`listPositionForJob(curam.core.facade.struct.JobKey key)` Method to return all positions for specified job.
`curam.core.facade.struct.ListPositionForOrgStructureDetails`	`listPositionForOrgStructure(curam.core.facade.struct.OrganisationStructureKey key)` Method to return all positions for specified organization structure.
`curam.core.facade.struct.ListPositionForOrgUnitDetails`	`listPositionForOrgUnit(curam.core.facade.struct.OrgStructureAndOrgUnitKey key)` Method to return all positions for specified organization unit.
`curam.core.facade.struct.ListPositionDetailsForUser`	`listPositionsForUser()` Returns a list of positions for which the user is a member.
`curam.core.facade.struct.ListPositionSlotAvailabilityDetails`	`listPositionSlotAvailability(curam.core.facade.struct.PositionSlotAvailabilityListKey positionSlotAvailabilityListKey)` Lists all position slot availability records.
`curam.core.facade.struct.listPrintersDetails`	`listPrinters()` This method lists all printers for the Organization.
`curam.core.facade.struct.ReadPrintersForOrgUnitDetails`	`listPrintersForOrgUnit(curam.core.facade.struct.ReadPrintersForOrgUnitKey key)` Returns a list of resources of printer type for a specified org unit
`curam.core.facade.struct.ReadOrganizationPublicOfficeList`	`listPublicOffice()` Returns a list of public offices for the organization.
`curam.core.facade.struct.QuickLinkApplicationDetailsList`	`listQuickLinkForApplicationCode(curam.core.sl.entity.struct.ApplicationCodeKey key)` Retrieves the list of quick links associated with the specified user security role.
`curam.core.facade.struct.QuickLinkDetailsList`	`listQuickLinks()` This method lists all the quick links recorded for the organization.
`curam.core.facade.struct.RecentlyApprovedCaseDetailsList`	`listRecentApprovedCasesForUserSubmittedOrOwned()` Lists recently approved integrated and product delivery cases submitted by current user or currently owned by current user or current user organization object.
`curam.core.facade.struct.RecentlyApprovedInvestigationDetailsList`	`listRecentApprovedInvestigationForUserSubmittedOrOwned()` Lists recently approved investigations submitted by current user or currently owned by current user or current user organization object.
`curam.core.facade.struct.RecentlyAssignedCaseDetailsList`	`listRecentAssignedCasesForUserCurrentlyOwned()` Lists recently assigned integrated and product delivery cases to a user currently owned by current user or current user organization object.
`curam.core.facade.struct.RecentlyAssignedInvestigationDetailsList`	`listRecentAssignedInvestigationForUserCurrentlyOwned()` Lists recently assigned investigations to a user currently owned by current user or current user organization object.
`curam.core.facade.struct.RecentlyViewedCaseDetailsList`	`listRecentViewedCasesForUser1()` Lists integrated and product delivery cases recently viewed by a user.
`curam.core.facade.struct.RecentlyViewedInvestigationDetailsList`	`listRecentViewedInvestigationForUser()` Lists investigations recently viewed by a user.
`curam.core.facade.struct.ReportSecurityRoleDetailsList`	`listReportForSecurityRole(curam.core.sl.entity.struct.RoleNameKey key)` Retrieves the list of reports associated with the specified security role.
`curam.core.facade.struct.ReportUserDetailsList`	`listReportForUser(curam.core.sl.entity.struct.UserKey key)` Retrieves the list of reports associated with the specified user.
`curam.core.facade.struct.ListOrgUnitResolutionApprovalCheckDetails`	`listResolutionApprovalCheckForOrgUnit(curam.core.facade.struct.ListOrgUnitResolutionApprovalCheckKey key)` Deprecated. Since Curam 6.0.5.0, replaced with listResolutionApprovalCheckForOrgUnitAndVersionNo() This method is being deprecated as the return struct does not have versionNo attribute. This method lists all existing approval checks for an org unit.
`curam.core.facade.struct.ListOrgUnitResolutionApprovalCheckDetailsAndVersionNo`	`listResolutionApprovalCheckForOrgUnitAndVersionNo(curam.core.facade.struct.ListOrgUnitResolutionApprovalCheckKey key)` This method lists all existing approval checks for an org unit.
`curam.core.facade.struct.ListUserResolutionApprovalCheckDetails`	`listResolutionApprovalCheckForUser(curam.core.facade.struct.ListUserResolutionApprovalCheckKey listUserResolutionApprovalCheckKey)` Deprecated. Since Curam 6.0.5.0, replaced with listResolutionApprovalCheckForUserAndVersionNo(). This method is being deprecated as the return struct does not have versionNo attribute. This method lists all existing approval checks for a user.
`curam.core.facade.struct.ListUserResolutionApprovalCheckDetailsAndVersionNo`	`listResolutionApprovalCheckForUserAndVersionNo(curam.core.facade.struct.ListUserResolutionApprovalCheckKey listUserResolutionApprovalCheckKey)` This method lists all existing approval checks for a user.
`curam.core.facade.struct.ReadResourceList`	`listResource()` Return a list of all resource details.
`curam.core.facade.struct.ListResourcesForLocationDetails`	`listResourcesForLocation(curam.core.facade.struct.ListResourcesForLocationKey key)` Presentation layer operation to list resources for a location.
`curam.core.facade.struct.ListResourcesForOrgUnitDetails`	`listResourcesForOrgUnit(curam.core.facade.struct.ListResourcesForOrgUnitKey key)` Presentation layer operation to list resources for a org unit
`curam.core.facade.struct.ListResourcesInOperationDetails`	`listResourcesInOperation()` Presentation layer operation to list all available resources.
`curam.core.facade.struct.ListSlotDetails`	`listSlot(curam.core.facade.struct.SlotListKey slotListKey)` Lists slot records for a daily schedule.
`curam.core.facade.struct.ListPositionForPositionDetails`	`listSubordinatePositionForPosition(curam.core.facade.struct.OrgStructureAndPositionKey key)` Method to return all subordinate positions for specified position.
`curam.core.facade.struct.ListOrgUnitUserDetails`	`listSubordinateUserForPosition(curam.core.facade.struct.OrgStructureAndPositionKey key)` Method to return all subordinate users for specified position.
`curam.core.facade.struct.ListUserForPositionDetails`	`listSupervisorUserForPosition(curam.core.facade.struct.OrgStructureAndPositionKey key)` Method to return all supervisor users for specified position.
`curam.core.facade.struct.TemporalEvidenceApprovalCheckList`	`listTemporalEvidenceApprovalCheckByOrgUnit(curam.core.sl.entity.struct.SearchByOrgUnitKey key)` Method to list evidence approval checks for a an organization unit.
`curam.core.facade.struct.TemporalEvidenceApprovalCheckList`	`listTemporalEvidenceApprovalCheckByPosition(curam.core.sl.infrastructure.entity.struct.SearchByPositionKey key)` Method to list evidence approval checks for a position.
`curam.core.facade.struct.TemporalEvidenceApprovalCheckList`	`listTemporalEvidenceApprovalCheckByUser(curam.core.sl.entity.struct.SearchByUserKey key)` Method to list evidence approval checks for a a system user.
`curam.core.facade.struct.QuickLinkDetailsList`	`listUnassociatedQuickLinks(curam.core.sl.entity.struct.ApplicationCodeKey key)` Lists quick links which have not yet been associated with the specified user security role.
`curam.core.facade.struct.ReportDetailsList`	`listUnassociatedReportForSecurityRole(curam.core.sl.entity.struct.RoleNameKey key)` Lists reports which have not yet been associated with the specified security role.
`curam.core.facade.struct.ReportDetailsList`	`listUnassociatedReportForUser(curam.core.sl.entity.struct.UserKey key)` Lists reports which have not yet been associated with the specified user.
`curam.core.facade.struct.ListUserCaseApprovalDetails`	`listUserCaseApproval(curam.core.facade.struct.ListUserCaseApprovalKey key)` Retrieves the case approval check information for the specified User.
`curam.core.facade.struct.ListUserEvidenceApprovalDetails`	`listUserEvidenceApproval(curam.core.facade.struct.ListUserEvidenceApprovalKey listUserEvidenceApprovalKey)` Retrieves the evidence approval check information for the specified user.
`curam.core.facade.struct.ListUserForOrganisationDetails`	`listUserForOrganisation()` Method to return all users for organization structure.
`curam.core.facade.struct.ListUserForOrgStructureDetails`	`listUserForOrgStructure(curam.core.facade.struct.OrganisationStructureKey organisationStructureKey)` Method to return all users for specified organization structure.
`curam.core.facade.struct.ListUserForOrgUnitDetails`	`listUserForOrgUnit(curam.core.facade.struct.OrgStructureAndOrgUnitKey key)` Method to return all users for specified organization unit.
`curam.core.facade.struct.ListUserForPositionDetails`	`listUserForPosition(curam.core.facade.struct.OrgStructureAndPositionKey key)` Method to return all users for specified position.
`curam.core.facade.struct.ListUserSkillDetails`	`listUserSkill(curam.core.facade.struct.UserSkillListKey userSkillListKey)` Deprecated. Since Curam 6.0.4.0, replaced with `getUserSkills(UserSkillListKey)`. This method is being deprecated as the return struct does not have an attribute to identify the language skill type. See release note: CR00322668/CEF-9913.
`curam.core.facade.struct.ListUserWorkingPatternDetails`	`listUserWorkingPattern(curam.core.facade.struct.ListUserWorkingPatternKey key)` Returns a list of working patterns for a user.
`curam.core.facade.struct.ListPositionForOrgStructureDetails`	`listVacantPositionForOrgStructure(curam.core.facade.struct.OrganisationStructureKey key)` Method to return all vacant positions for specified organization structure.
`curam.core.facade.struct.ListPositionForOrgUnitDetails`	`listVacantPositionForOrgUnit(curam.core.facade.struct.OrgStructureAndOrgUnitKey key)` Method to return all vacant positions for specified organization unit.
`void`	`maintainLocationNonStandardWorkingPattern(curam.core.facade.struct.MaintainNonStandardWorkingPatternDetails details)` This method creates or modifies a non-standard working pattern or changes the pattern type for the day for a location.
`void`	`modifyAdminIntegratedCase1(curam.core.facade.struct.ModifyAdminIntegratedCaseDetails1 details)` Modifies details of an Admin Integrated Case record.
`void`	`modifyAdminIntegratedCaseIndicators(curam.core.struct.AdminIntegratedCaseKey adminIntegratedCaseKey, curam.core.struct.AdminIntegratedCaseTypeIndicators adminIntegratedCaseTypeIndicators)` Modifies the AdminIntegrated Case Type, Ownership Strategy and other Indicators.
`void`	`modifyAnnouncement(curam.core.facade.struct.AnnouncementDtls details)` Method to allow an administrator to modify the details of a specified announcement that has been configured for the organization.
`void`	`modifyBank(curam.core.facade.struct.MaintainBankDetails details)` Modify an existing Bank
`void`	`modifyBankAccountWithTextSortCode(curam.core.facade.struct.MaintainBankAccountWithTextSortCodeDetails details)` Modifies Bank Account details
`void`	`modifyBankBranch(curam.core.facade.struct.MaintainBankBranchDetails details)` Modifies an existing branch.
`void`	`modifyCurrencyExchange(curam.core.facade.struct.MaintainCurrencyExchangeDetails details)` Modifies Currency Exchange details
`void`	`modifyDailySchedule(curam.core.facade.struct.DailyScheduleModifyDetails dailyScheduleModifyDetails)` Modifies the details of a daily schedule record.
`void`	`modifyDescriptionTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails localizableTextDetails)` This method is intended to be used by users responsible for modifying the text translations for the Organisation attribute, description.
`void`	`modifyInvestigationApprovalCheckForOrgUnit(curam.core.facade.struct.InvestigationApprovalCheckDetails details)` This method allows an administrator to modify an Investigation Approval Check for an org unit.
`void`	`modifyInvestigationApprovalCheckForUser(curam.core.facade.struct.InvestigationApprovalCheckDetails details)` This method allows an administrator to modify an Investigation Approval Check for a user.
`void`	`modifyJob(curam.core.facade.struct.ModifyJobDetails modifyJobDetails)` Method to update job details.
`void`	`modifyLocation(curam.core.facade.struct.MaintainLocationDetails details)` Updates location details for the specified location.
`curam.core.struct.UpdatedLocationHolidayIDDetails`	`modifyLocationHoliday(curam.core.facade.struct.MaintainLocationHolidayDetails details)` Modifies an existing location holiday.
`void`	`modifyLocationStructure(curam.core.facade.struct.ModifyLocationStructureDetails dtls)` Method to modify the location structure details.
`void`	`modifyLocationWorkingPattern(curam.core.struct.WorkingPatternDetails details)` This method modifies the details of a location working pattern.
`void`	`modifyNameTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails localizableTextDetails)` This method is intended to be used by users responsible for modifying the text translations for the Organisation attribute, name.
`void`	`modifyOrganisationStructure(curam.core.facade.struct.ModifyOrganisationStructureDetails modifyOrganisationStructureDetails)` Method to update organization structure.
`void`	`modifyOrganisationUnit(curam.core.facade.struct.ModifyOrganisationUnitDetails modifyOrganisationUnitDetails)` Method to update organization unit details.
`void`	`modifyOrganization1(curam.core.facade.struct.ModifyOrganizationDetails1 details)` This method is intended to be used by users responsible for modifying Organization details.
`void`	`modifyOrganizationWorkingPattern(curam.core.facade.struct.ModifyOrganizationWorkingPatternDetails details)` Modifies a working pattern for an organization.
`void`	`modifyOrgUnitCaseApproval(curam.core.facade.struct.CaseApprovalCheckDetails details)` Modifies case approval check information for an organization unit.
`void`	`modifyOrgUnitEvidenceApproval(curam.core.facade.struct.EvidenceApprovalCheckDetails evidenceApprovalCheckDetails)` Modifies evidence approval check information for an organization unit.
`void`	`modifyOrgUnitPrinter(curam.core.facade.struct.ModifyOrgUnitPrinterDetails details)` This method will modify the default printer for the org unit
`void`	`modifyPosition(curam.core.facade.struct.ModifyPositionDetails details)` Method to update position details.
`void`	`modifyPositionSlotAvailability(curam.core.facade.struct.PositionSlotAvailabilityModifyDetails positionSlotAvailabilityModifyDetails)` Modifies a position slot availability record.
`void`	`modifyQuickLink(curam.core.facade.struct.QuickLinkDetails details)` Method to allow an administrator to modify the details of a specified quick link that has been recorded for the organization.
`void`	`modifyQuickLinkApplicationLink(curam.core.facade.struct.QuickLinkApplicationLinkDtls details)` Method to allow an administrator to modify the details of the quick link application link that has been recorded for the organization.
`void`	`modifyResolutionApprovalCheckForOrgUnit(curam.core.facade.struct.IssueResolutionApprovalCheckDetails details)` This method allows an administrator to modify an Issue Resolution Approval Check for an org unit.
`void`	`modifyResolutionApprovalCheckForUser(curam.core.facade.struct.IssueResolutionApprovalCheckDetails issueResolutionApprovalCheckDetails)` This method allows an administrator to modify an Issue Resolution Approval Check for a user.
`void`	`modifyResource(curam.core.facade.struct.MaintainResourceDetails details)` Updates a resource.
`void`	`modifySlot(curam.core.facade.struct.SlotModifyDetails slotModifyDetails)` Modifies the details of a slot record.
`void`	`modifyTemporalEvidenceApprovalCheck(curam.core.facade.struct.ModifyTemporalEvidenceApprovalCheck dtls)` Method to modify an evidence approval check record.
`void`	`modifyUser(curam.core.facade.struct.ModifyUserDetails details)` Modifies user details
`void`	`modifyUserCaseApproval(curam.core.facade.struct.CaseApprovalCheckDetails details)` Modifies case approval check information for a user.
`void`	`modifyUserEvidenceApproval(curam.core.facade.struct.EvidenceApprovalCheckDetails evidenceApprovalCheckDetails)` Modifies evidence approval check information for a user.
`void`	`modifyUserPassword(curam.core.facade.struct.UserPasswordDetails dtls)` Method to modify a users password
`void`	`modifyUserPrinter(curam.core.facade.struct.ModifyUserPrinterDetails details)` This method will modify the default printer for the user.
`void`	`modifyUserSkill(curam.core.facade.struct.UserSkillModifyDetails userSkillModifyDetails)` Modifies a user skill.
`void`	`modifyUserWorkingPattern(curam.core.facade.struct.ModifyUserWorkingPatternDetails details)` Modifies a working pattern for a user.
`curam.core.facade.struct.ListPositionSearchDetails`	`positionSearch(curam.core.facade.struct.PositionNameAndOrgStructureIDKey key)` Method to search for a position within the organization.
`void`	`publishOrganizationChanges()` This method publishes immediately any changes that are made to the organization.
`curam.core.facade.struct.ReadAdminIntegratedCaseDetails1`	`readAdminIntegratedCase1(curam.core.facade.struct.ReadAdminIntegratedCaseKey_fo key)` Reads the details of an Admin Integrated Case.
`curam.core.facade.struct.ReadAllLocationHolidayDetails_fo`	`readAllLocationHoliday(curam.core.facade.struct.ReadAllLocationHolidayKey_fo key)` Returns an XML string containing the Location Holidays to be displayed on the calendar.
`curam.core.facade.struct.AlternateLoginEnabled`	`readAlternateLoginEnabled()` Read the alternateLoginEnabled flag from Enviroment.
`curam.core.facade.struct.AnnouncementDtls`	`readAnnouncement(curam.core.sl.entity.struct.AnnouncementKey key)` Method to allow an administrator to read the details of a specified announcement that has been configured for the organization.
`curam.core.facade.struct.ApplicationSearchDetails`	`readApplicationSearchRecord(curam.core.sl.struct.ApplicationSearchKey key)` Allows a User to read single record across all defined Application Objects e.g.
`curam.core.facade.struct.MaintainBankDetails`	`readBank(curam.core.facade.struct.ReadBankKey key)` Read all details for a bank.
`curam.core.facade.struct.ReadBankAccountDetails`	`readBankAccount(curam.core.facade.struct.ReadBankAccountKey_fo key)` Reads the Bank Account record specified by the input key
`curam.core.facade.struct.MaintainBankBranchDetails`	`readBankBranch(curam.core.facade.struct.ReadBankBranchKey key)` Read all details for a branch.
`curam.core.facade.struct.ReadAllExclusionDateDetails`	`readCashExclusionDate(curam.core.facade.struct.ReadAllExclusionDateKey key)` Return a list of dates to the Cash payment calendar on which Cash payments cannot be processed by the organization.
`curam.core.facade.struct.ReadAllExclusionDateDetails`	`readChequeExclusionDate(curam.core.facade.struct.ReadAllExclusionDateKey key)` Return a list of dates to the Check payment calendar on which Check payments cannot be processed by the organization.
`curam.core.struct.UserSupervisorAndLeadPositionInd`	`readCloseUserDetails(curam.core.struct.UserKeyStruct key)` Reads the details to display on close user page.
`curam.core.facade.struct.MaintainCurrencyExchangeDetails`	`readCurrencyExchange(curam.core.facade.struct.ReadCurrencyExchangeKey key)` Reads the currency exchange record specified by the input key.
`curam.core.facade.struct.DailyScheduleDetails`	`readDailySchedule(curam.core.facade.struct.DailyScheduleKey dailyScheduleKey)` Reads the details of a daily schedule record.
`curam.workspaceservices.facade.struct.TextTranslationDetails`	`readDescriptionTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails localizableTextDetails)` This method is intended to be used by users responsible for reading the text translations for the Organisation attribute, description.
`curam.core.facade.struct.ReadAllExclusionDateDetails`	`readEFTExclusionDate(curam.core.facade.struct.ReadAllExclusionDateKey key)` Return a list of dates to the EFT payment calendar on which EFT payments cannot be processed by the organization.
`curam.core.facade.struct.ReadExclusionDateDetails`	`readExclusionDate(curam.core.facade.struct.ReadExclusionDateKey_fo key)` To view an exclusion date from the financial calendar for a particular delivery method.
`curam.core.facade.struct.ReadOrgUnitInvestigationApprovalCheckDetails`	`readInvestigationApprovalCheckForOrgUnit(curam.core.facade.struct.ReadInvestigationApprovalCheckKey key)` Allows an administrator to view a approval check for an org unit.
`curam.core.facade.struct.ReadUserInvestigationApprovalCheckDetails`	`readInvestigationApprovalCheckForUser(curam.core.facade.struct.ReadInvestigationApprovalCheckKey key)` This method allows an administrator to view a approval check for a user.
`curam.core.facade.struct.ReadAllExclusionDateDetails`	`readInvoiceExclusionDate(curam.core.facade.struct.ReadAllExclusionDateKey key)` Return a list of dates to the Invoice calendar on which invoices cannot be issued by the organization.
`curam.core.facade.struct.ReadLocationDetails`	`readLocation(curam.core.facade.struct.ReadLocationKey key)` Reads details about the location specified by the key.
`curam.core.facade.struct.ReadLocationHolidayDetails`	`readLocationHoliday(curam.core.facade.struct.ReadLocationHolidayKey key)` Retrieves all information about an existing location holiday.
`curam.core.struct.LocationIDDetails`	`readLocationIDByLocationHolidayKey(curam.core.struct.LocationHolidayIDKey key)` This method is intended to be used by users responsible for administrating services.
`curam.core.struct.WorkingPatternDetails`	`readLocationNonStandardWorkingPattern(curam.core.struct.NSPatternByDayIndexKey key)` This method reads the non-standard working pattern details for a specific day for a location.
`curam.core.facade.struct.ReadLocationStructureDetails`	`readLocationStructure(curam.core.facade.struct.LocationStructureKey key)` Method to read the Location Structure Details.
`curam.core.struct.LocationStructureKey`	`readLocationStructureIDForLocationID(curam.core.struct.LocationKeyStruct locationKey)` Reads the location structure ID associated with the given location ID.
`curam.core.facade.struct.ReadLocationWorkingPatternDetails`	`readLocationWorkingPattern(curam.core.struct.WorkingPatternKey workingPatternKey)` This method reads the details of the specified working pattern.
`curam.workspaceservices.facade.struct.TextTranslationDetails`	`readNameTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails localizableTextDetails)` This method is intended to be used by users responsible for reading the text translations for the Organisation attribute, name.
`curam.core.sl.struct.OrganisationUnitDetailsAndUserList`	`readOrganisationUnitDetailsAndUserList(curam.core.sl.entity.struct.OrgStructureAndOrgUnitKey key)` Returns organization unit details and assigned user list.
`curam.core.facade.struct.ReadOrganizationHomePageDetails1`	`readOrganizationHomePage1()` This method is intended to be used by users for reading Organisation details.
`curam.core.facade.struct.ReadOrganizationNonStandardWorkingPatternDetails`	`readOrganizationNonStandardWorkingPattern(curam.core.facade.struct.ReadOrganizationNonStandardWorkingPatternKey key)` Returns the details for a non standard working pattern day for an organization.
`curam.core.facade.struct.ReadOrganizationUserHomePageDetails`	`readOrganizationUserHomePage(curam.core.facade.struct.ReadUserHomePageKey key)` Reads the User record specified by the input key.
`curam.core.facade.struct.ReadOrganizationWorkingPatternDetails`	`readOrganizationWorkingPattern(curam.core.facade.struct.ReadOrganizationWorkingPatternKey key)` Reads a working pattern for an organization.
`curam.core.facade.struct.ReadOrgUnitCaseApprovalDetails`	`readOrgUnitCaseApproval(curam.core.facade.struct.ReadOrgUnitCaseApprovalKey key)` Retrieves the details of the specified organization unit case approval check information.
`curam.core.facade.struct.ReadOrgUnitEvidenceApprovalDetails`	`readOrgUnitEvidenceApproval(curam.core.facade.struct.ReadOrgUnitEvidenceApprovalKey readOrgUnitEvidenceApprovalKey)` Retrieves the details of the specified evidence approval check information.
`curam.core.facade.struct.ParentLocationIDDetails`	`readParentLocationDetails(curam.core.facade.struct.ReadParentLocationKey key)` Method to read the parent locationID details for a location
`curam.core.sl.struct.PositionDetailsAndUserList`	`readPositionDetailsAndUserList(curam.core.sl.entity.struct.OrgStructureAndPositionKey key)` Returns position details and assigned user list.
`curam.core.facade.struct.PositionSlotAvailabilityDetails`	`readPositionSlotAvailability(curam.core.facade.struct.ReadPositionSlotAvailabiliySlotID readPositionSlotAvailabiliySlotID)` Reads the details of a position slot availability record.
`curam.core.facade.struct.QuickLinkDetails`	`readQuickLink(curam.core.sl.entity.struct.QuickLinkKey key)` Method to allow an administrator to read the details of a specified quick link that has been recorded for the organization.
`curam.core.facade.struct.QuickLinkApplicationLinkDtls`	`readQuickLinkApplicationLink(curam.core.sl.entity.struct.QuickLinkApplicationLinkKey details)` Method to read the details of the quick link application link recorded for the organization.
`curam.core.facade.struct.ReportDetails`	`readReport(curam.core.sl.entity.struct.ReportKey key)` Method to allow an administrator to read the details of a specified report that has been recorded for the organization.
`curam.core.facade.struct.ReadOrgUnitResolutionApprovalCheckDetails`	`readResolutionApprovalCheckForOrgUnit(curam.core.facade.struct.ReadIssueResolutionApprovalCheckKey readIssueResolutionApprovalCheckKey)` This method allows an administrator to view a resolution approval check for an org unit.
`curam.core.facade.struct.ReadUserResolutionApprovalCheckDetails`	`readResolutionApprovalCheckForUser(curam.core.facade.struct.ReadIssueResolutionApprovalCheckKey readIssueResolutionApprovalCheckKey)` This method allows an administrator to view a resolution approval check for a user.
`curam.core.facade.struct.ReadResourceDetails`	`readResource(curam.core.facade.struct.ReadResourceKey key)` Returns a resource details.
`curam.core.facade.struct.SlotDetails`	`readSlot(curam.core.facade.struct.SlotKey slotKey)` Reads the details of a slot record.
`curam.core.facade.struct.ViewTemporalEvidenceApprovalCheck`	`readTemporalEvidenceApprovalCheck(curam.core.facade.struct.TemporalEvidenceApprovalCheckKey key)` Method to read an evidence approval check record.
`curam.core.facade.struct.ReadUserDetails_fo`	`readUser(curam.core.facade.struct.ReadUserKey key)` Reads the User record specified by the input key.
`curam.core.facade.struct.ReadUserCaseApprovalDetails`	`readUserCaseApproval(curam.core.facade.struct.ReadUserCaseApprovalKey key)` Retrieves the details of the specified user case approval check information.
`curam.core.facade.struct.ReadUserEvidenceApprovalDetails`	`readUserEvidenceApproval(curam.core.facade.struct.ReadUserEvidenceApprovalKey readUserEvidenceApprovalKey)` Retrieves the details of the specified evidence approval check information.
`curam.core.facade.struct.ReadUserNonStandardWorkingPatternDetails`	`readUserNonStandardWorkingPattern(curam.core.facade.struct.ReadUserNonStandardWorkingPatternKey key)` Returns the details for a non standard working pattern day for a user.
`curam.core.facade.struct.UserRoleAndContactDetails`	`readUserRoleAndContactDetails1(curam.core.struct.UsersKey key)` Returns user names, role name and contact details.
`curam.core.facade.struct.UserSummaryDetails1`	`readUserSummaryDetails1(curam.core.facade.struct.UserSummaryDetailsKey key)` Method to return a summary of a user's details.
`curam.core.facade.struct.ReadUserWorkingPatternDetails`	`readUserWorkingPattern(curam.core.facade.struct.ReadUserWorkingPatternKey key)` Reads a working pattern for a user.
`curam.core.facade.struct.ReadAllExclusionDateDetails`	`readVoucherExclusionDate(curam.core.facade.struct.ReadAllExclusionDateKey key)` Return a list of dates to the Voucher payment calendar on which Voucher payments cannot be processed by the organization.
`void`	`removeCurrencyExchange(curam.core.facade.struct.RemoveCurrencyExchangeKey key)` Removes the Currency Exchange record identified by the input key.
`void`	`removeLocationAccess(curam.core.facade.struct.RemoveLocationAccessKey key)` remove additional location access
`void`	`removeLocationfromOrgUnit(curam.core.facade.struct.OrgUnitLocationDetails key)` Method used to remove a location from an organization unit.
`void`	`removeLocationFromPosition(curam.core.facade.struct.RemovePositionLocationDetails details)` This method removes a location assigned to a position
`void`	`removeLocationResource(curam.core.facade.struct.RemoveResourceKey key)` removes the resource from a location only, if remove from related locations is not selected.
`void`	`removeQuickLinkFromApplicationCode(curam.core.sl.entity.struct.QuickLinkApplicationLinkKey key)` Removes an association between a quick link and a user security role.
`void`	`removeReportForUser(curam.core.sl.entity.struct.ReportUserLinkKey key)` Removes an association between a report and a user.
`void`	`removeReportFromSecurityRole(curam.core.sl.entity.struct.ReportSecurityRoleLinkKey key)` Removes an association between a report and a security role.
`void`	`removeReportsToFromPosition(curam.core.facade.struct.OrgStructureAndPositionKey key)` Remove ReportsTo value from a Position.
`void`	`removeResourceFromOrgUnit(curam.core.facade.struct.RemoveResourceFromOrgUnitDetails key)` Presentation layer operation to remove a resource from a org unit
`void`	`removeUserFromPosition(curam.core.facade.struct.RemoveUserFromPositionKey removeUserFromPositionKey)` Method to remove user from specified position.
`void`	`reopenUser(curam.core.facade.struct.ReopenUserDetails details)` Inserts the details to reopen the User.
`curam.core.facade.struct.CaseOwnerPageIdentifierResult`	`resolveCaseOwnerHome(curam.core.sl.struct.OrgObjectReferenceOrgObjectType key)` Returns the home page name for the Case Owner.
`curam.core.facade.struct.OrganisationUnitIDDetails`	`resolveRootOrganisationUnit()` Returns the organization unit ID for the root organization unit for the current active structure.
`curam.core.facade.struct.ListActiveResourcesDetails`	`searchActiveResourcesByType(curam.core.facade.struct.ResourceSearchKey key)` List all active resources by type
`curam.core.facade.struct.SearchUserDetails`	`searchActiveUserDetails(curam.core.facade.struct.UserSearchKey key)` Search for an active user details by given search criteria.
`curam.core.facade.struct.ApplicationSearchDetailsList`	`searchApplicationReference(curam.core.facade.struct.ApplicationSearchKey key)` Validates search criteria and allows a User to search across all defined Application Objects e.g.
`curam.core.facade.struct.ListBankBranchDetails`	`searchBankBranch(curam.core.facade.struct.SearchBankBranchCriteria key, curam.core.facade.struct.ActionIDProperty actionIDProperty)` Retrieves a list of bank branch for an organization with a given search criteria.
`curam.core.facade.struct.ReadOrganizationLocationList`	`searchLocationsByLocationNameOrType(curam.core.facade.struct.LocationByNameAndTypeKey key, curam.core.facade.struct.ActionIDProperty actionIDProperty)` Retrieves a list of locations for an organization with a given name or type.
`curam.core.facade.struct.OrganisationUnitSearchResults`	`searchOrganisationUnit(curam.core.facade.struct.OrganisationUnitSearchCriteria organisationUnitSearchCriteria)` returns a list of organization units based on the search criteria passed in.
`curam.core.facade.struct.OrgUnitDetailsList`	`searchOrganisationUnitDetails(curam.core.facade.struct.OrgUnitSearchCriteria key, curam.core.facade.struct.ActionIDProperty actionIDProperty)` TO search the org units
`curam.core.facade.struct.ListPositionForOrgStructureDetails`	`searchOrganizationPositions(curam.core.facade.struct.PositionSearchCriteria key, curam.core.facade.struct.ActionIDProperty actionIDProperty)` Retrieves a list of position for an organization with a given search criteria.
`curam.core.facade.struct.SearchUserDetails`	`searchUserDetails(curam.core.facade.struct.UserSearchKey key)` Search for an user detail within the organization.
`void`	`setLocationTreeXMLNodeDetails(curam.core.facade.struct.LocationStructureKey key)` Takes the Location Structure Id as a parameter for which the last accessed Node needs to be modified
`void`	`setOrganisationTreeXMLNodeDetails(curam.core.facade.struct.OrganisationStructureKey key)` Takes the Organization Structure as a parameter for which the last accessed Node needs to be modified
`void`	`taskRedirectionsForUserDetails(curam.core.sl.struct.TaskRedirectionsForUserDetails key)` Creates a task redirection record for the specified user.
`curam.core.facade.struct.UserSearchDetailsResults`	`userDetailsSearch(curam.core.facade.struct.UserSearchKey key)` Deprecated. Since Curam 6.0 SP2, replaced with `searchUserDetails(UserSearchKey)`. This method is being deprecated because it is not returning any informational messages. So this replaced by new method searchUserDetails(UserSearchKey key) which returns the informational message as well . See release note: CS-09152/CR00282028
`curam.core.facade.struct.ViewJobDetails`	`viewJob(curam.core.facade.struct.JobKey jobKey)` Method to return job details.
`curam.core.facade.struct.LocationDetailsForPositionHomeList`	`viewLocationDetailsForPosition(curam.core.facade.struct.PositionIDKey key)` Method to return a list of locations associated with a position.
`curam.core.facade.struct.ViewOrganisationStructureDetails1`	`viewOrganisationStructure1(curam.core.facade.struct.OrganisationStructureKey organisationStructureKey)` Method to view organization structure details.
`curam.core.facade.struct.ViewOrganisationUnitDetails`	`viewOrganisationUnit(curam.core.facade.struct.OrgStructureAndOrgUnitKey key)` Method to return organization unit details.
`curam.core.facade.struct.ViewPositionDetails`	`viewPosition(curam.core.facade.struct.OrgStructureAndPositionKey key)` Method to return position details.
`curam.core.facade.struct.UserSkillLanguageDetails`	`viewUserLanguagesSkill(curam.core.facade.struct.UserSkillKey key)` This method returns User Language Details

Method Detail

activateOrganisationStructure

@AccessLevel(value=EXTERNAL)
void activateOrganisationStructure(curam.core.facade.struct.ActivateOrgStructureKey activateOrgStructureKey)
                                                         throws curam.util.exception.AppException,
                                                                curam.util.exception.InformationalException

Method to activate organization structure.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readOrganizationHomePage1

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

This method is intended to be used by users for reading Organisation details.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

addCashExclusionDate

@AccessLevel(value=EXTERNAL)
void addCashExclusionDate(curam.core.facade.struct.AddExclusionDateKey key)
                                                throws curam.util.exception.AppException,
                                                       curam.util.exception.InformationalException

To add a Cash exclusion date to the FinancialCalendar.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

addChequeExclusionDate

@AccessLevel(value=EXTERNAL)
void addChequeExclusionDate(curam.core.facade.struct.AddExclusionDateKey key)
                                                  throws curam.util.exception.AppException,
                                                         curam.util.exception.InformationalException

To add a Check exclusion date to the FinancialCalendar.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

addChildUnit

@AccessLevel(value=EXTERNAL)
void addChildUnit(curam.core.facade.struct.ChildOrganisationUnitDetails childOrganisationUnitDetails)
                                        throws curam.util.exception.AppException,
                                               curam.util.exception.InformationalException

Method to create new child organization unit for organization unit.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

addEFTExclusionDate

@AccessLevel(value=EXTERNAL)
void addEFTExclusionDate(curam.core.facade.struct.AddExclusionDateKey key)
                                               throws curam.util.exception.AppException,
                                                      curam.util.exception.InformationalException

To add an EFT exclusion date to the FinancialCalendar.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

addInvoiceExclusionDate

@AccessLevel(value=EXTERNAL)
void addInvoiceExclusionDate(curam.core.facade.struct.AddExclusionDateKey key)
                                                   throws curam.util.exception.AppException,
                                                          curam.util.exception.InformationalException

To add an Invoice exclusion date to the FinancialCalendar.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

addUserForPosition

@AccessLevel(value=EXTERNAL)
void addUserForPosition(curam.core.facade.struct.UserForPositionDetails userForPositionDetails)
                                              throws curam.util.exception.AppException,
                                                     curam.util.exception.InformationalException

Method to add user for specified position.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

addVoucherExclusionDate

@AccessLevel(value=EXTERNAL)
void addVoucherExclusionDate(curam.core.facade.struct.AddExclusionDateKey key)
                                                   throws curam.util.exception.AppException,
                                                          curam.util.exception.InformationalException

To add a Voucher exclusion date to the FinancialCalendar.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

assignResourceToOrgUnit

@AccessLevel(value=EXTERNAL)
void assignResourceToOrgUnit(curam.core.facade.struct.AddOrgUnitResourceDetails key)
                                                   throws curam.util.exception.AppException,
                                                          curam.util.exception.InformationalException

Presentation layer operation to assign a resource to a org unit

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelAdminIntegratedCase

@AccessLevel(value=EXTERNAL)
void cancelAdminIntegratedCase(curam.core.facade.struct.CancelAdminIntegratedCaseKey_fo key)
                                                     throws curam.util.exception.AppException,
                                                            curam.util.exception.InformationalException

Cancels an Admin Integrated Case record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelBank

@AccessLevel(value=EXTERNAL)
void cancelBank(curam.core.facade.struct.CancelBankKey key)
                                      throws curam.util.exception.AppException,
                                             curam.util.exception.InformationalException

This method will change the recordStatus of Bank from Active to Canceled

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelBankAccount

@AccessLevel(value=EXTERNAL)
void cancelBankAccount(curam.core.facade.struct.CancelBankAccountKey key)
                                             throws curam.util.exception.AppException,
                                                    curam.util.exception.InformationalException

This method will change the recordStatus of OrgBankaccountLink from Active to Canceled

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelBankBranch

@AccessLevel(value=EXTERNAL)
void cancelBankBranch(curam.core.facade.struct.CancelBankBranchKey key)
                                            throws curam.util.exception.AppException,
                                                   curam.util.exception.InformationalException

This method will change the recordStatus of BankBranch from Active to Canceled

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelCurrencyExchange

@AccessLevel(value=EXTERNAL)
void cancelCurrencyExchange(curam.core.facade.struct.CancelCurrencyExchangeKey key)
                                                  throws curam.util.exception.AppException,
                                                         curam.util.exception.InformationalException

This method will change the recordStatus of Currency Exchange from Active to Canceled

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelDailySchedule

@AccessLevel(value=EXTERNAL)
void cancelDailySchedule(curam.core.facade.struct.CancelDailyScheduleDetails cancelDailyScheduleDetails)
                                               throws curam.util.exception.AppException,
                                                      curam.util.exception.InformationalException

Cancels a daily schedule record

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelExclusionDate

@AccessLevel(value=EXTERNAL)
void cancelExclusionDate(curam.core.facade.struct.CancelExclusionDateKey_fo key)
                                               throws curam.util.exception.AppException,
                                                      curam.util.exception.InformationalException

To remove an exclusion date from the FinancialCalendar for a particular delivery method.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelJob

@AccessLevel(value=EXTERNAL)
void cancelJob(curam.core.facade.struct.CancelJobKey cancelJobKey)
                                     throws curam.util.exception.AppException,
                                            curam.util.exception.InformationalException

Cancels a job record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelLocation

@AccessLevel(value=EXTERNAL)
void cancelLocation(curam.core.facade.struct.CancelLocationKey key)
                                          throws curam.util.exception.AppException,
                                                 curam.util.exception.InformationalException

This method will change the recordStatus of Admin Location from Active to Canceled.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelLocationHoliday

@AccessLevel(value=EXTERNAL)
void cancelLocationHoliday(curam.core.facade.struct.CancelLocationHolidayKey key)
                                                 throws curam.util.exception.AppException,
                                                        curam.util.exception.InformationalException

Cancels an existing location holiday.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelOrganisationStructure

@AccessLevel(value=EXTERNAL)
void cancelOrganisationStructure(curam.core.facade.struct.CancelOrgStructureKey cancelOrgStructureKey)
                                                       throws curam.util.exception.AppException,
                                                              curam.util.exception.InformationalException

Method to cancel organization structure.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelOrganizationUnit

@AccessLevel(value=EXTERNAL)
void cancelOrganizationUnit(curam.core.facade.struct.CancelOrgUnitKey cancelOrgUnitKey)
                                                  throws curam.util.exception.AppException,
                                                         curam.util.exception.InformationalException

Method to cancel organization unit.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelOrganizationWorkingPattern

@AccessLevel(value=EXTERNAL)
void cancelOrganizationWorkingPattern(curam.core.facade.struct.CancelOrganizationWorkingPatternKey key)
                                                            throws curam.util.exception.AppException,
                                                                   curam.util.exception.InformationalException

Cancels a working pattern for an organization.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelOrgUnitCaseApproval

@AccessLevel(value=EXTERNAL)
void cancelOrgUnitCaseApproval(curam.core.facade.struct.CancelOrgUnitCaseApprovalKey key)
                                                     throws curam.util.exception.AppException,
                                                            curam.util.exception.InformationalException

This method will change the recordStatus of Case Approval Check from Active to Canceled

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelOrgUnitEvidenceApproval

@AccessLevel(value=EXTERNAL)
void cancelOrgUnitEvidenceApproval(curam.core.facade.struct.CancelOrgUnitEvidenceApprovalKey canceOrgUnitEvidenceApprovalKey)
                                                         throws curam.util.exception.AppException,
                                                                curam.util.exception.InformationalException

Updates the recordStatus of the EvidenceApprovalCheck record to be canceled.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelPositionSlotavailability

@AccessLevel(value=EXTERNAL)
void cancelPositionSlotavailability(curam.core.facade.struct.CancelPositionSlotAvailabilityDetails cancelPositionSlotAvailabilityDetails)
                                                          throws curam.util.exception.AppException,
                                                                 curam.util.exception.InformationalException

Cancels a position slot availability record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelResource

@AccessLevel(value=EXTERNAL)
void cancelResource(curam.core.facade.struct.CancelResourceKey key)
                                          throws curam.util.exception.AppException,
                                                 curam.util.exception.InformationalException

This method will change the recordStatus of Resources Record from Active to Canceled.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelSlotDetails

@AccessLevel(value=EXTERNAL)
void cancelSlotDetails(curam.core.facade.struct.CancelSlotDetails cancelSlotDetails)
                                             throws curam.util.exception.AppException,
                                                    curam.util.exception.InformationalException

Cancels a slot record

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelUser

@AccessLevel(value=EXTERNAL)
void cancelUser(curam.core.facade.struct.CancelUserKey key)
                                      throws curam.util.exception.AppException,
                                             curam.util.exception.InformationalException

This method will change the recordStatus of Users from Active to Canceled.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelInternalUser

@AccessLevel(value=EXTERNAL)
void cancelInternalUser(curam.core.facade.struct.CancelUserKey key)
                                              throws curam.util.exception.AppException,
                                                     curam.util.exception.InformationalException

This method will change the recordStatus of User from Active to Canceled. It handles only internal user's deletion.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelUserCaseApproval

@AccessLevel(value=EXTERNAL)
void cancelUserCaseApproval(curam.core.facade.struct.CancelUserCaseApprovalKey key)
                                                  throws curam.util.exception.AppException,
                                                         curam.util.exception.InformationalException

This method will change the recordStatus of Case Approval Check from Active to Canceled

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelUserEvidenceApproval

@AccessLevel(value=EXTERNAL)
void cancelUserEvidenceApproval(curam.core.facade.struct.CancelUserEvidenceApprovalKey cancelUserEvidenceApprovalKey)
                                                      throws curam.util.exception.AppException,
                                                             curam.util.exception.InformationalException

Updates the recordStatus of the EvidenceApprovalCheck record to be canceled.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelUserSkillDetails
```
@Deprecated
 @AccessLevel(value=EXTERNAL)
void cancelUserSkillDetails(curam.core.facade.struct.CancelUserSkillDetails cancelUserSkillDetails)
                                                               throws curam.util.exception.AppException,
                                                                      curam.util.exception.InformationalException
```
Deprecated. Since Curam 6.0.5.0, replaced with #cancelUserSkillsDetails(UserLanguageSkillCreationDetails) This method is deprecated because of the new requirement where informational has to be return when the redetermination of translator required runs on batch. See release note: CR00341851.

Cancels a user skill record.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

cancelUserWorkingPattern

@AccessLevel(value=EXTERNAL)
void cancelUserWorkingPattern(curam.core.facade.struct.CancelUserWorkingPatternKey key)
                                                    throws curam.util.exception.AppException,
                                                           curam.util.exception.InformationalException

Cancels a working pattern for a user.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cloneOrganisationStructure

@AccessLevel(value=EXTERNAL)
void cloneOrganisationStructure(curam.core.facade.struct.CloneOrgStructureKey cloneOrgStructureKey)
                                                      throws curam.util.exception.AppException,
                                                             curam.util.exception.InformationalException

Method to clone organization structure.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createBank

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

Insert a new bank

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createBankBranch

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

Inserts a new bank branch.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createCurrencyExchange

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

Inserts a new Currency Exchange for an Organization.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createDailySchedule

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CreateDailyScheduleReturnKey createDailySchedule(curam.core.facade.struct.DailyScheduleCreateDetails dailyScheduleCreateDetails)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Create a daily schedule record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createJob

@AccessLevel(value=EXTERNAL)
void createJob(curam.core.facade.struct.JobDetails jobDetails)
                                     throws curam.util.exception.AppException,
                                            curam.util.exception.InformationalException

Method to create new job.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createLocation

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

Adds a location record to the database.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createLocationHoliday

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CreateLocationHolidayDetails createLocationHoliday(curam.core.facade.struct.MaintainLocationHolidayDetails details)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Creates a new location holiday for the specified location on the specified date.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createModifyOrganizationNonStandardWorkingPattern

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

Create/modifies a non standard working pattern for an organization.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createModifyUserNonStandardWorkingPattern

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

Create/modifies a non standard working pattern for a user.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createOrganisationStructure

@AccessLevel(value=EXTERNAL)
void createOrganisationStructure(curam.core.facade.struct.OrganisationStructureDetails organisationStructureDetails)
                                                       throws curam.util.exception.AppException,
                                                              curam.util.exception.InformationalException

Method to create new organization structure.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createOrganisationUnit

@AccessLevel(value=EXTERNAL)
void createOrganisationUnit(curam.core.facade.struct.OrganisationUnitDetails organisationUnitDetails)
                                                  throws curam.util.exception.AppException,
                                                         curam.util.exception.InformationalException

Method to create new organization unit.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createOrganizationWorkingPattern

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

Creates a working pattern for an organization.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createOrgUnitCaseApproval

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

Adds case approval check information for an organization unit. For example, this could specify that 10% of cases for a specified organization unit are sent for manual approval checking.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createOrgUnitEvidenceApproval

@AccessLevel(value=EXTERNAL)
void createOrgUnitEvidenceApproval(curam.core.facade.struct.EvidenceApprovalCheckDetails evidenceApprovalCheckDetails)
                                                         throws curam.util.exception.AppException,
                                                                curam.util.exception.InformationalException

Adds evidence approval check information for an organization unit. For example, this could specify that 10% of evidence updates for a specified organization unit are sent for manual approval checking.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createPosition

@AccessLevel(value=EXTERNAL)
void createPosition(curam.core.facade.struct.CreatePositionDetails createPositionDetails)
                                          throws curam.util.exception.AppException,
                                                 curam.util.exception.InformationalException

Method to create new position.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createPositionSlotAvailability

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CreatePositionSlotAvailabilityReturnKey createPositionSlotAvailability(curam.core.facade.struct.PositionSlotAvailabilityCreateDetails positionSlotAvailabilityCreateDetails)
                                                                                                                      throws curam.util.exception.AppException,
                                                                                                                             curam.util.exception.InformationalException

Inserts a position slot availability record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createResource

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

Adds a new resource.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createRootUnit

@AccessLevel(value=EXTERNAL)
void createRootUnit(curam.core.facade.struct.RootOrganisationUnitDetails rootOrganisationUnitDetails)
                                          throws curam.util.exception.AppException,
                                                 curam.util.exception.InformationalException

Method to create new root organization unit for organization structure.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createSlot

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CreateSlotReturnKey createSlot(curam.core.facade.struct.SlotCreateDetails slotCreateDetails)
                                                                              throws curam.util.exception.AppException,
                                                                                     curam.util.exception.InformationalException

Create a slot record

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createUser

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

Inserts a new user.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createUserCaseApproval

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

Adds case approval check information for a user. For example, this could specify that 10% of cases for a specified user are sent for manual approval checking.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createUserEvidenceApproval

@AccessLevel(value=EXTERNAL)
void createUserEvidenceApproval(curam.core.facade.struct.EvidenceApprovalCheckDetails evidenceApprovalCheckDetails)
                                                      throws curam.util.exception.AppException,
                                                             curam.util.exception.InformationalException

Adds evidence approval check information for a user. For example, this could specify that 10% of evidence updates for a specified user are sent for manual approval checking.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createUserSkill

@AccessLevel(value=EXTERNAL)
void createUserSkill(curam.core.facade.struct.UserSkillCreateDetails userSkillCreateDetails)
                                           throws curam.util.exception.AppException,
                                                  curam.util.exception.InformationalException

Creates a user skill

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createUserWorkingPattern

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

Creates a working pattern for a user.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

disableUser

@AccessLevel(value=EXTERNAL)
void disableUser(curam.core.facade.struct.UserStatusDetails_fo userStatusDetails)
                                       throws curam.util.exception.AppException,
                                              curam.util.exception.InformationalException

This method disables a user.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

enableUser

@AccessLevel(value=EXTERNAL)
void enableUser(curam.core.facade.struct.UserStatusDetails_fo userStatusDetails)
                                      throws curam.util.exception.AppException,
                                             curam.util.exception.InformationalException

This method enables a user.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

getOrganisationUnitContactInformation

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.OrganisationUnitContactDetails getOrganisationUnitContactInformation(curam.core.facade.struct.OrgStructureAndOrgUnitKey key)
                                                                                                                    throws curam.util.exception.AppException,
                                                                                                                           curam.util.exception.InformationalException

Method to return contact information for specified organization unit.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

getOrgStructureBreadCrumb

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.OrgStructureBreadCrumbDetails getOrgStructureBreadCrumb(curam.core.facade.struct.OrgStructureBrowserKey orgStructureBrowserKey)
                                                                                                       throws curam.util.exception.AppException,
                                                                                                              curam.util.exception.InformationalException

Returns bread crumb menu data for an organization unit.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

getOrgUnitBreadCrumb

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.OrgUnitBreadCrumbDetails getOrgUnitBreadCrumb(curam.core.facade.struct.OrgUnitBrowserKey orgUnitBrowserKey)
                                                                                             throws curam.util.exception.AppException,
                                                                                                    curam.util.exception.InformationalException

Returns bread crumb menu data for an organization unit.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

getPositionBreadCrumb

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.OrgStructureBreadCrumbDetails getPositionBreadCrumb(curam.core.facade.struct.OrgStructureBrowserKey orgStructureBrowserKey)
                                                                                                   throws curam.util.exception.AppException,
                                                                                                          curam.util.exception.InformationalException

Returns bread crumb menu data for a position

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listActiveAdminIntegratedCase

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

Returns a list of active Admin Integrated Case records.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listActiveLeadPositionForOrgUnit

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListPositionForOrgUnitDetails listActiveLeadPositionForOrgUnit(curam.core.facade.struct.OrgStructureAndOrgUnitKey key)
                                                                                                              throws curam.util.exception.AppException,
                                                                                                                     curam.util.exception.InformationalException

Method to return all active lead positions for specified organization unit.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listActivePositionForOrgUnit

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListPositionForOrgUnitDetails listActivePositionForOrgUnit(curam.core.facade.struct.OrgStructureAndOrgUnitKey key)
                                                                                                          throws curam.util.exception.AppException,
                                                                                                                 curam.util.exception.InformationalException

Method to return all active positions for specified organization unit.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listAllAdminIntegratedCase

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

Returns a list of all Admin Integrated Case records.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listAllOrgUnit

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

Method to return all organization units.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listAllSecurityRoles

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

This method returns a list of users within the organization.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listBank

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

Lists all banks

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listBankAccount

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

Returns a list of Public Offices for the specified Organization.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listBankBranch

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListBankBranchDetails listBankBranch(curam.core.facade.struct.ListBankBranchKey key)
                                                                                    throws curam.util.exception.AppException,
                                                                                           curam.util.exception.InformationalException

Lists all Branches for the specified bank.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listBankBranchNameBankName

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadBankBranchNameBankNameDtlsList listBankBranchNameBankName(curam.core.facade.struct.ReadBankBranchNameBankNameKey key)
                                                                                                             throws curam.util.exception.AppException,
                                                                                                                    curam.util.exception.InformationalException

Method to return a list of bank branches with a normal status given a sort code. An administrator can create bank accounts for the organization. Using this method the administrator can select a bank branch from the system by supplying a sort code.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listChildLocations

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListChildLocationsDetails listChildLocations(curam.core.facade.struct.ListChildLocationsKey key)
                                                                                            throws curam.util.exception.AppException,
                                                                                                   curam.util.exception.InformationalException

Method to return a list of child locations give the parent location.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listCurrencyExchange

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

This process will read a currency exchange rate on a specified date

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listCurrencyExchangeHistory

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListCurrencyExchangeHistoryDetails listCurrencyExchangeHistory(curam.core.facade.struct.ListCurrencyExchangeHistoryKey_fo key)
                                                                                                              throws curam.util.exception.AppException,
                                                                                                                     curam.util.exception.InformationalException

This operation will read the history of currency exchange rates for a selected currency. It will list all the different rates for that currency between the dates that you have specified.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listDailySchedule

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListDailyScheduleDetails listDailySchedule(curam.core.facade.struct.DailyScheduleListKey dailyScheduleListKey)
                                                                                          throws curam.util.exception.AppException,
                                                                                                 curam.util.exception.InformationalException

Lists Daily Schedule records for a location.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listLeadPositionForOrgStructure

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListPositionForOrgStructureDetails listLeadPositionForOrgStructure(curam.core.facade.struct.OrganisationStructureKey key)
                                                                                                                  throws curam.util.exception.AppException,
                                                                                                                         curam.util.exception.InformationalException

Method to return all lead positions for specified organization structure.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listLeadPositionForOrgUnit

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListPositionForOrgUnitDetails listLeadPositionForOrgUnit(curam.core.facade.struct.OrgStructureAndOrgUnitKey key)
                                                                                                        throws curam.util.exception.AppException,
                                                                                                               curam.util.exception.InformationalException

Method to return all lead positions for specified organization unit.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listLeadUserForOrgStructure

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListUserForOrgStructureDetails listLeadUserForOrgStructure(curam.core.facade.struct.OrganisationStructureKey key)
                                                                                                          throws curam.util.exception.AppException,
                                                                                                                 curam.util.exception.InformationalException

Method to return all lead users for specified organization structure.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listLeadUserForOrgUnit

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListUserForOrgUnitDetails listLeadUserForOrgUnit(curam.core.facade.struct.OrgStructureAndOrgUnitKey key)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Method to return all lead users for specified organization unit.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listLocation

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

Returns a list of locations for the organization.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listLocationHoliday

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListLocationHolidayDetails listLocationHoliday(curam.core.facade.struct.ListLocationHolidayKey key)
                                                                                              throws curam.util.exception.AppException,
                                                                                                     curam.util.exception.InformationalException

Retrieves summary information for all holidays for the specified location, not including parent locations.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listOrganizationWorkingPattern

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

Returns a list of working pattern for an organization

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listOrgStructureChildElements

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.OrgStructureChildElementDetails listOrgStructureChildElements(curam.core.facade.struct.OrgStructureBrowserKey orgStructureBrowserKey)
                                                                                                             throws curam.util.exception.AppException,
                                                                                                                    curam.util.exception.InformationalException

Lists child organization units and positions for an organization unit

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listOrgUnitCaseApproval

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListOrgUnitCaseApprovalDetails listOrgUnitCaseApproval(curam.core.facade.struct.ListOrgUnitCaseApprovalKey key)
                                                                                                      throws curam.util.exception.AppException,
                                                                                                             curam.util.exception.InformationalException

Retrieves the case approval check information for the specified organization unit.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listOrgUnitEvidenceApproval

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListOrgUnitEvidenceApprovalDetails listOrgUnitEvidenceApproval(curam.core.facade.struct.ListOrgUnitEvidenceApprovalKey listOrgUnitEvidenceApprovalKey)
                                                                                                              throws curam.util.exception.AppException,
                                                                                                                     curam.util.exception.InformationalException

Retrieves the evidence approval check information for the specified organization unit.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listPositionForJob

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListPositionForJobDetails listPositionForJob(curam.core.facade.struct.JobKey key)
                                                                                            throws curam.util.exception.AppException,
                                                                                                   curam.util.exception.InformationalException

Method to return all positions for specified job.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listPositionForOrgStructure

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListPositionForOrgStructureDetails listPositionForOrgStructure(curam.core.facade.struct.OrganisationStructureKey key)
                                                                                                              throws curam.util.exception.AppException,
                                                                                                                     curam.util.exception.InformationalException

Method to return all positions for specified organization structure.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listPositionForOrgUnit

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListPositionForOrgUnitDetails listPositionForOrgUnit(curam.core.facade.struct.OrgStructureAndOrgUnitKey key)
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

Method to return all positions for specified organization unit.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listPositionSlotAvailability

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListPositionSlotAvailabilityDetails listPositionSlotAvailability(curam.core.facade.struct.PositionSlotAvailabilityListKey positionSlotAvailabilityListKey)
                                                                                                                throws curam.util.exception.AppException,
                                                                                                                       curam.util.exception.InformationalException

Lists all position slot availability records.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listPrinters

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

This method lists all printers for the Organization.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listPrintersForOrgUnit

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadPrintersForOrgUnitDetails listPrintersForOrgUnit(curam.core.facade.struct.ReadPrintersForOrgUnitKey key)
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

Returns a list of resources of printer type for a specified org unit

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listPublicOffice

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

Returns a list of public offices for the organization.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listResource

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

Return a list of all resource details.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listResourcesForLocation

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListResourcesForLocationDetails listResourcesForLocation(curam.core.facade.struct.ListResourcesForLocationKey key)
                                                                                                        throws curam.util.exception.AppException,
                                                                                                               curam.util.exception.InformationalException

Presentation layer operation to list resources for a location.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listResourcesForOrgUnit

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListResourcesForOrgUnitDetails listResourcesForOrgUnit(curam.core.facade.struct.ListResourcesForOrgUnitKey key)
                                                                                                      throws curam.util.exception.AppException,
                                                                                                             curam.util.exception.InformationalException

Presentation layer operation to list resources for a org unit

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listResourcesInOperation

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

Presentation layer operation to list all available resources.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listSlot

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListSlotDetails listSlot(curam.core.facade.struct.SlotListKey slotListKey)
                                                                        throws curam.util.exception.AppException,
                                                                               curam.util.exception.InformationalException

Lists slot records for a daily schedule.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listSubordinatePositionForPosition

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListPositionForPositionDetails listSubordinatePositionForPosition(curam.core.facade.struct.OrgStructureAndPositionKey key)
                                                                                                                 throws curam.util.exception.AppException,
                                                                                                                        curam.util.exception.InformationalException

Method to return all subordinate positions for specified position.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listSubordinateUserForPosition

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListOrgUnitUserDetails listSubordinateUserForPosition(curam.core.facade.struct.OrgStructureAndPositionKey key)
                                                                                                     throws curam.util.exception.AppException,
                                                                                                            curam.util.exception.InformationalException

Method to return all subordinate users for specified position.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listSupervisorUserForPosition

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListUserForPositionDetails listSupervisorUserForPosition(curam.core.facade.struct.OrgStructureAndPositionKey key)
                                                                                                        throws curam.util.exception.AppException,
                                                                                                               curam.util.exception.InformationalException

Method to return all supervisor users for specified position.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listUserCaseApproval

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListUserCaseApprovalDetails listUserCaseApproval(curam.core.facade.struct.ListUserCaseApprovalKey key)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Retrieves the case approval check information for the specified User.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listUserEvidenceApproval

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListUserEvidenceApprovalDetails listUserEvidenceApproval(curam.core.facade.struct.ListUserEvidenceApprovalKey listUserEvidenceApprovalKey)
                                                                                                        throws curam.util.exception.AppException,
                                                                                                               curam.util.exception.InformationalException

Retrieves the evidence approval check information for the specified user.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listUserForOrganisation

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

Method to return all users for organization structure.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listUserForOrgStructure

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListUserForOrgStructureDetails listUserForOrgStructure(curam.core.facade.struct.OrganisationStructureKey organisationStructureKey)
                                                                                                      throws curam.util.exception.AppException,
                                                                                                             curam.util.exception.InformationalException

Method to return all users for specified organization structure.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listUserForOrgUnit

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListUserForOrgUnitDetails listUserForOrgUnit(curam.core.facade.struct.OrgStructureAndOrgUnitKey key)
                                                                                            throws curam.util.exception.AppException,
                                                                                                   curam.util.exception.InformationalException

Method to return all users for specified organization unit.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listUserForPosition

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListUserForPositionDetails listUserForPosition(curam.core.facade.struct.OrgStructureAndPositionKey key)
                                                                                              throws curam.util.exception.AppException,
                                                                                                     curam.util.exception.InformationalException

Method to return all users for specified position.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listUserSkill

@Deprecated
 @AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListUserSkillDetails listUserSkill(curam.core.facade.struct.UserSkillListKey userSkillListKey)
                                                                                               throws curam.util.exception.AppException,
                                                                                                      curam.util.exception.InformationalException

Deprecated. Since Curam 6.0.4.0, replaced with getUserSkills(UserSkillListKey). This method is being deprecated as the return struct does not have an attribute to identify the language skill type. See release note: CR00322668/CEF-9913.

Lists user skills for a user.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listUserWorkingPattern

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListUserWorkingPatternDetails listUserWorkingPattern(curam.core.facade.struct.ListUserWorkingPatternKey key)
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

Returns a list of working patterns for a user.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listVacantPositionForOrgStructure

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListPositionForOrgStructureDetails listVacantPositionForOrgStructure(curam.core.facade.struct.OrganisationStructureKey key)
                                                                                                                    throws curam.util.exception.AppException,
                                                                                                                           curam.util.exception.InformationalException

Method to return all vacant positions for specified organization structure.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listVacantPositionForOrgUnit

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListPositionForOrgUnitDetails listVacantPositionForOrgUnit(curam.core.facade.struct.OrgStructureAndOrgUnitKey key)
                                                                                                          throws curam.util.exception.AppException,
                                                                                                                 curam.util.exception.InformationalException

Method to return all vacant positions for specified organization unit.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyBank

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

Modify an existing Bank

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyBankBranch

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

Modifies an existing branch.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyCurrencyExchange

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

Modifies Currency Exchange details

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyDailySchedule

@AccessLevel(value=EXTERNAL)
void modifyDailySchedule(curam.core.facade.struct.DailyScheduleModifyDetails dailyScheduleModifyDetails)
                                               throws curam.util.exception.AppException,
                                                      curam.util.exception.InformationalException

Modifies the details of a daily schedule record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyJob

@AccessLevel(value=EXTERNAL)
void modifyJob(curam.core.facade.struct.ModifyJobDetails modifyJobDetails)
                                     throws curam.util.exception.AppException,
                                            curam.util.exception.InformationalException

Method to update job details.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyLocation

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

Updates location details for the specified location.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyLocationHoliday

@AccessLevel(value=EXTERNAL)
curam.core.struct.UpdatedLocationHolidayIDDetails modifyLocationHoliday(curam.core.facade.struct.MaintainLocationHolidayDetails details)
                                                                                              throws curam.util.exception.AppException,
                                                                                                     curam.util.exception.InformationalException

Modifies an existing location holiday.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyOrganisationStructure

@AccessLevel(value=EXTERNAL)
void modifyOrganisationStructure(curam.core.facade.struct.ModifyOrganisationStructureDetails modifyOrganisationStructureDetails)
                                                       throws curam.util.exception.AppException,
                                                              curam.util.exception.InformationalException

Method to update organization structure.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyOrganisationUnit

@AccessLevel(value=EXTERNAL)
void modifyOrganisationUnit(curam.core.facade.struct.ModifyOrganisationUnitDetails modifyOrganisationUnitDetails)
                                                  throws curam.util.exception.AppException,
                                                         curam.util.exception.InformationalException

Method to update organization unit details.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyOrganizationWorkingPattern

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

Modifies a working pattern for an organization.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyOrgUnitCaseApproval

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

Modifies case approval check information for an organization unit. For example, this could specify that 10% of cases for a specified organization unit are sent for manual approval checking.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyOrgUnitEvidenceApproval

@AccessLevel(value=EXTERNAL)
void modifyOrgUnitEvidenceApproval(curam.core.facade.struct.EvidenceApprovalCheckDetails evidenceApprovalCheckDetails)
                                                         throws curam.util.exception.AppException,
                                                                curam.util.exception.InformationalException

Modifies evidence approval check information for an organization unit. For example, this could specify that 10% of evidence updates for a specified organization unit are sent for manual approval checking.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyOrgUnitPrinter

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

This method will modify the default printer for the org unit

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyPosition

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

Method to update position details.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyPositionSlotAvailability

@AccessLevel(value=EXTERNAL)
void modifyPositionSlotAvailability(curam.core.facade.struct.PositionSlotAvailabilityModifyDetails positionSlotAvailabilityModifyDetails)
                                                          throws curam.util.exception.AppException,
                                                                 curam.util.exception.InformationalException

Modifies a position slot availability record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyResource

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

Updates a resource.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifySlot

@AccessLevel(value=EXTERNAL)
void modifySlot(curam.core.facade.struct.SlotModifyDetails slotModifyDetails)
                                      throws curam.util.exception.AppException,
                                             curam.util.exception.InformationalException

Modifies the details of a slot record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyUser

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

Modifies user details

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyUserCaseApproval

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

Modifies case approval check information for a user. For example, this could specify that 10% of cases for a specified user are sent for manual approval checking.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyUserEvidenceApproval

@AccessLevel(value=EXTERNAL)
void modifyUserEvidenceApproval(curam.core.facade.struct.EvidenceApprovalCheckDetails evidenceApprovalCheckDetails)
                                                      throws curam.util.exception.AppException,
                                                             curam.util.exception.InformationalException

Modifies evidence approval check information for a user. For example, this could specify that 10% of evidence updates for a specified user are sent for manual approval checking.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyUserPassword

@AccessLevel(value=EXTERNAL)
void modifyUserPassword(curam.core.facade.struct.UserPasswordDetails dtls)
                                              throws curam.util.exception.AppException,
                                                     curam.util.exception.InformationalException

Method to modify a users password

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyUserPrinter

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

This method will modify the default printer for the user.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyUserSkill

@AccessLevel(value=EXTERNAL)
void modifyUserSkill(curam.core.facade.struct.UserSkillModifyDetails userSkillModifyDetails)
                                           throws curam.util.exception.AppException,
                                                  curam.util.exception.InformationalException

Modifies a user skill.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyUserWorkingPattern

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

Modifies a working pattern for a user.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

positionSearch

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListPositionSearchDetails positionSearch(curam.core.facade.struct.PositionNameAndOrgStructureIDKey key)
                                                                                        throws curam.util.exception.AppException,
                                                                                               curam.util.exception.InformationalException

Method to search for a position within the organization.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

publishOrganizationChanges

@AccessLevel(value=EXTERNAL)
void publishOrganizationChanges()
                                                      throws curam.util.exception.AppException,
                                                             curam.util.exception.InformationalException

This method publishes immediately any changes that are made to the organization.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readAllLocationHoliday

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadAllLocationHolidayDetails_fo readAllLocationHoliday(curam.core.facade.struct.ReadAllLocationHolidayKey_fo key)
                                                                                                       throws curam.util.exception.AppException,
                                                                                                              curam.util.exception.InformationalException

Returns an XML string containing the Location Holidays to be displayed on the calendar.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readBank

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.MaintainBankDetails readBank(curam.core.facade.struct.ReadBankKey key)
                                                                            throws curam.util.exception.AppException,
                                                                                   curam.util.exception.InformationalException

Read all details for a bank.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readBankAccount

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadBankAccountDetails readBankAccount(curam.core.facade.struct.ReadBankAccountKey_fo key)
                                                                                      throws curam.util.exception.AppException,
                                                                                             curam.util.exception.InformationalException

Reads the Bank Account record specified by the input key

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readBankBranch

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.MaintainBankBranchDetails readBankBranch(curam.core.facade.struct.ReadBankBranchKey key)
                                                                                        throws curam.util.exception.AppException,
                                                                                               curam.util.exception.InformationalException

Read all details for a branch.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readCashExclusionDate

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadAllExclusionDateDetails readCashExclusionDate(curam.core.facade.struct.ReadAllExclusionDateKey key)
                                                                                                 throws curam.util.exception.AppException,
                                                                                                        curam.util.exception.InformationalException

Return a list of dates to the Cash payment calendar on which Cash payments cannot be processed by the organization.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readChequeExclusionDate

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadAllExclusionDateDetails readChequeExclusionDate(curam.core.facade.struct.ReadAllExclusionDateKey key)
                                                                                                   throws curam.util.exception.AppException,
                                                                                                          curam.util.exception.InformationalException

Return a list of dates to the Check payment calendar on which Check payments cannot be processed by the organization.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readCurrencyExchange

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.MaintainCurrencyExchangeDetails readCurrencyExchange(curam.core.facade.struct.ReadCurrencyExchangeKey key)
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

Reads the currency exchange record specified by the input key.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readDailySchedule

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.DailyScheduleDetails readDailySchedule(curam.core.facade.struct.DailyScheduleKey dailyScheduleKey)
                                                                                      throws curam.util.exception.AppException,
                                                                                             curam.util.exception.InformationalException

Reads the details of a daily schedule record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readEFTExclusionDate

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadAllExclusionDateDetails readEFTExclusionDate(curam.core.facade.struct.ReadAllExclusionDateKey key)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Return a list of dates to the EFT payment calendar on which EFT payments cannot be processed by the organization.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readExclusionDate

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadExclusionDateDetails readExclusionDate(curam.core.facade.struct.ReadExclusionDateKey_fo key)
                                                                                          throws curam.util.exception.AppException,
                                                                                                 curam.util.exception.InformationalException

To view an exclusion date from the financial calendar for a particular delivery method.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readInvoiceExclusionDate

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadAllExclusionDateDetails readInvoiceExclusionDate(curam.core.facade.struct.ReadAllExclusionDateKey key)
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

Return a list of dates to the Invoice calendar on which invoices cannot be issued by the organization.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readLocation

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadLocationDetails readLocation(curam.core.facade.struct.ReadLocationKey key)
                                                                                throws curam.util.exception.AppException,
                                                                                       curam.util.exception.InformationalException

Reads details about the location specified by the key.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readLocationHoliday

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadLocationHolidayDetails readLocationHoliday(curam.core.facade.struct.ReadLocationHolidayKey key)
                                                                                              throws curam.util.exception.AppException,
                                                                                                     curam.util.exception.InformationalException

Retrieves all information about an existing location holiday.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readOrganizationNonStandardWorkingPattern

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadOrganizationNonStandardWorkingPatternDetails readOrganizationNonStandardWorkingPattern(curam.core.facade.struct.ReadOrganizationNonStandardWorkingPatternKey key)
                                                                                                                                          throws curam.util.exception.AppException,
                                                                                                                                                 curam.util.exception.InformationalException

Returns the details for a non standard working pattern day for an organization.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readOrganizationWorkingPattern

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadOrganizationWorkingPatternDetails readOrganizationWorkingPattern(curam.core.facade.struct.ReadOrganizationWorkingPatternKey key)
                                                                                                                    throws curam.util.exception.AppException,
                                                                                                                           curam.util.exception.InformationalException

Reads a working pattern for an organization.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readOrgUnitCaseApproval

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadOrgUnitCaseApprovalDetails readOrgUnitCaseApproval(curam.core.facade.struct.ReadOrgUnitCaseApprovalKey key)
                                                                                                      throws curam.util.exception.AppException,
                                                                                                             curam.util.exception.InformationalException

Retrieves the details of the specified organization unit case approval check information.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readOrgUnitEvidenceApproval

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadOrgUnitEvidenceApprovalDetails readOrgUnitEvidenceApproval(curam.core.facade.struct.ReadOrgUnitEvidenceApprovalKey readOrgUnitEvidenceApprovalKey)
                                                                                                              throws curam.util.exception.AppException,
                                                                                                                     curam.util.exception.InformationalException

Retrieves the details of the specified evidence approval check information.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readPositionSlotAvailability

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.PositionSlotAvailabilityDetails readPositionSlotAvailability(curam.core.facade.struct.ReadPositionSlotAvailabiliySlotID readPositionSlotAvailabiliySlotID)
                                                                                                            throws curam.util.exception.AppException,
                                                                                                                   curam.util.exception.InformationalException

Reads the details of a position slot availability record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readResource

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadResourceDetails readResource(curam.core.facade.struct.ReadResourceKey key)
                                                                                throws curam.util.exception.AppException,
                                                                                       curam.util.exception.InformationalException

Returns a resource details.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readSlot

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.SlotDetails readSlot(curam.core.facade.struct.SlotKey slotKey)
                                                                    throws curam.util.exception.AppException,
                                                                           curam.util.exception.InformationalException

Reads the details of a slot record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readUser

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadUserDetails_fo readUser(curam.core.facade.struct.ReadUserKey key)
                                                                           throws curam.util.exception.AppException,
                                                                                  curam.util.exception.InformationalException

Reads the User record specified by the input key.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readUserCaseApproval

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadUserCaseApprovalDetails readUserCaseApproval(curam.core.facade.struct.ReadUserCaseApprovalKey key)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Retrieves the details of the specified user case approval check information.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readUserEvidenceApproval

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadUserEvidenceApprovalDetails readUserEvidenceApproval(curam.core.facade.struct.ReadUserEvidenceApprovalKey readUserEvidenceApprovalKey)
                                                                                                        throws curam.util.exception.AppException,
                                                                                                               curam.util.exception.InformationalException

Retrieves the details of the specified evidence approval check information.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readUserNonStandardWorkingPattern

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadUserNonStandardWorkingPatternDetails readUserNonStandardWorkingPattern(curam.core.facade.struct.ReadUserNonStandardWorkingPatternKey key)
                                                                                                                          throws curam.util.exception.AppException,
                                                                                                                                 curam.util.exception.InformationalException

Returns the details for a non standard working pattern day for a user.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readUserWorkingPattern

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadUserWorkingPatternDetails readUserWorkingPattern(curam.core.facade.struct.ReadUserWorkingPatternKey key)
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

Reads a working pattern for a user.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readVoucherExclusionDate

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadAllExclusionDateDetails readVoucherExclusionDate(curam.core.facade.struct.ReadAllExclusionDateKey key)
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

Return a list of dates to the Voucher payment calendar on which Voucher payments cannot be processed by the organization.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

removeCurrencyExchange

@AccessLevel(value=EXTERNAL)
void removeCurrencyExchange(curam.core.facade.struct.RemoveCurrencyExchangeKey key)
                                                  throws curam.util.exception.AppException,
                                                         curam.util.exception.InformationalException

Removes the Currency Exchange record identified by the input key.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

removeReportsToFromPosition

@AccessLevel(value=EXTERNAL)
void removeReportsToFromPosition(curam.core.facade.struct.OrgStructureAndPositionKey key)
                                                       throws curam.util.exception.AppException,
                                                              curam.util.exception.InformationalException

Remove ReportsTo value from a Position.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

removeResourceFromOrgUnit

@AccessLevel(value=EXTERNAL)
void removeResourceFromOrgUnit(curam.core.facade.struct.RemoveResourceFromOrgUnitDetails key)
                                                     throws curam.util.exception.AppException,
                                                            curam.util.exception.InformationalException

Presentation layer operation to remove a resource from a org unit

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

removeUserFromPosition

@AccessLevel(value=EXTERNAL)
void removeUserFromPosition(curam.core.facade.struct.RemoveUserFromPositionKey removeUserFromPositionKey)
                                                  throws curam.util.exception.AppException,
                                                         curam.util.exception.InformationalException

Method to remove user from specified position.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

resolveRootOrganisationUnit

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

Returns the organization unit ID for the root organization unit for the current active structure.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

searchOrganisationUnit

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.OrganisationUnitSearchResults searchOrganisationUnit(curam.core.facade.struct.OrganisationUnitSearchCriteria organisationUnitSearchCriteria)
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

returns a list of organization units based on the search criteria passed in.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

viewJob

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ViewJobDetails viewJob(curam.core.facade.struct.JobKey jobKey)
                                                                      throws curam.util.exception.AppException,
                                                                             curam.util.exception.InformationalException

Method to return job details.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

viewOrganisationUnit

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ViewOrganisationUnitDetails viewOrganisationUnit(curam.core.facade.struct.OrgStructureAndOrgUnitKey key)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Method to return organization unit details.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

viewPosition

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ViewPositionDetails viewPosition(curam.core.facade.struct.OrgStructureAndPositionKey key)
                                                                                throws curam.util.exception.AppException,
                                                                                       curam.util.exception.InformationalException

Method to return position details.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createTemporalEvidenceApprovalCheck
```
@AccessLevel(value=EXTERNAL)
void createTemporalEvidenceApprovalCheck(curam.core.facade.struct.CreateTemporalEvidenceApprovalCheck dtls)
                                                               throws curam.util.exception.AppException,
                                                                      curam.util.exception.InformationalException
```
Create an approval check for a single evidence type. An administrator can define for an organization unit the amount of evidence approval checks on an a particular evidence type by defining a percentage of the total evidence records to check.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

cancelTemporalEvidenceApprovalCheck

@AccessLevel(value=EXTERNAL)
void cancelTemporalEvidenceApprovalCheck(curam.core.facade.struct.TemporalEvidenceApprovalCheckKey key,
                                                                      curam.core.facade.struct.ModifyTemporalEvidenceApprovalCheck details)
                                                               throws curam.util.exception.AppException,
                                                                      curam.util.exception.InformationalException

Cancel an approval check for a single evidence type. An administrator can define for an organization unit the amount of approval checks on an a particular evidence type by defining a percentage of the total evidence records to check. This method cancels an approval check.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readTemporalEvidenceApprovalCheck

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ViewTemporalEvidenceApprovalCheck readTemporalEvidenceApprovalCheck(curam.core.facade.struct.TemporalEvidenceApprovalCheckKey key)
                                                                                                                   throws curam.util.exception.AppException,
                                                                                                                          curam.util.exception.InformationalException

Method to read an evidence approval check record. An administrator can define for an organization unit, position or user the amount of evidence approval checks on a particular evidence type by defining a percentage of the total evidence records to check. The administrator can read the evidence approval check record details.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyTemporalEvidenceApprovalCheck
```
@AccessLevel(value=EXTERNAL)
void modifyTemporalEvidenceApprovalCheck(curam.core.facade.struct.ModifyTemporalEvidenceApprovalCheck dtls)
                                                               throws curam.util.exception.AppException,
                                                                      curam.util.exception.InformationalException
```
Method to modify an evidence approval check record. An administrator can define for an organization unit, position or user the amount of evidence approval checks on a particular evidence type by defining a percentage of the total evidence records to check. The administrator can modify the evidence approval check record details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listTemporalEvidenceApprovalCheckByPosition

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.TemporalEvidenceApprovalCheckList listTemporalEvidenceApprovalCheckByPosition(curam.core.sl.infrastructure.entity.struct.SearchByPositionKey key)
                                                                                                                             throws curam.util.exception.AppException,
                                                                                                                                    curam.util.exception.InformationalException

Method to list evidence approval checks for a position. An administrator can define for a position the amount of evidence approval checks on an a particular evidence type by defining a percentage of the total evidence records to check. The administrator can retrieve the list all evidence approval checks by the position.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listTemporalEvidenceApprovalCheckByUser

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.TemporalEvidenceApprovalCheckList listTemporalEvidenceApprovalCheckByUser(curam.core.sl.entity.struct.SearchByUserKey key)
                                                                                                                         throws curam.util.exception.AppException,
                                                                                                                                curam.util.exception.InformationalException

Method to list evidence approval checks for a a system user. An administrator can define for a user the amount of evidence approval checks on an a particular evidence type by defining a percentage of the total evidence records to check. The administrator can retrieve the list all evidence approval checks by user.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listTemporalEvidenceApprovalCheckByOrgUnit

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.TemporalEvidenceApprovalCheckList listTemporalEvidenceApprovalCheckByOrgUnit(curam.core.sl.entity.struct.SearchByOrgUnitKey key)
                                                                                                                            throws curam.util.exception.AppException,
                                                                                                                                   curam.util.exception.InformationalException

Method to list evidence approval checks for a an organization unit. An administrator can define for an organization unit the amount of evidence approval checks on an a particular evidence type by defining a percentage of the total evidence records to check. The administrator can retrieve the list all evidence approval checks by the organization unit.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listEvidenceTypes

@AccessLevel(value=EXTERNAL)
curam.core.sl.infrastructure.entity.struct.EvidenceTypeList listEvidenceTypes()
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

Method to return a list of evidence types registered with the system. The application can display a list of all evidence types defined on the system.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listResolutionApprovalCheckForUser

@Deprecated
 @AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListUserResolutionApprovalCheckDetails listResolutionApprovalCheckForUser(curam.core.facade.struct.ListUserResolutionApprovalCheckKey listUserResolutionApprovalCheckKey)
                                                                                                                                      throws curam.util.exception.AppException,
                                                                                                                                             curam.util.exception.InformationalException

Deprecated. Since Curam 6.0.5.0, replaced with listResolutionApprovalCheckForUserAndVersionNo(). This method is being deprecated as the return struct does not have versionNo attribute. This method lists all existing approval checks for a user.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createResolutionApprovalCheckForUser

@AccessLevel(value=EXTERNAL)
void createResolutionApprovalCheckForUser(curam.core.facade.struct.IssueResolutionApprovalCheckDetails issueResolutionApprovalCheckDetails)
                                                                throws curam.util.exception.AppException,
                                                                       curam.util.exception.InformationalException

This method allows an administrator to configure an approval check for a user. It allows a percentage of resolutions on issues which are submitted for approval to be reviewed.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listCurrencyExchangeByDates

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListCurrencyExchangeDetails listCurrencyExchangeByDates(curam.core.struct.OrgCurrencyExchangeSearchKey key)
                                                                                                       throws curam.util.exception.AppException,
                                                                                                              curam.util.exception.InformationalException

Method to return a history of all currency exchange rates recorded on the system given a date range. An administrator can define currency exchange rates for an organization by currency and date range. The administrator can retrieve the history of all currency exchange rates for a given date range.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyResolutionApprovalCheckForUser

@AccessLevel(value=EXTERNAL)
void modifyResolutionApprovalCheckForUser(curam.core.facade.struct.IssueResolutionApprovalCheckDetails issueResolutionApprovalCheckDetails)
                                                                throws curam.util.exception.AppException,
                                                                       curam.util.exception.InformationalException

This method allows an administrator to modify an Issue Resolution Approval Check for a user.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelResolutionApprovalCheckForUser

@AccessLevel(value=EXTERNAL)
void cancelResolutionApprovalCheckForUser(curam.core.facade.struct.CancelIssueResolutionApprovalCheckKey cancelIssueResolutionApprovalCheckKey)
                                                                throws curam.util.exception.AppException,
                                                                       curam.util.exception.InformationalException

This method allows an administrator to cancel an Issue Resolution Approval Check for a user.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readResolutionApprovalCheckForUser

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadUserResolutionApprovalCheckDetails readResolutionApprovalCheckForUser(curam.core.facade.struct.ReadIssueResolutionApprovalCheckKey readIssueResolutionApprovalCheckKey)
                                                                                                                         throws curam.util.exception.AppException,
                                                                                                                                curam.util.exception.InformationalException

This method allows an administrator to view a resolution approval check for a user.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listAvailableIssuesForApprovalCheck

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

Lists all issues that are available to be selected for Issue Resolution approval checks.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createResolutionApprovalCheckForOrgUnit

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

This method allows an administrator to configure an approval check for an org unit. It allows a percentage of resolutions on issues which are submitted for approval to be reviewed.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelResolutionApprovalCheckForOrgUnit

@AccessLevel(value=EXTERNAL)
void cancelResolutionApprovalCheckForOrgUnit(curam.core.facade.struct.CancelIssueResolutionApprovalCheckKey key)
                                                                   throws curam.util.exception.AppException,
                                                                          curam.util.exception.InformationalException

This method allows an administrator to cancel an Issue Resolution Approval Check for an org unit.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyResolutionApprovalCheckForOrgUnit

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

This method allows an administrator to modify an Issue Resolution Approval Check for an org unit.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readResolutionApprovalCheckForOrgUnit

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadOrgUnitResolutionApprovalCheckDetails readResolutionApprovalCheckForOrgUnit(curam.core.facade.struct.ReadIssueResolutionApprovalCheckKey readIssueResolutionApprovalCheckKey)
                                                                                                                               throws curam.util.exception.AppException,
                                                                                                                                      curam.util.exception.InformationalException

This method allows an administrator to view a resolution approval check for an org unit.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listResolutionApprovalCheckForOrgUnit

@Deprecated
 @AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListOrgUnitResolutionApprovalCheckDetails listResolutionApprovalCheckForOrgUnit(curam.core.facade.struct.ListOrgUnitResolutionApprovalCheckKey key)
                                                                                                                                            throws curam.util.exception.AppException,
                                                                                                                                                   curam.util.exception.InformationalException

Deprecated. Since Curam 6.0.5.0, replaced with listResolutionApprovalCheckForOrgUnitAndVersionNo() This method is being deprecated as the return struct does not have versionNo attribute. This method lists all existing approval checks for an org unit.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listLocationStructure

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListLocationStructureDetails listLocationStructure(curam.core.struct.OrganisationKey key)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Method to list the location structure details.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createLocationStructure

@AccessLevel(value=EXTERNAL)
void createLocationStructure(curam.core.facade.struct.CreateLocationStructureDetails dtls)
                                                   throws curam.util.exception.AppException,
                                                          curam.util.exception.InformationalException

Method to save the Location Structure details.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelLocationStructure

@AccessLevel(value=EXTERNAL)
void cancelLocationStructure(curam.core.facade.struct.CancelLocationStructureDetails dtls)
                                                   throws curam.util.exception.AppException,
                                                          curam.util.exception.InformationalException

Method to set the Status of the Location Structure to be Canceled.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readLocationStructure

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadLocationStructureDetails readLocationStructure(curam.core.facade.struct.LocationStructureKey key)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Method to read the Location Structure Details.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyLocationStructure

@AccessLevel(value=EXTERNAL)
void modifyLocationStructure(curam.core.facade.struct.ModifyLocationStructureDetails dtls)
                                                   throws curam.util.exception.AppException,
                                                          curam.util.exception.InformationalException

Method to modify the location structure details.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

activateLocationStructure
```
@AccessLevel(value=EXTERNAL)
void activateLocationStructure(curam.core.facade.struct.ActivateLocationStructureDetails dtls)
                                                     throws curam.util.exception.AppException,
                                                            curam.util.exception.InformationalException
```
Method to activate the Location Structure, assigns an activation date to the Structure. The status of the Location Structure will updated to Active and the existing active Location Structure will have a status of Superseded.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

getLocationStructureTreeXML

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadXMLDetails getLocationStructureTreeXML(curam.core.facade.struct.LocStructureAndLocKey key)
                                                                                          throws curam.util.exception.AppException,
                                                                                                 curam.util.exception.InformationalException

Method to return an xml string representing a location structure. The application uses the location structure tree xml to render a tree view of the location structure in the client screens.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readParentLocationDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ParentLocationIDDetails readParentLocationDetails(curam.core.facade.struct.ReadParentLocationKey key)
                                                                                                 throws curam.util.exception.AppException,
                                                                                                        curam.util.exception.InformationalException

Method to read the parent locationID details for a location

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

getOrganisationStructureTreeXML

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadXMLDetails getOrganisationStructureTreeXML(curam.core.sl.struct.OrgStructureOrgUnitPositionKey key)
                                                                                              throws curam.util.exception.AppException,
                                                                                                     curam.util.exception.InformationalException

Method to return an xml string representing an organization structure. The application uses the organization structure tree xml to render a tree view of the organization structure in the client screens.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listLocationsForLocationStructure

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadLocationListForLocationStructure listLocationsForLocationStructure(curam.core.facade.struct.LocationStructureKey key)
                                                                                                                      throws curam.util.exception.AppException,
                                                                                                                             curam.util.exception.InformationalException

Returns a list of locations for the location structure.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createRootLocation

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

Create a Root Location for a Location Structure

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

removeLocationfromOrgUnit

@AccessLevel(value=EXTERNAL)
void removeLocationfromOrgUnit(curam.core.facade.struct.OrgUnitLocationDetails key)
                                                     throws curam.util.exception.AppException,
                                                            curam.util.exception.InformationalException

Method used to remove a location from an organization unit. An administrator can remove an organization unit's location.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

assignLocationtoOrgUnit

@AccessLevel(value=EXTERNAL)
void assignLocationtoOrgUnit(curam.core.facade.struct.OrgUnitLocationDetails key)
                                                   throws curam.util.exception.AppException,
                                                          curam.util.exception.InformationalException

Method used to assign a location to an organization unit. An administrator updates an organization unit by assigning a location to it.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listOrganizationSIDs

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

Method to return a list of defined Security ID's for the organization. A system administrator can define SID's for an organization. An administrator can choose from the list of defined SID's when setting security for an organization.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listLocationSIDs

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

Method to return a list of defined Security ID's for locations. A system administrator can define SID's for locations. An administrator can choose from the list of defined SID's when setting security for a location.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readCloseUserDetails

@AccessLevel(value=EXTERNAL)
curam.core.struct.UserSupervisorAndLeadPositionInd readCloseUserDetails(curam.core.struct.UserKeyStruct key)
                                                                                              throws curam.util.exception.AppException,
                                                                                                     curam.util.exception.InformationalException

Reads the details to display on close user page.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

reopenUser

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

Inserts the details to reopen the User.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listAllUsersForPosition

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListUserForPositionDetails listAllUsersForPosition(curam.core.facade.struct.OrgStructureAndPositionKey key)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Method to return a list of users assigned to a position in the organization. An administrator can view a list of users who are assigned to a position in the organization.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

assignResourceToLocation

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

Assign Resource to Location

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

searchActiveResourcesByType

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListActiveResourcesDetails searchActiveResourcesByType(curam.core.facade.struct.ResourceSearchKey key)
                                                                                                      throws curam.util.exception.AppException,
                                                                                                             curam.util.exception.InformationalException

List all active resources by type

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

removeLocationResource
```
@AccessLevel(value=EXTERNAL)
void removeLocationResource(curam.core.facade.struct.RemoveResourceKey key)
                                                  throws curam.util.exception.AppException,
                                                         curam.util.exception.InformationalException
```
removes the resource from a location only, if remove from related locations is not selected. Removes the resource from all locations where this resource exists if remove from related locations is selected. The status of the resource record is set to Canceled, the Resource Status is set to Closed

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

createLocationResource

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

Creates a location resource

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

resolveCaseOwnerHome

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CaseOwnerPageIdentifierResult resolveCaseOwnerHome(curam.core.sl.struct.OrgObjectReferenceOrgObjectType key)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Returns the home page name for the Case Owner. The Case Owners are either a User, a Position, an Org Unit or a Work Queue.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

assignLocationToPosition

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

This method assigns a location to a position

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

removeLocationFromPosition

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

This method removes a location assigned to a position

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createOrganisationUnitResource

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

Method to create a resource for an organization unit. An administrator can create a resource such as a printer or a meeting room for an organization unit.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

viewLocationDetailsForPosition

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.LocationDetailsForPositionHomeList viewLocationDetailsForPosition(curam.core.facade.struct.PositionIDKey key)
                                                                                                                 throws curam.util.exception.AppException,
                                                                                                                        curam.util.exception.InformationalException

Method to return a list of locations associated with a position. An administrator can view the list of locations associated with the given position.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

removeLocationAccess

@AccessLevel(value=EXTERNAL)
void removeLocationAccess(curam.core.facade.struct.RemoveLocationAccessKey key)
                                                throws curam.util.exception.AppException,
                                                       curam.util.exception.InformationalException

remove additional location access

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listActiveLocations

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListActiveLocationDetails listActiveLocations(curam.core.facade.struct.LocationSearchKey key)
                                                                                             throws curam.util.exception.AppException,
                                                                                                    curam.util.exception.InformationalException

Search active locations by type

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

assignLocationAccess

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

Assign additional location access

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listOrgUnitsForUser

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

Returns a list of organization units for which the user is a member.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listPositionsForUser

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

Returns a list of positions for which the user is a member.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createAndAssignUserForPosition

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

Method to create a user and assign them to an existing position. An administrator, for a given position in an organization, can create a new user and assign them to the position in one action.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listActiveLocationsForOrg

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListActiveLocationDetails listActiveLocationsForOrg(curam.core.facade.struct.OrgLocationSearchKey key)
                                                                                                   throws curam.util.exception.AppException,
                                                                                                          curam.util.exception.InformationalException

Search all active and operating locations for organization units

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

getUserType

@AccessLevel(value=EXTERNAL)
curam.core.sl.struct.UserType getUserType(curam.core.struct.UsersKey key)
                                                                throws curam.util.exception.AppException,
                                                                       curam.util.exception.InformationalException

Method to determine the type of a user (internal or external) using their user access name. The application can differentiate between internal and external users by querying the user access table by user name.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listAllIntegratedCaseTypes

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

Method to list all integrated case types.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

clearTaskRedirectionForUser
```
@AccessLevel(value=EXTERNAL)
void clearTaskRedirectionForUser(curam.core.sl.struct.ClearTaskRedirectionDetails key)
                                                       throws curam.util.exception.AppException,
                                                              curam.util.exception.InformationalException
```
Clears an active or pending task redirection record. If the task redirection period is active, then the end date time of the task redirection record is updated to be the current date time. If the task redirection period is pending, the task redirection record is simply removed.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

setOrganisationTreeXMLNodeDetails

@AccessLevel(value=EXTERNAL)
void setOrganisationTreeXMLNodeDetails(curam.core.facade.struct.OrganisationStructureKey key)
                                                             throws curam.util.exception.AppException,
                                                                    curam.util.exception.InformationalException

Takes the Organization Structure as a parameter for which the last accessed Node needs to be modified

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

setLocationTreeXMLNodeDetails

@AccessLevel(value=EXTERNAL)
void setLocationTreeXMLNodeDetails(curam.core.facade.struct.LocationStructureKey key)
                                                         throws curam.util.exception.AppException,
                                                                curam.util.exception.InformationalException

Takes the Location Structure Id as a parameter for which the last accessed Node needs to be modified

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createLocationWorkingPattern

@AccessLevel(value=EXTERNAL)
void createLocationWorkingPattern(curam.core.struct.WorkingPatternDetails details)
                                                        throws curam.util.exception.AppException,
                                                               curam.util.exception.InformationalException

This method creates a new working pattern for the location.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listLocationWorkingPattern

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListLocationWorkingPatternDetails listLocationWorkingPattern(curam.core.struct.LocationKey locationKey)
                                                                                                            throws curam.util.exception.AppException,
                                                                                                                   curam.util.exception.InformationalException

This method lists all of the working patterns for a specified location.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readLocationWorkingPattern

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadLocationWorkingPatternDetails readLocationWorkingPattern(curam.core.struct.WorkingPatternKey workingPatternKey)
                                                                                                            throws curam.util.exception.AppException,
                                                                                                                   curam.util.exception.InformationalException

This method reads the details of the specified working pattern.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyLocationWorkingPattern

@AccessLevel(value=EXTERNAL)
void modifyLocationWorkingPattern(curam.core.struct.WorkingPatternDetails details)
                                                        throws curam.util.exception.AppException,
                                                               curam.util.exception.InformationalException

This method modifies the details of a location working pattern.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelLocationWorkingPattern

@AccessLevel(value=EXTERNAL)
void cancelLocationWorkingPattern(curam.core.struct.WorkingPatternKey workingPatternKey)
                                                        throws curam.util.exception.AppException,
                                                               curam.util.exception.InformationalException

This method cancels the specified working pattern for the location.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

maintainLocationNonStandardWorkingPattern

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

This method creates or modifies a non-standard working pattern or changes the pattern type for the day for a location.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readLocationNonStandardWorkingPattern

@AccessLevel(value=EXTERNAL)
curam.core.struct.WorkingPatternDetails readLocationNonStandardWorkingPattern(curam.core.struct.NSPatternByDayIndexKey key)
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

This method reads the non-standard working pattern details for a specific day for a location.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listInvestigationApprovalCheckForUser

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListUserInvestigationApprovalCheckDetails listInvestigationApprovalCheckForUser(curam.core.facade.struct.ListUserInvestigationApprovalCheckKey key)
                                                                                                                               throws curam.util.exception.AppException,
                                                                                                                                      curam.util.exception.InformationalException

This method lists all existing approval checks for a user.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createInvestigationApprovalCheckForUser

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

This method allows an administrator to configure an approval check for a user. It allows a percentage of investigations which are submitted for approval to be reviewed.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyInvestigationApprovalCheckForUser

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

This method allows an administrator to modify an Investigation Approval Check for a user.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelInvestigationApprovalCheckForUser

@AccessLevel(value=EXTERNAL)
void cancelInvestigationApprovalCheckForUser(curam.core.facade.struct.CancelInvestigationApprovalCheckKey key)
                                                                   throws curam.util.exception.AppException,
                                                                          curam.util.exception.InformationalException

This method allows an administrator to cancel an Investigation Approval Check for a user.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readInvestigationApprovalCheckForUser

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadUserInvestigationApprovalCheckDetails readInvestigationApprovalCheckForUser(curam.core.facade.struct.ReadInvestigationApprovalCheckKey key)
                                                                                                                               throws curam.util.exception.AppException,
                                                                                                                                      curam.util.exception.InformationalException

This method allows an administrator to view a approval check for a user.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listAvailableInvestigationsForApprovalCheck

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

Lists all investigations that are available to be selected for Investigation Resolution approval checks.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createInvestigationApprovalCheckForOrgUnit

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

Allows an administrator to configure an approval check for an org unit. It allows a percentage of investigations which are submitted for approval to be reviewed.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelInvestigationApprovalCheckForOrgUnit

@AccessLevel(value=EXTERNAL)
void cancelInvestigationApprovalCheckForOrgUnit(curam.core.facade.struct.CancelInvestigationApprovalCheckKey key)
                                                                      throws curam.util.exception.AppException,
                                                                             curam.util.exception.InformationalException

This method allows an administrator to cancel an Investigation Approval Check for an org unit.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyInvestigationApprovalCheckForOrgUnit

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

This method allows an administrator to modify an Investigation Approval Check for an org unit.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listInvestigationApprovalCheckForOrgUnit

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListOrgUnitInvestigationApprovalCheckDetails listInvestigationApprovalCheckForOrgUnit(curam.core.facade.struct.ListOrgUnitInvestigationApprovalCheckKey key)
                                                                                                                                     throws curam.util.exception.AppException,
                                                                                                                                            curam.util.exception.InformationalException

This method lists all existing approval checks for an org unit.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readInvestigationApprovalCheckForOrgUnit

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadOrgUnitInvestigationApprovalCheckDetails readInvestigationApprovalCheckForOrgUnit(curam.core.facade.struct.ReadInvestigationApprovalCheckKey key)
                                                                                                                                     throws curam.util.exception.AppException,
                                                                                                                                            curam.util.exception.InformationalException

Allows an administrator to view a approval check for an org unit.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

getUserApplicationHome

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

Method to determine the Application home page (internal) using their user access name.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createAnnouncement

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

This method allows an administrator to configure an organization wide announcement. This announcement will appear on the user's home page when they log on.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelAnnouncement

@AccessLevel(value=EXTERNAL)
void cancelAnnouncement(curam.core.sl.entity.struct.AnnouncementKey key)
                                              throws curam.util.exception.AppException,
                                                     curam.util.exception.InformationalException

This method will change the record status of an announcement from Active to Canceled.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listAnnouncements

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

Method to allow an administrator to list all active and cancelled announcements configured for the organization.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readAnnouncement

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.AnnouncementDtls readAnnouncement(curam.core.sl.entity.struct.AnnouncementKey key)
                                                                                 throws curam.util.exception.AppException,
                                                                                        curam.util.exception.InformationalException

Method to allow an administrator to read the details of a specified announcement that has been configured for the organization.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyAnnouncement

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

Method to allow an administrator to modify the details of a specified announcement that has been configured for the organization.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createQuickLink

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

Creates a quick link for the organization. Quick links can be associated with a users security role.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyQuickLink

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

Method to allow an administrator to modify the details of a specified quick link that has been recorded for the organization.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelQuickLink

@AccessLevel(value=EXTERNAL)
void cancelQuickLink(curam.core.sl.entity.struct.QuickLinkKey key)
                                           throws curam.util.exception.AppException,
                                                  curam.util.exception.InformationalException

This method will change the record status of a quick link from Active to Canceled.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listQuickLinks

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

This method lists all the quick links recorded for the organization.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readQuickLink

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.QuickLinkDetails readQuickLink(curam.core.sl.entity.struct.QuickLinkKey key)
                                                                              throws curam.util.exception.AppException,
                                                                                     curam.util.exception.InformationalException

Method to allow an administrator to read the details of a specified quick link that has been recorded for the organization.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

addQuickLinkForApplicationCode

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

Creates an association between a quick link and a user security role.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

removeQuickLinkFromApplicationCode

@AccessLevel(value=EXTERNAL)
void removeQuickLinkFromApplicationCode(curam.core.sl.entity.struct.QuickLinkApplicationLinkKey key)
                                                              throws curam.util.exception.AppException,
                                                                     curam.util.exception.InformationalException

Removes an association between a quick link and a user security role.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listQuickLinkForApplicationCode

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.QuickLinkApplicationDetailsList listQuickLinkForApplicationCode(curam.core.sl.entity.struct.ApplicationCodeKey key)
                                                                                                               throws curam.util.exception.AppException,
                                                                                                                      curam.util.exception.InformationalException

Retrieves the list of quick links associated with the specified user security role.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listUnassociatedQuickLinks

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.QuickLinkDetailsList listUnassociatedQuickLinks(curam.core.sl.entity.struct.ApplicationCodeKey key)
                                                                                               throws curam.util.exception.AppException,
                                                                                                      curam.util.exception.InformationalException

Lists quick links which have not yet been associated with the specified user security role.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

getCurrentUser

@AccessLevel(value=EXTERNAL)
curam.core.sl.struct.UserNameAndFullName getCurrentUser()
                                                                              throws curam.util.exception.AppException,
                                                                                     curam.util.exception.InformationalException

Method to get current user details.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createAndAddQuickLinkToApplicationCode

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

Creates a new quick link record and associates it with a security role. Called when a user creates a new quick link from within the organization security role administration.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readReport

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReportDetails readReport(curam.core.sl.entity.struct.ReportKey key)
                                                                        throws curam.util.exception.AppException,
                                                                               curam.util.exception.InformationalException

Method to allow an administrator to read the details of a specified report that has been recorded for the organization.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listAllReports

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

This method lists all the reports recorded for the organization.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

addReportToSecurityRole

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

Creates an association between a report and a security role.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listUnassociatedReportForSecurityRole

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReportDetailsList listUnassociatedReportForSecurityRole(curam.core.sl.entity.struct.RoleNameKey key)
                                                                                                       throws curam.util.exception.AppException,
                                                                                                              curam.util.exception.InformationalException

Lists reports which have not yet been associated with the specified security role.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listReportForSecurityRole

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReportSecurityRoleDetailsList listReportForSecurityRole(curam.core.sl.entity.struct.RoleNameKey key)
                                                                                                       throws curam.util.exception.AppException,
                                                                                                              curam.util.exception.InformationalException

Retrieves the list of reports associated with the specified security role.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

removeReportFromSecurityRole

@AccessLevel(value=EXTERNAL)
void removeReportFromSecurityRole(curam.core.sl.entity.struct.ReportSecurityRoleLinkKey key)
                                                        throws curam.util.exception.AppException,
                                                               curam.util.exception.InformationalException

Removes an association between a report and a security role.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

addReportForUser

@AccessLevel(value=EXTERNAL)
void addReportForUser(curam.core.facade.struct.ReportUserLinkDetails dtls)
                                            throws curam.util.exception.AppException,
                                                   curam.util.exception.InformationalException

Creates an association between a report and a user.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listReportForUser

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReportUserDetailsList listReportForUser(curam.core.sl.entity.struct.UserKey key)
                                                                                       throws curam.util.exception.AppException,
                                                                                              curam.util.exception.InformationalException

Retrieves the list of reports associated with the specified user.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listUnassociatedReportForUser

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReportDetailsList listUnassociatedReportForUser(curam.core.sl.entity.struct.UserKey key)
                                                                                               throws curam.util.exception.AppException,
                                                                                                      curam.util.exception.InformationalException

Lists reports which have not yet been associated with the specified user.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

removeReportForUser

@AccessLevel(value=EXTERNAL)
void removeReportForUser(curam.core.sl.entity.struct.ReportUserLinkKey key)
                                               throws curam.util.exception.AppException,
                                                      curam.util.exception.InformationalException

Removes an association between a report and a user.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readUserSummaryDetails1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.UserSummaryDetails1 readUserSummaryDetails1(curam.core.facade.struct.UserSummaryDetailsKey key)
                                                                                           throws curam.util.exception.AppException,
                                                                                                  curam.util.exception.InformationalException

Method to return a summary of a user's details. An administrator can view a summary of a user's details such as their role, organization unit and status.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readPositionDetailsAndUserList

@AccessLevel(value=EXTERNAL)
curam.core.sl.struct.PositionDetailsAndUserList readPositionDetailsAndUserList(curam.core.sl.entity.struct.OrgStructureAndPositionKey key)
                                                                                                     throws curam.util.exception.AppException,
                                                                                                            curam.util.exception.InformationalException

Returns position details and assigned user list.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readOrganisationUnitDetailsAndUserList

@AccessLevel(value=EXTERNAL)
curam.core.sl.struct.OrganisationUnitDetailsAndUserList readOrganisationUnitDetailsAndUserList(curam.core.sl.entity.struct.OrgStructureAndOrgUnitKey key)
                                                                                                                     throws curam.util.exception.AppException,
                                                                                                                            curam.util.exception.InformationalException

Returns organization unit details and assigned user list.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listRecentAssignedCasesForUserCurrentlyOwned

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

Lists recently assigned integrated and product delivery cases to a user currently owned by current user or current user organization object.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listRecentViewedCasesForUser1

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

Lists integrated and product delivery cases recently viewed by a user.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listRecentApprovedCasesForUserSubmittedOrOwned

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

Lists recently approved integrated and product delivery cases submitted by current user or currently owned by current user or current user organization object.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

userDetailsSearch
```
@Deprecated
 @AccessLevel(value=EXTERNAL)
curam.core.facade.struct.UserSearchDetailsResults userDetailsSearch(curam.core.facade.struct.UserSearchKey key)
                                                                                                       throws curam.util.exception.AppException,
                                                                                                              curam.util.exception.InformationalException
```
Deprecated. Since Curam 6.0 SP2, replaced with searchUserDetails(UserSearchKey). This method is being deprecated because it is not returning any informational messages. So this replaced by new method searchUserDetails(UserSearchKey key) which returns the informational message as well . See release note: CS-09152/CR00282028

Presentation layer operation to search for a user within the organization.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

activeUserDetailsSearch
```
@Deprecated
 @AccessLevel(value=EXTERNAL)
curam.core.facade.struct.UserSearchDetailsResults activeUserDetailsSearch(curam.core.facade.struct.UserSearchKey key)
                                                                                                             throws curam.util.exception.AppException,
                                                                                                                    curam.util.exception.InformationalException
```
Deprecated. Since Curam 6.0 SP2, replaced with searchActiveUserDetails(UserSearchKey). This method is deprecated as informational messages are not returned. This method is replaced by searchActiveUserDetails(UserSearchKey) which returns the informational message along with user details as well. See release note: CS-09152/CR00282028.

Returns a list of active users based on the search criteria passed in.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

createAdminIntegratedCase1

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

Creates an Admin Integrated Case record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyAdminIntegratedCase1

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

Modifies details of an Admin Integrated Case record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readAdminIntegratedCase1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadAdminIntegratedCaseDetails1 readAdminIntegratedCase1(curam.core.facade.struct.ReadAdminIntegratedCaseKey_fo key)
                                                                                                        throws curam.util.exception.AppException,
                                                                                                               curam.util.exception.InformationalException

Reads the details of an Admin Integrated Case.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

getIntegratedCaseDefaultValues

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

Returns default details to create new integrated case.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listOrganisationUnitLocation

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListLocationForOrganisationUnit listOrganisationUnitLocation(curam.core.facade.struct.OrgStructureAndOrgUnitKey key)
                                                                                                            throws curam.util.exception.AppException,
                                                                                                                   curam.util.exception.InformationalException

Method to return organization unit location details.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listAllEvidenceTypesByAdminIntegratedCaseID

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ICEvidenceTypeDetailsList listAllEvidenceTypesByAdminIntegratedCaseID(curam.core.struct.AdminIntegratedCaseKey key)
                                                                                                                     throws curam.util.exception.AppException,
                                                                                                                            curam.util.exception.InformationalException

Retrieves evidence types associated with a specified admin integrated case, both static and dynamic

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listRecentAssignedInvestigationForUserCurrentlyOwned

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

Lists recently assigned investigations to a user currently owned by current user or current user organization object.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listRecentViewedInvestigationForUser

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

Lists investigations recently viewed by a user.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listRecentApprovedInvestigationForUserSubmittedOrOwned

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

Lists recently approved investigations submitted by current user or currently owned by current user or current user organization object.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createUserSkillLanguages
```
@Deprecated
 @AccessLevel(value=EXTERNAL)
void createUserSkillLanguages(curam.core.facade.struct.UserLanguageSkillCreationDetails key)
                                                                 throws curam.util.exception.AppException,
                                                                        curam.util.exception.InformationalException
```
Deprecated. Since Curam 6.0.5.0, replaced with createUserSkillsLanguages(UserLanguageSkillCreationDetails) This method is deprecated because of the new requirement where informational has to be return when the redetermination of translator required runs on batch. See release note: CR00341851.

This method is to create user skill language details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

viewUserLanguagesSkill

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.UserSkillLanguageDetails viewUserLanguagesSkill(curam.core.facade.struct.UserSkillKey key)
                                                                                               throws curam.util.exception.AppException,
                                                                                                      curam.util.exception.InformationalException

This method returns User Language Details

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readApplicationSearchRecord

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ApplicationSearchDetails readApplicationSearchRecord(curam.core.sl.struct.ApplicationSearchKey key)
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

Allows a User to read single record across all defined Application Objects e.g. Cases, Participants etc.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelPositionByWorkflow

@AccessLevel(value=EXTERNAL)
void cancelPositionByWorkflow(curam.core.facade.struct.CancelPositionByWorkFlowKey cancelPositionKey)
                                                    throws curam.util.exception.AppException,
                                                           curam.util.exception.InformationalException

Cancels a position by enacting a workflow process.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

taskRedirectionsForUserDetails
```
@AccessLevel(value=EXTERNAL)
void taskRedirectionsForUserDetails(curam.core.sl.struct.TaskRedirectionsForUserDetails key)
                                                          throws curam.util.exception.AppException,
                                                                 curam.util.exception.InformationalException
```
Creates a task redirection record for the specified user. This record specifies another user to whom tasks for the specified user will be redirected to. A start and end date time is also specified for each task redirection record and this allows the creation of task redirections for future dates.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readOrganizationUserHomePage

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadOrganizationUserHomePageDetails readOrganizationUserHomePage(curam.core.facade.struct.ReadUserHomePageKey key)
                                                                                                                throws curam.util.exception.AppException,
                                                                                                                       curam.util.exception.InformationalException

Reads the User record specified by the input key.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

closeOrganizationUser

@AccessLevel(value=EXTERNAL)
curam.core.struct.InformationalMsgDtlsList closeOrganizationUser(curam.core.facade.struct.CloseOrganizationUserDetails details)
                                                                                       throws curam.util.exception.AppException,
                                                                                              curam.util.exception.InformationalException

The function of this method is to close the user account on the system.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

getTaskRedirectionHistoryForUser

@AccessLevel(value=EXTERNAL)
curam.core.sl.supervisor.struct.TaskRedirectionsFromUserDetails getTaskRedirectionHistoryForUser(curam.core.struct.UserNameKey key)
                                                                                                                       throws curam.util.exception.AppException,
                                                                                                                              curam.util.exception.InformationalException

Returns a list of the task redirection records for a specified user. Two lists of data are returned. The first contains the details of the all the active and pending task redirection records for the specified user. The second list contains a list of all the expired task redirection history records for the specified user.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

getAnnouncementsAsXML

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

Return the set of Announcements that fall in the current time frame as a String formatted in XML.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

addDescriptionTextTranslation

@AccessLevel(value=EXTERNAL)
void addDescriptionTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails localizableTextDetails)
                                                         throws curam.util.exception.AppException,
                                                                curam.util.exception.InformationalException

This method is intended to be used by users responsible for creating text translations for Organisation description.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyDescriptionTextTranslation

@AccessLevel(value=EXTERNAL)
void modifyDescriptionTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails localizableTextDetails)
                                                            throws curam.util.exception.AppException,
                                                                   curam.util.exception.InformationalException

This method is intended to be used by users responsible for modifying the text translations for the Organisation attribute,

description.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readDescriptionTextTranslation

@AccessLevel(value=EXTERNAL)
curam.workspaceservices.facade.struct.TextTranslationDetails readDescriptionTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails localizableTextDetails)
                                                                                                                  throws curam.util.exception.AppException,
                                                                                                                         curam.util.exception.InformationalException

This method is intended to be used by users responsible for reading the text translations for the Organisation attribute,

description.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listLocalizableDescriptionText

@AccessLevel(value=EXTERNAL)
curam.workspaceservices.facade.struct.ViewLocalizableTextDetails listLocalizableDescriptionText(curam.workspaceservices.facade.struct.LocalizableTextDetails localizableTextDetails)
                                                                                                                      throws curam.util.exception.AppException,
                                                                                                                             curam.util.exception.InformationalException

This method is intended to be used by users for listing the text translations for the Organisation attribute,

description.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyOrganization1

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

This method is intended to be used by users responsible for modifying Organization details.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

addNameTextTranslation

@AccessLevel(value=EXTERNAL)
void addNameTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails localizableTextDetails)
                                                  throws curam.util.exception.AppException,
                                                         curam.util.exception.InformationalException

This method is intended to be used by users responsible for creating text translations for Organisation name.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyNameTextTranslation

@AccessLevel(value=EXTERNAL)
void modifyNameTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails localizableTextDetails)
                                                     throws curam.util.exception.AppException,
                                                            curam.util.exception.InformationalException

This method is intended to be used by users responsible for modifying the text translations for the Organisation attribute,

name.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listLocalizableNameText

@AccessLevel(value=EXTERNAL)
curam.workspaceservices.facade.struct.ViewLocalizableTextDetails listLocalizableNameText(curam.workspaceservices.facade.struct.LocalizableTextDetails localizableTextDetails)
                                                                                                               throws curam.util.exception.AppException,
                                                                                                                      curam.util.exception.InformationalException

This method is intended to be used by users for listing the text translations for the Organisation attribute,

name.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readNameTextTranslation

@AccessLevel(value=EXTERNAL)
curam.workspaceservices.facade.struct.TextTranslationDetails readNameTextTranslation(curam.workspaceservices.facade.struct.LocalizableTextDetails localizableTextDetails)
                                                                                                           throws curam.util.exception.AppException,
                                                                                                                  curam.util.exception.InformationalException

This method is intended to be used by users responsible for reading the text translations for the Organisation attribute,

name.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createBankAccountWithTextSortCode

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

Inserts a new Bank Account for an Organization.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyBankAccountWithTextSortCode

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

Modifies Bank Account details

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listOrgUnitForOrgStructureWithVersionNo

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListOrganisationUnitForOrgStructureWithVersionNoDetails listOrgUnitForOrgStructureWithVersionNo(curam.core.facade.struct.OrganisationStructureKey key)
                                                                                                                                               throws curam.util.exception.AppException,
                                                                                                                                                      curam.util.exception.InformationalException

Method to return all organization units for specified organization structure.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listChildUnitForOrgUnitWithVersionNo

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListOrganisationUnitForOrgUnitWithVersionNoDetails listChildUnitForOrgUnitWithVersionNo(curam.core.facade.struct.OrgStructureAndOrgUnitKey key)
                                                                                                                                       throws curam.util.exception.AppException,
                                                                                                                                              curam.util.exception.InformationalException

Method to return all child organization units for specified organization unit.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listJobForOrgUnitWithVersionNo

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListJobForOrgUnitWithVersionNoDetails listJobForOrgUnitWithVersionNo(curam.core.facade.struct.OrgStructureAndOrgUnitKey key)
                                                                                                                    throws curam.util.exception.AppException,
                                                                                                                           curam.util.exception.InformationalException

Method to return all jobs for specified organization unit.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listJobWithVersionNo

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

Method to return all jobs.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listApplicationCode

@AccessLevel(value=EXTERNAL)
curam.core.sl.struct.ApplicationCodeDetailsList listApplicationCode()
                                                                                          throws curam.util.exception.AppException,
                                                                                                 curam.util.exception.InformationalException

Lists application codetable values.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readUserRoleAndContactDetails1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.UserRoleAndContactDetails readUserRoleAndContactDetails1(curam.core.struct.UsersKey key)
                                                                                                        throws curam.util.exception.AppException,
                                                                                                               curam.util.exception.InformationalException

Returns user names, role name and contact details.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

viewOrganisationStructure1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ViewOrganisationStructureDetails1 viewOrganisationStructure1(curam.core.facade.struct.OrganisationStructureKey organisationStructureKey)
                                                                                                            throws curam.util.exception.AppException,
                                                                                                                   curam.util.exception.InformationalException

Method to view organization structure details.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listOrganisationStructure1

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

Method to return all organization structures.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readLocationStructureIDForLocationID

@AccessLevel(value=EXTERNAL)
curam.core.struct.LocationStructureKey readLocationStructureIDForLocationID(curam.core.struct.LocationKeyStruct locationKey)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Reads the location structure ID associated with the given location ID.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

searchApplicationReference

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ApplicationSearchDetailsList searchApplicationReference(curam.core.facade.struct.ApplicationSearchKey key)
                                                                                                       throws curam.util.exception.AppException,
                                                                                                              curam.util.exception.InformationalException

Validates search criteria and allows a User to search across all defined Application Objects e.g. Cases, Participants etc.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

countApplicationReferenceRecord

@AccessLevel(value=EXTERNAL)
curam.core.sl.struct.RecordCount countApplicationReferenceRecord(curam.core.facade.struct.ApplicationSearchKey key)
                                                                                       throws curam.util.exception.AppException,
                                                                                              curam.util.exception.InformationalException

Allows User to count number of record matching reference across all defined Appplication Objects e.g. Cases, Participants, etc.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readLocationIDByLocationHolidayKey

@AccessLevel(value=EXTERNAL)
curam.core.struct.LocationIDDetails readLocationIDByLocationHolidayKey(curam.core.struct.LocationHolidayIDKey key)
                                                                                             throws curam.util.exception.AppException,
                                                                                                    curam.util.exception.InformationalException

This method is intended to be used by users responsible for administrating services. Always this method returns first record of location Id details, when multiple records are fetched for given location holiday Id.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

searchActiveUserDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.SearchUserDetails searchActiveUserDetails(curam.core.facade.struct.UserSearchKey key)
                                                                                         throws curam.util.exception.AppException,
                                                                                                curam.util.exception.InformationalException

Search for an active user details by given search criteria.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

searchUserDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.SearchUserDetails searchUserDetails(curam.core.facade.struct.UserSearchKey key)
                                                                                   throws curam.util.exception.AppException,
                                                                                          curam.util.exception.InformationalException

Search for an user detail within the organization.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

getUserSkills

curam.core.facade.struct.UserSkills getUserSkills(curam.core.facade.struct.UserSkillListKey userSkillListKey)
                                           throws curam.util.exception.AppException,
                                                  curam.util.exception.InformationalException

Reads the user skills for a user.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

createUserSkillsLanguages

@AccessLevel(value=EXTERNAL)
curam.core.struct.InformationalMsgDtlsList createUserSkillsLanguages(curam.core.facade.struct.UserLanguageSkillCreationDetails key)
                                                                                           throws curam.util.exception.AppException,
                                                                                                  curam.util.exception.InformationalException

This method is to create user skill language details.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

cancelUserSkillsDetails

@AccessLevel(value=EXTERNAL)
curam.core.struct.InformationalMsgDtlsList cancelUserSkillsDetails(curam.core.facade.struct.CancelUserSkillDetails kkey)
                                                                                         throws curam.util.exception.AppException,
                                                                                                curam.util.exception.InformationalException

Cancels a user skill record.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listResolutionApprovalCheckForOrgUnitAndVersionNo

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListOrgUnitResolutionApprovalCheckDetailsAndVersionNo listResolutionApprovalCheckForOrgUnitAndVersionNo(curam.core.facade.struct.ListOrgUnitResolutionApprovalCheckKey key)
                                                                                                                                                       throws curam.util.exception.AppException,
                                                                                                                                                              curam.util.exception.InformationalException

This method lists all existing approval checks for an org unit.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

listResolutionApprovalCheckForUserAndVersionNo

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListUserResolutionApprovalCheckDetailsAndVersionNo listResolutionApprovalCheckForUserAndVersionNo(curam.core.facade.struct.ListUserResolutionApprovalCheckKey listUserResolutionApprovalCheckKey)
                                                                                                                                                 throws curam.util.exception.AppException,
                                                                                                                                                        curam.util.exception.InformationalException

This method lists all existing approval checks for a user.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readAlternateLoginEnabled

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

Read the alternateLoginEnabled flag from Enviroment.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

isLocationSearchenabled

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

Method to find if the location search is enabled.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

isBankBranchSearchenabled

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

Method to find if the bank branch search is enabled.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

isPositionSearchenabled

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

Method to find if the position search is enabled.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

searchLocationsByLocationNameOrType

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadOrganizationLocationList searchLocationsByLocationNameOrType(curam.core.facade.struct.LocationByNameAndTypeKey key,
                                                                                                                       curam.core.facade.struct.ActionIDProperty actionIDProperty)
                                                                                                                throws curam.util.exception.AppException,
                                                                                                                       curam.util.exception.InformationalException

Retrieves a list of locations for an organization with a given name or type.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

searchBankBranch

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListBankBranchDetails searchBankBranch(curam.core.facade.struct.SearchBankBranchCriteria key,
                                                                                             curam.core.facade.struct.ActionIDProperty actionIDProperty)
                                                                                      throws curam.util.exception.AppException,
                                                                                             curam.util.exception.InformationalException

Retrieves a list of bank branch for an organization with a given search criteria.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

searchOrganizationPositions

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListPositionForOrgStructureDetails searchOrganizationPositions(curam.core.facade.struct.PositionSearchCriteria key,
                                                                                                                     curam.core.facade.struct.ActionIDProperty actionIDProperty)
                                                                                                              throws curam.util.exception.AppException,
                                                                                                                     curam.util.exception.InformationalException

Retrieves a list of position for an organization with a given search criteria.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

isOrganisationUnitSearchEnabled

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

Method to find if the organization unit search is enabled.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

searchOrganisationUnitDetails

curam.core.facade.struct.OrgUnitDetailsList searchOrganisationUnitDetails(curam.core.facade.struct.OrgUnitSearchCriteria key,
                                                                          curam.core.facade.struct.ActionIDProperty actionIDProperty)
                                                                   throws curam.util.exception.AppException,
                                                                          curam.util.exception.InformationalException

TO search the org units

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyQuickLinkApplicationLink

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

Method to allow an administrator to modify the details of the quick link application link that has been recorded for the organization.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readQuickLinkApplicationLink

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.QuickLinkApplicationLinkDtls readQuickLinkApplicationLink(curam.core.sl.entity.struct.QuickLinkApplicationLinkKey details)
                                                                                                         throws curam.util.exception.AppException,
                                                                                                                curam.util.exception.InformationalException

Method to read the details of the quick link application link recorded for the organization.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

isUserClosed

curam.core.facade.struct.CloseUserInd isUserClosed(curam.core.struct.UserNameKey key)
                                            throws curam.util.exception.AppException,
                                                   curam.util.exception.InformationalException

Method to find whether the user is closed or not.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyAdminIntegratedCaseIndicators

void modifyAdminIntegratedCaseIndicators(curam.core.struct.AdminIntegratedCaseKey adminIntegratedCaseKey,
                                         curam.core.struct.AdminIntegratedCaseTypeIndicators adminIntegratedCaseTypeIndicators)
                                  throws curam.util.exception.AppException,
                                         curam.util.exception.InformationalException

Modifies the AdminIntegrated Case Type, Ownership Strategy and other Indicators. This method can be used when the home-page properties need not be changed.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

Interface Organization

Method Summary

Method Detail

activateOrganisationStructure

readOrganizationHomePage1

addCashExclusionDate

addChequeExclusionDate

addChildUnit

addEFTExclusionDate

addInvoiceExclusionDate

addUserForPosition

addVoucherExclusionDate

assignResourceToOrgUnit

cancelAdminIntegratedCase

cancelBank

cancelBankAccount

cancelBankBranch

cancelCurrencyExchange

cancelDailySchedule

cancelExclusionDate

cancelJob

cancelLocation

cancelLocationHoliday

cancelOrganisationStructure

cancelOrganizationUnit

cancelOrganizationWorkingPattern

cancelOrgUnitCaseApproval

cancelOrgUnitEvidenceApproval

cancelPositionSlotavailability

cancelResource

cancelSlotDetails

cancelUser

cancelInternalUser

cancelUserCaseApproval

cancelUserEvidenceApproval

cancelUserSkillDetails

cancelUserWorkingPattern

cloneOrganisationStructure

createBank

createBankBranch

createCurrencyExchange

createDailySchedule

createJob

createLocation

createLocationHoliday

createModifyOrganizationNonStandardWorkingPattern

createModifyUserNonStandardWorkingPattern

createOrganisationStructure

createOrganisationUnit

createOrganizationWorkingPattern

createOrgUnitCaseApproval

createOrgUnitEvidenceApproval

createPosition

createPositionSlotAvailability

createResource

createRootUnit

createSlot

createUser

createUserCaseApproval

createUserEvidenceApproval

createUserSkill

createUserWorkingPattern

disableUser

enableUser

getOrganisationUnitContactInformation

getOrgStructureBreadCrumb

getOrgUnitBreadCrumb

getPositionBreadCrumb

listActiveAdminIntegratedCase

listActiveLeadPositionForOrgUnit

listActivePositionForOrgUnit

listAllAdminIntegratedCase

listAllOrgUnit

listAllSecurityRoles

listBank

listBankAccount

listBankBranch

listBankBranchNameBankName

listChildLocations

listCurrencyExchange