System (core)

All Known Implementing Classes:

System, curam.core.facade.impl.System, SystemFactory
```
@AccessLevel(value=EXTERNAL)
public interface System
```
This business interface provides operations related to overall system functionality.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addGroupsToRole(curam.core.facade.struct.AddGroupsToRole details)` Adds one or more security groups to a security role.
`void`	`addSIDsToGroup(curam.core.facade.struct.AddSIDsToGroup details)` Adds one or more security identifiers to a security group.
`curam.core.facade.struct.AddTranslationDtlsOut`	`addTranslationDescriptionText(curam.core.facade.struct.AddTranslationDtls translationDtls)` Adds a localised name for a database header.
`void`	`cancelDocumentTemplate(curam.core.facade.struct.CancelDocumentTemplateKey key)` Cancels a document template.
`void`	`cancelNickname(curam.core.sl.entity.struct.NicknameKey key)` Removes a nickname record.
`void`	`checkInTemplate(curam.core.facade.struct.CheckInTemplateDetails details)` Checks in a specified document template that was checked out.
`curam.core.facade.struct.GetTemplateDetails`	`checkOutTemplate(curam.core.facade.struct.CheckOutTemplateDetails details)` Checks out a specified document template.
`void`	`createBatchErrorCode(curam.core.facade.struct.BatchErrorCodeDetails batchErrorCodeDetails)` Creates a new batch error code.
`void`	`createBatchGroup(curam.core.facade.struct.CreateBatchGroupDetails details)` Creates a new batch process group.
`void`	`createBatchProcess(curam.core.facade.struct.BatchProcessDetails details)` Creates a new batch process.
`curam.core.facade.struct.CodeTableName`	`createCodeTable(curam.core.facade.struct.CodeTableName details)` Creates a new codetable.
`void`	`createCodeTableItem(curam.core.facade.struct.MaintainCodeTableItem details)` Creates a codetable item on a specified codetable.
`void`	`createDocumentTemplate1(curam.core.facade.struct.CreateDocumentTemplateDetails1 details)` Creates a document template.
`void`	`createFunctionSID(curam.core.facade.struct.CreateFunctionSIDDetails details)` Creates a function SID and maps the security identifier to the function identifier.
`void`	`createGroupProcess(curam.core.facade.struct.GroupProcessDetails details)` Creates a new batch process in a specified batch group.
`void`	`createLanguageLocaleMap(curam.core.facade.struct.LanguageLocaleMapDetails details)` Creates a new language locale map.
`void`	`createNickname(curam.core.sl.entity.struct.NicknameDtls details)` Creates a nickname record.
`curam.core.facade.struct.SecurityGroupKey`	`createSecurityGroup(curam.core.facade.struct.SecurityGroupDetails details)` Creates a security group.
`void`	`createSecurityIdentifier(curam.core.facade.struct.CreateSecurityIdentifier details)` Creates a security identifier.
`curam.core.facade.struct.SecurityRoleKey`	`createSecurityRole(curam.core.facade.struct.CreateSecurityRoleDetails details)` Creates a new security role.
`void`	`createXSLTemplate(curam.core.facade.struct.CreateXSLTemplateDetails templateDetails)` Creates a new XSL template record.
`void`	`executeBatchProcess(curam.core.facade.struct.AddBatchRequestDetails details)` Adds a specified batch process request to the queue for execution.
`curam.core.facade.struct.ListItemsInCodeTable`	`filterListItemsInCodeTable(curam.core.facade.struct.CodeTableItemFilter key)` Retrieve a list of code table items associated with a given code table.
`curam.core.facade.struct.DocumentTemplateWordContentsAndData`	`getDocumentTemplateContents(curam.core.facade.struct.ReadDocumentTemplateKey key)` Reads the contents of a specified document template.
`curam.core.facade.struct.GetTemplateDetails`	`getTemplate(curam.core.facade.struct.GetTemplateVersionKey key)` Reads the details and contents for a specified template identifier, without checking it out.
`curam.core.facade.struct.ListTemplateVersions`	`getTemplateVersions1(curam.core.facade.struct.XSLTemplateKey1 key)` Reads all the version numbers for a specified template.
`curam.core.facade.struct.HierarchyIndicator`	`isBottomLevel(curam.core.facade.struct.CodeTableName codetableName)` Returns true if the codetable is at the bottom-level of the hierarchy.
`curam.core.facade.struct.HierarchyIndicator`	`isTopLevel(curam.core.facade.struct.CodeTableName codetableName)` Returns true if the codetable is at the top-level of the hierarchy.
`curam.core.facade.struct.ListDocumentTemplateDetails1`	`listActiveDocumentTemplates1()` Returns a list of active document templates.
`curam.core.facade.struct.ListItemsInCodeTable`	`listAllItemsInCodeTable(curam.core.facade.struct.CodeTableName key)` Returns the list of all the items in a specified codetable.
`curam.core.facade.struct.ListItemsInCodeTable`	`listAllItemsInCodeTableForProgramLocale(curam.core.facade.struct.CodeTableName key)` Returns the list of all the items in a specified codetable for program locale.
`curam.core.facade.struct.ListUnassignedFIDs`	`listAllUnassignedFids()` Returns a list of all unassigned function identifiers.
`curam.core.facade.struct.ListBatchErrorCodeDetails`	`listBatchErrorCode()` Returns a list of all batch error codes.
`curam.core.facade.struct.ListBatchGroupDetails`	`listBatchGroup()` Returns a list of all batch groups.
`curam.core.facade.struct.ListBatchGroupItem`	`listBatchGroupItem(curam.core.facade.struct.RetrieveItemsForBatchGroupKey key)` Returns a list of processes for a specifed batch group.
`curam.core.facade.struct.ListBatchProcess`	`listBatchProcess()` Returns the complete list of batch processes that have associated descriptions.
`curam.core.facade.struct.ListBatchProcessAndHasParam`	`listBatchProcessAndHasParam()` Returns the complete list of batch processes that have associated descriptions and parameters.
`curam.core.facade.struct.ListProcessWithoutDesc`	`listBatchProcessesWithoutDesc()` Returns a complete list of batch processes that have no descriptions.
`curam.core.facade.struct.ListBatchProcessRequest`	`listBatchProcessRequest()` Returns a list of batch process requests that are awaiting execution.
`curam.core.facade.struct.ListCodeDetails`	`listChildrenCodes(curam.core.facade.struct.ReadCodeTableItemKey key)` Returns the list of child codes for a specified codetable item.
`curam.core.facade.struct.ListCodeDetailsAndDisplayName`	`listChildrenCodesAndDisplayName(curam.core.facade.struct.ReadCodeTableItemKey key)` Returns the list of child codes for a specified codetable item.
`curam.core.facade.struct.ListSelectedCodes`	`listChildrenCodesForModification(curam.core.facade.struct.ReadCodeTableItemKey key)` Lists the current and potential children codes.
`curam.core.facade.struct.ListCodeDetails`	`listCodes(curam.core.facade.struct.CodeTableName codetableName)` Lists the codes contained in a table.
`curam.core.facade.struct.ListCodeTable`	`listCodeTable()` Returns a complete list of codetables on the system.
`curam.core.facade.struct.CodeTableItemsDetailsList`	`listCodeTableItemTranslations(curam.core.facade.struct.CodeTableItemCommonCode key)` Retrieve a list of code table item translations associated with a given code table item.
`curam.core.facade.struct.ListCodetableInHierarchy`	`listCodetablesInHierarchy(curam.core.facade.struct.HierarchyName hierarchyName)` Lists all the code tables contained in a specified hierarchy.
`curam.core.facade.struct.ListCodeTableWithDisplayInHierarchy`	`listCodetablesWithDisplayInHierarchy(curam.core.facade.struct.HierarchyName hierarchyName)` Lists all the code tables with display names contained in a specified hierarchy.
`curam.core.facade.struct.ListDocumentTemplateDetails`	`listDocumentTemplates()` Returns a complete list of available document templates in the system.
`curam.core.facade.struct.ListSelectedFieldsDocumentTemplateDetails`	`listDocumentTemplatesByRelatedID(curam.core.facade.struct.SearchByRelatedIDKey key)` Lists all available document templates for a specified case or concern role type.
`curam.core.facade.struct.CodetableCodeAndDescriptionList`	`listEnabledItemsInCodetableForLocale(curam.core.facade.struct.CodeTableName key)` Returns a list of codes and descriptions for all enabled items in the specified code table for a particular locale.
`curam.core.facade.struct.ListBatchGroupDetails`	`listGroupsForProcess(curam.core.facade.struct.RetrieveGroupsForProcessKey key)` Returns a list of groups for a specified batch process.
`curam.core.facade.struct.ListHierarchyDetails`	`listHierarchies()` Lists all the hierarchies available on the system.
`curam.core.facade.struct.ListItemsInCodeTable`	`listItemsInCodeTable(curam.core.facade.struct.CodeTableName key)` Returns the list of enabled codetable items for a specified codetable.
`curam.core.facade.struct.LanguageLocaleMapDetailsList`	`listLanguageLocaleMap()` Returns the list of all the language locale map items.
`curam.core.sl.entity.struct.NicknameDtlsList`	`listNickname()` Returns a list of all nicknames on the system.
`curam.core.facade.struct.ListParameter`	`listParameter(curam.core.facade.struct.RetrieveProcessParametersKey key)` Return the list of parameters for a specified batch process.
`curam.core.facade.struct.ListCodeDetails`	`listPotentialParentCodes(curam.core.facade.struct.CodeTableName name)` Lists the codes that are eligible to be used as parent code types for a specified codetable.
`curam.core.facade.struct.ListSecurityGroupDetails`	`listSecurityGroup()` Returns a complete list of security groups in the system.
`curam.core.facade.struct.ListSecurityIdentifierDetails`	`listSecurityIdentifier()` Returns a complete list of security identifiers in the system.
`curam.core.facade.struct.ListSecurityRoleDetails`	`listSecurityRole()` Returns a compete list of security roles on the system.
`curam.core.facade.struct.ListTemplateDetails1`	`listTemplate1()` Return details of all available XSL templates on the system.
`curam.core.facade.struct.LocalizableDescTxtDtlsList`	`listTranslationDescriptionText(curam.core.facade.struct.LocalizableDescTxtKey key)` Retrieve a list of translations associated with a given code table header.
`void`	`modifyBatchErrorCode(curam.core.facade.struct.ModifyBatchErrorCodeDetails modifyBatchErrorCodeDetails)` Modifies an existing batch error code.
`void`	`modifyBatchProcess(curam.core.facade.struct.BatchProcessDetails details)` Modifies an existing batch process.
`curam.core.facade.struct.PopupParams`	`modifyChildrenCodes(curam.core.facade.struct.ReadCodeTableItemKey key, curam.core.facade.struct.TabDelimitedString initialStr, curam.core.facade.struct.TabDelimitedString newStr, curam.core.facade.struct.PopupParams popupParams)` Modifies the child codes for a specified codetable item.
`void`	`modifyCodeTableDefault(curam.core.facade.struct.ModifyCodeTableDefault details)` Modifies the default code for a specified codetable.
`void`	`modifyCodeTableItem(curam.core.facade.struct.MaintainCodeTableItem details)` Modifies a specified codetable item.
`void`	`modifyCodeTableName(curam.core.facade.struct.ModifyCodeTableName details)` Modifies a codetable name.
`void`	`modifyDocumentTemplateContents(curam.core.facade.struct.ModifyDocumentTemplateKey key, curam.core.facade.struct.DocumentTemplateContentsAndVersion details)` Modifies the contents of a specified document template.
`void`	`modifyLanguageLocaleMap(curam.core.facade.struct.LanguageLocaleMapKey key, curam.core.facade.struct.LanguageLocaleMapDetails details)` Modifies the details of a specified language locale map.
`void`	`modifyNickname(curam.core.sl.entity.struct.NicknameKey key, curam.core.sl.entity.struct.NicknameDtls details)` Modifies a specified nickname record.
`void`	`modifyParameter(curam.core.facade.struct.ModifyParamDetails details)` Modifies a parameter for a specified batch process.
`curam.core.facade.struct.PopupParams`	`modifyParentCode(curam.core.facade.struct.ReadCodeTableItemKey key, curam.core.facade.struct.CodeDetails newParentCode, curam.core.facade.struct.PopupParams popupParams)` Modifies the details of an existing parent code.
`void`	`modifySecurityGroup(curam.core.facade.struct.SecurityGroupDetails details)` Modifies the existing security group name and description details.
`void`	`modifySecurityIdentifier(curam.core.facade.struct.ModifySecurityIdentifier details)` Modifies an existing security identifier.
`void`	`modifySecurityRole(curam.core.facade.struct.SecurityRoleDetails details)` Modifies the security role name.
`void`	`modifyTextTranslation(curam.core.facade.struct.AddTranslationDtls translationDtls)` Modify a translation for a code table name.
`void`	`modifyXSLTemplate(curam.core.facade.struct.ModifyXSLTemplateDetails modifyDetails)` Modifies details of an existing XSL template.
`void`	`publishCodeTableChanges()` Publishes codetable changes.
`void`	`publishSecurityChanges()` Publishes security role changes.
`curam.core.facade.struct.ListSelectedFieldsDocumentTemplateDetails`	`readAllWithoutContent()` Reads all data from available document templates except the content data.
`curam.core.facade.struct.ListSelectedFieldsDocumentTemplateDetailsAndVersionNo`	`readAllWithoutContentAndVersionNo()` Reads all data (including the version number) from available document templates except the content data.
`curam.core.facade.struct.BatchErrorCodeDetails`	`readBatchErrorCode(curam.core.facade.struct.ReadBatchErrorCodeKey readBatchErrorCodeKey)` Reads batch error code details.
`curam.core.facade.struct.ParameterDetails`	`readBatchParameterDetails(curam.core.facade.struct.ReadParameterDetails key)` Reads details on a specified batch parameter.
`curam.core.facade.struct.ReadBatchParametersList`	`readBatchParameters(curam.core.facade.struct.ReadBatchProcessKey key)` Returns a tab delimited list of parameters for a specific batch process.
`curam.core.facade.struct.BatchProcessDetails`	`readBatchProcess(curam.core.facade.struct.ReadBatchProcessKey key)` Read details of a batch process.
`curam.core.facade.struct.ReadBatchProcessAndParamDetails`	`readBatchProcessAndParamDetails(curam.core.facade.struct.ReadBatchProcessAndParamsKey key)` Returns the details and list of paameters for a specified batch process.
`curam.core.facade.struct.CodeDetails`	`readCodeDetails(curam.core.facade.struct.ReadCodeTableItemKey key)` Reads the details for a specified codetable item.
`curam.core.facade.struct.CodeTableDetails`	`readCodeTable(curam.core.facade.struct.CodeTableName codeTableName)` Reads the details for a specified codetable.
`curam.core.facade.struct.CodetableInHierarchy`	`readCodetableHierarchyDetails(curam.core.facade.struct.CodeTableName codetableName)` Reads the hierarchy details for a particular codetable.
`curam.core.facade.struct.MaintainCodeTableItem`	`readCodeTableItem(curam.core.facade.struct.ReadCodeTableItemKey key)` Reads the details for a specified codetable item.
`curam.core.facade.struct.ReadDocumentTemplateDetails1`	`readDocumentTemplate1(curam.core.facade.struct.ReadDocumentTemplateKey key)` Reads the details of a specified document template.
`curam.core.facade.struct.HierarchyDetails`	`readHierarchyDetails(curam.core.facade.struct.HierarchyName name)` Reads the details of a particular hierarchy.
`curam.core.facade.struct.LanguageDetailsList`	`readLanguageDetails()` Reads the details of all languages on the system.
`curam.core.facade.struct.ListItemsInLocaleCodeTable`	`readLanguageLocaleDetails(curam.core.facade.struct.LanguageLocaleMapKey key)` Reads the language and locale code details including the locale code list from the code table.
`curam.core.facade.struct.LanguageLocaleDetails`	`readLanguageLocaleMap(curam.core.facade.struct.LanguageLocaleMapKey key)` Reads the details of a language locale map.
`curam.core.sl.entity.struct.NicknameDtls`	`readNickname(curam.core.sl.entity.struct.NicknameKey key)` Reads the details for a specified nickname.
`curam.core.facade.struct.CodeDetails`	`readParentCode(curam.core.facade.struct.ReadCodeTableItemKey key)` Reads the details for a parent codetable item.
`curam.core.facade.struct.ReadSecurityGroup`	`readSecurityGroup(curam.core.facade.struct.SecurityGroupKey key)` Reads the details for a particular security group.
`curam.core.facade.struct.ReadSecurityGroupForModify`	`readSecurityGroupForModify(curam.core.facade.struct.SecurityGroupKey key)` Reads security group details for modifying purposes.
`curam.core.facade.struct.ReadSecurityIdentfier`	`readSecurityIdentifier(curam.core.facade.struct.SecurityIdentifierKey key)` Reads the security identifier details.
`curam.core.facade.struct.ReadSecurityRole`	`readSecurityRole(curam.core.facade.struct.SecurityRoleKey key)` Reads the details for a specified security role.
`curam.core.facade.struct.ReadSecurityRoleForModify`	`readSecurityRoleForModify(curam.core.facade.struct.SecurityRoleKey key)` Read security role details for modifying purposes.
`curam.core.facade.struct.ReadXSLTemplateDetails`	`readXSLTemplate(curam.core.facade.struct.XSLTemplateKey1 key)` Reads the details of a specified XSL template.
`void`	`removeBatchErrorCode(curam.core.facade.struct.RemoveBatchErrorCodeKey removeBatchErrorCodeKey)` Removes a batch error code.
`void`	`removeBatchGroup(curam.core.facade.struct.RemoveBatchGroupKey key)` Removes all details relating to a batch group.
`void`	`removeBatchProcess(curam.core.facade.struct.RemoveBatchProcessKey key)` Removes a batch process description.
`void`	`removeBatchProcessRequest(curam.core.facade.struct.RemoveProcessRequestKey key)` Removes a batch process request.
`void`	`removeCodeTable(curam.core.facade.struct.CodeTableName key)` Removes a codetable.
`void`	`removeCodeTableItem(curam.core.facade.struct.RemoveCodeTableItem key)` Removes a codetable item from a specified codetable.
`void`	`removeGroupFromRole(curam.core.facade.struct.RemoveGroupFromRole key)` Removes a security group from a security role.
`void`	`removeLanguageLocaleMap(curam.core.facade.struct.LanguageLocaleMapKey key)` Removes a language locale map.
`void`	`removeProcessFromGroup(curam.core.facade.struct.GroupProcessDetails key)` Removes a batch process from a batch group.
`void`	`removeSecurityGroup(curam.core.facade.struct.RemoveSecurityGroup key)` Removes a security group.
`void`	`removeSecurityIdentifier(curam.core.facade.struct.SecurityIdentifierKey key)` Removes a security identifier.
`void`	`removeSecurityRole(curam.core.facade.struct.RemoveSecurityRole key)` Removes a security role.
`void`	`removeSIDFromGroup(curam.core.facade.struct.RemoveSIDFromGroup key)` Removes a security identifier from a security group.
`void`	`removeTextTranslation(curam.core.facade.struct.LocalizableDescTxtDtls descDtls)` Delete a translation for a code table name.
`curam.core.facade.struct.ListBatchProcessAndHasParam`	`searchBatchProcess(curam.core.facade.struct.SearchBatchKey input)` Returns the list of batch processes that have associated descriptions and parameters, which meets the search criteria.
`curam.core.facade.struct.ListBatchProcessRequest`	`searchBatchProcessRequest(curam.core.facade.struct.SearchBatchKey input)` Returns the list of batch process requests that have associated descriptions and parameters, which meets the search criteria.
`curam.core.facade.struct.LocalizableDescTxtDtls`	`searchByKeyAndLocale(curam.core.facade.struct.LocalizableDescTxtDtls searchInput)` Retrieve a list of translations associated with a certain localeand displayNameId.
`curam.core.facade.struct.CodeTableSearchResults`	`searchCodeTables(curam.core.facade.struct.CodeTableSearchKey key)` Searches for code tables in the system.
`curam.core.facade.struct.SecurityIdentifierSearchResults`	`searchSecurityIdentifiers(curam.core.facade.struct.SecurityIdentifierSearchKey key)` Searches for security identifiers in the system.
`void`	`toggleCodeTableItem(curam.core.facade.struct.ToggleCodeTableItemKey key)` Toggle the enabled property of a code table item.
`void`	`undoCheckOutTemplate(curam.core.facade.struct.UndoCheckOutTemplate key)` Undoes the checkout of an XSL template.
`void`	`updateDocumentTemplate1(curam.core.facade.struct.ModifyDocumentTemplateKey key, curam.core.facade.struct.ModifyDocumentTemplateDetails1 details)` Modifies the details of a particular document template.

Method Detail

createCodeTable

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CodeTableName createCodeTable(curam.core.facade.struct.CodeTableName details)
                                                                             throws curam.util.exception.AppException,
                                                                                    curam.util.exception.InformationalException

Creates a new codetable.

Parameters:

details - Details of the codetable to be created.

Returns:

Name of the codetable being created.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

CodetableAdmin

listCodeTable

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

Returns a complete list of codetables on the system.

Returns:

A list of cdetables.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CodeTableAdmin

modifyCodeTableName

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

Modifies a codetable name.

Parameters:

details - The new name for a specified codetable.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

CodeTableAdmin

modifyCodeTableDefault

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

Modifies the default code for a specified codetable.

Parameters:

details - Details of the default code for a specified codetable.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

CodeTableAdmin

publishCodeTableChanges

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

Publishes codetable changes.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

CacheAdmin

listItemsInCodeTable

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListItemsInCodeTable listItemsInCodeTable(curam.core.facade.struct.CodeTableName key)
                                                                                         throws curam.util.exception.AppException,
                                                                                                curam.util.exception.InformationalException

Returns the list of enabled codetable items for a specified codetable. The default code is also returned.

Parameters:

key - Codetable identifier.

Returns:

A list of codetable items in a codetable.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CodeTableAdmin

createCodeTableItem

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

Creates a codetable item on a specified codetable.

Parameters:

details - Details of the codetable item to be added to a codetable.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

CodetableAdmin

modifyCodeTableItem

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

Modifies a specified codetable item.

Parameters:

details - Details for the codetable item to be modified.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

CodeTableAdmin

listSecurityRole

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

Returns a compete list of security roles on the system.

Returns:

List of security role details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

SecurityAdmin

createSecurityRole

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.SecurityRoleKey createSecurityRole(curam.core.facade.struct.CreateSecurityRoleDetails details)
                                                                                  throws curam.util.exception.AppException,
                                                                                         curam.util.exception.InformationalException

Creates a new security role.

Parameters:

details - Details of the security role to be created.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

SecurityAdmin

publishSecurityChanges

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

Publishes security role changes.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

CacheAdmin

removeSecurityRole

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

Removes a security role.

Parameters:

key - Contains the security role identifier.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

SecurityAdmin

readSecurityRole

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadSecurityRole readSecurityRole(curam.core.facade.struct.SecurityRoleKey key)
                                                                                 throws curam.util.exception.AppException,
                                                                                        curam.util.exception.InformationalException

Reads the details for a specified security role.

Parameters:

key - Contains the security role identifier.

Returns:

Security role details, including groups in role and groups not in role.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

SecurityAdmin

readSecurityRoleForModify

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadSecurityRoleForModify readSecurityRoleForModify(curam.core.facade.struct.SecurityRoleKey key)
                                                                                                   throws curam.util.exception.AppException,
                                                                                                          curam.util.exception.InformationalException

Read security role details for modifying purposes.

Parameters:

key - The security role identifier.

Returns:

Security role details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

SecurityAdmin

removeSecurityGroup

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

Removes a security group.

Parameters:

key - Security group identifier.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

SecurityAdmin

modifySecurityRole

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

Modifies the security role name.

Parameters:

details - Security role details to be modified.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

SecurityAdmin

listSecurityGroup

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

Returns a complete list of security groups in the system.

Returns:

List of security group names.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

SecurityAdmin

createSecurityGroup

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.SecurityGroupKey createSecurityGroup(curam.core.facade.struct.SecurityGroupDetails details)
                                                                                    throws curam.util.exception.AppException,
                                                                                           curam.util.exception.InformationalException

Creates a security group.

Parameters:

details - Details required to create a security group.

Returns:

The unique identifier of the newly created security group.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

SecurityAdmin

readSecurityGroup

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadSecurityGroup readSecurityGroup(curam.core.facade.struct.SecurityGroupKey key)
                                                                                   throws curam.util.exception.AppException,
                                                                                          curam.util.exception.InformationalException

Reads the details for a particular security group.

Parameters:

key - Security group identifier.

Returns:

Security group details including a list of security identifiers in the group and a list of security identifiers not in the group.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

SecurityAdmin

readSecurityGroupForModify

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadSecurityGroupForModify readSecurityGroupForModify(curam.core.facade.struct.SecurityGroupKey key)
                                                                                                     throws curam.util.exception.AppException,
                                                                                                            curam.util.exception.InformationalException

Reads security group details for modifying purposes.

Parameters:

key - Security group identifier.

Returns:

List of security group details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

SecurityAdmin

modifySecurityGroup

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

Modifies the existing security group name and description details.

Parameters:

details - Security group details to be modified.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

SecurityAdmin

listSecurityIdentifier

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

Returns a complete list of security identifiers in the system.

Returns:

A list of security identifiers.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

SecurityAdmin

removeSecurityIdentifier

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

Removes a security identifier.

Parameters:

key - A security identifier.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

SecurityAdmin

createSecurityIdentifier

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

Creates a security identifier.

Parameters:

details - Details of the security identifier to be created.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

SecurityAdmin

readSecurityIdentifier

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadSecurityIdentfier readSecurityIdentifier(curam.core.facade.struct.SecurityIdentifierKey key)
                                                                                            throws curam.util.exception.AppException,
                                                                                                   curam.util.exception.InformationalException

Reads the security identifier details.

Parameters:

key - A security identifier.

Returns:

Security identifier details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

SecurityAdmin

modifySecurityIdentifier

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

Modifies an existing security identifier.

Parameters:

details - Details of security identifier to be modified.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

SecurityAdmin

removeCodeTable

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

Removes a codetable.

Parameters:

key - Identifier for the codetable to be removed.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

CodeTableAdmin

removeCodeTableItem

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

Removes a codetable item from a specified codetable.

Parameters:

Identifier - of the codetable item to be removed.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

CodeTableAdmin

removeGroupFromRole

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

Removes a security group from a security role.

Parameters:

key - Contains the group and role identifiers.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

SecurityAdmin

removeSIDFromGroup

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

Removes a security identifier from a security group.

Parameters:

key - Contains the security group identifer and security identifier.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

SecurityAdmin

checkInTemplate

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

Checks in a specified document template that was checked out.

Parameters:

details - The details of the template being checked in.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

XSLTemplate

undoCheckOutTemplate

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

Undoes the checkout of an XSL template.

Parameters:

A - tempate identifier and override indicator.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

XSLTemplate

checkOutTemplate

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.GetTemplateDetails checkOutTemplate(curam.core.facade.struct.CheckOutTemplateDetails details)
                                                                                   throws curam.util.exception.AppException,
                                                                                          curam.util.exception.InformationalException

Checks out a specified document template.

Parameters:

details - The details of the template being checked out.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

XSLTemplate

Business Object Write:

XSLTemplate

listBatchProcessRequest

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

Returns a list of batch process requests that are awaiting execution.

Returns:

List of the batch processes.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

BatchAdmin

listBatchProcess

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

Returns the complete list of batch processes that have associated descriptions.

Returns:

A list of all batch processes in the system that have descriptions.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

BatchAdmin

listParameter

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListParameter listParameter(curam.core.facade.struct.RetrieveProcessParametersKey key)
                                                                           throws curam.util.exception.AppException,
                                                                                  curam.util.exception.InformationalException

Return the list of parameters for a specified batch process.

Parameters:

key - Batch process identifier.

Returns:

List of parameters for a batch process.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

BatchAdmin

removeBatchProcessRequest

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

Removes a batch process request.

Parameters:

key - Identifier of the batch process request to be removed.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

BatchAdmin

removeBatchProcess
```
@AccessLevel(value=EXTERNAL)
void removeBatchProcess(curam.core.facade.struct.RemoveBatchProcessKey key)
                                              throws curam.util.exception.AppException,
                                                     curam.util.exception.InformationalException
```
Removes a batch process description. This means that the process won't be available in the batch list page as only batch processes with descriptions appear here.

Parameters:

key - Identifier of the batch process to be removed.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:
BatchAdmn

modifyParameter

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

Modifies a parameter for a specified batch process.

Parameters:

details - Details of the parameter to be modified.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

BatchAdmin

createBatchProcess
```
@AccessLevel(value=EXTERNAL)
void createBatchProcess(curam.core.facade.struct.BatchProcessDetails details)
                                              throws curam.util.exception.AppException,
                                                     curam.util.exception.InformationalException
```
Creates a new batch process. This also allows for a new description to be added to a batch process which previously had no description, so that it will be available in the batch list page.

Parameters:

Details - of the batch process to be created.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:
BatchAdmin

modifyBatchProcess

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

Modifies an existing batch process.

Parameters:

details - The modified details for a batch process.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

BatchAdmin

executeBatchProcess

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

Adds a specified batch process request to the queue for execution.

Parameters:

details - Details of the batch process to be executed.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

UserAccess

Business Object Write:

BatchAdmin

createBatchGroup

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

Creates a new batch process group.

Parameters:

details - The name of the new batch process group.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

BatchAdmin

removeBatchGroup

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

Removes all details relating to a batch group.

Parameters:

key - Identifier of the batch process group to be removed.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

batchAdmin

createGroupProcess
```
@AccessLevel(value=EXTERNAL)
void createGroupProcess(curam.core.facade.struct.GroupProcessDetails details)
                                              throws curam.util.exception.AppException,
                                                     curam.util.exception.InformationalException
```
Creates a new batch process in a specified batch group.

Parameters:

details - Details of the batch process to be created including the identifier of the batch group.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:
BatchAdmin

listBatchGroup

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

Returns a list of all batch groups.

Returns:

List of batch groups details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

BatchAdmin

listGroupsForProcess

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListBatchGroupDetails listGroupsForProcess(curam.core.facade.struct.RetrieveGroupsForProcessKey key)
                                                                                          throws curam.util.exception.AppException,
                                                                                                 curam.util.exception.InformationalException

Returns a list of groups for a specified batch process.

Parameters:

key - Batch process identifier.

Returns:

List of batch groups associated with a particular batch process.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

BatchAdmin

listBatchGroupItem

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListBatchGroupItem listBatchGroupItem(curam.core.facade.struct.RetrieveItemsForBatchGroupKey key)
                                                                                     throws curam.util.exception.AppException,
                                                                                            curam.util.exception.InformationalException

Returns a list of processes for a specifed batch group.

Parameters:

key - Batch group identifer.

Returns:

List of processes for a batch group.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

BatchAdmin

removeProcessFromGroup

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

Removes a batch process from a batch group.

Parameters:

key - Details of the batch process and group that it is to be removed.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

BacthAdmin

readBatchProcess

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.BatchProcessDetails readBatchProcess(curam.core.facade.struct.ReadBatchProcessKey key)
                                                                                    throws curam.util.exception.AppException,
                                                                                           curam.util.exception.InformationalException

Read details of a batch process.

Parameters:

key - Identifier for the batch process to be read.

Returns:

Details for a batch process.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

BatchAdmin

readBatchParameterDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ParameterDetails readBatchParameterDetails(curam.core.facade.struct.ReadParameterDetails key)
                                                                                          throws curam.util.exception.AppException,
                                                                                                 curam.util.exception.InformationalException

Reads details on a specified batch parameter.

Parameters:

key - Identifier for the parameter details to be read.

Returns:

Details for a parameter.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

BatchAdmin

listAllUnassignedFids

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

Returns a list of all unassigned function identifiers.

Returns:

List of unassigned function identifiers.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

SecurityAdmin

listBatchProcessesWithoutDesc

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

Returns a complete list of batch processes that have no descriptions.

Returns:: List of all batch processes in the system without a description. ad BatchAdmin
Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readBatchProcessAndParamDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadBatchProcessAndParamDetails readBatchProcessAndParamDetails(curam.core.facade.struct.ReadBatchProcessAndParamsKey key)
                                                                                                               throws curam.util.exception.AppException,
                                                                                                                      curam.util.exception.InformationalException

Returns the details and list of paameters for a specified batch process.

Parameters:

key - Identifier of the batch process.

Returns:

List of parameters and details for a batch process.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

BatchAdmin

readCodeTableItem

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.MaintainCodeTableItem readCodeTableItem(curam.core.facade.struct.ReadCodeTableItemKey key)
                                                                                       throws curam.util.exception.AppException,
                                                                                              curam.util.exception.InformationalException

Reads the details for a specified codetable item.

Parameters:

key - A codetable item identifier.

Returns:

Details for the codetable item.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CodeTableAdmin

addGroupsToRole
```
@AccessLevel(value=EXTERNAL)
void addGroupsToRole(curam.core.facade.struct.AddGroupsToRole details)
                                           throws curam.util.exception.AppException,
                                                  curam.util.exception.InformationalException
```
Adds one or more security groups to a security role.

Parameters:

details - Contains a security role identifier along with a tab delimited list of security groups.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:
SecurityAdmin

createFunctionSID
```
@AccessLevel(value=EXTERNAL)
void createFunctionSID(curam.core.facade.struct.CreateFunctionSIDDetails details)
                                             throws curam.util.exception.AppException,
                                                    curam.util.exception.InformationalException
```
Creates a function SID and maps the security identifier to the function identifier.

Parameters:

details - Details of the function security identifier to be created.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:
SecurityAdmin

addSIDsToGroup
```
@AccessLevel(value=EXTERNAL)
void addSIDsToGroup(curam.core.facade.struct.AddSIDsToGroup details)
                                          throws curam.util.exception.AppException,
                                                 curam.util.exception.InformationalException
```
Adds one or more security identifiers to a security group.

Parameters:

details - A list of security identifiers and the group identifier to which they will be added.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:
SecurityAdmin

readBatchParameters

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadBatchParametersList readBatchParameters(curam.core.facade.struct.ReadBatchProcessKey key)
                                                                                           throws curam.util.exception.AppException,
                                                                                                  curam.util.exception.InformationalException

Returns a tab delimited list of parameters for a specific batch process.

Parameters:

key - Identifier of the batch process.

Returns:

Tab delimited list of parameters for a batch process.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

BatchAdmin

getTemplate

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.GetTemplateDetails getTemplate(curam.core.facade.struct.GetTemplateVersionKey key)
                                                                              throws curam.util.exception.AppException,
                                                                                     curam.util.exception.InformationalException

Reads the details and contents for a specified template identifier, without checking it out.

Parameters:

key - Contains template identifier and also a locale identifer.

Returns:

The filename and file contents for the specified template.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

XSLTemplate

cancelDocumentTemplate

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

Cancels a document template.

Parameters:

key - Contains the document Template identifier and version number to be cancelled.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

DocumentTemplate

listDocumentTemplates

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

Returns a complete list of available document templates in the system.

Returns:

List of document templates available.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

DocumentTemplate

getDocumentTemplateContents

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.DocumentTemplateWordContentsAndData getDocumentTemplateContents(curam.core.facade.struct.ReadDocumentTemplateKey key)
                                                                                                               throws curam.util.exception.AppException,
                                                                                                                      curam.util.exception.InformationalException

Reads the contents of a specified document template.

Parameters:

key - A document template identifier.

Returns:

The content details of thespecified document template.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

DocumentTemplate

modifyDocumentTemplateContents

@AccessLevel(value=EXTERNAL)
void modifyDocumentTemplateContents(curam.core.facade.struct.ModifyDocumentTemplateKey key,
                                                                 curam.core.facade.struct.DocumentTemplateContentsAndVersion details)
                                                          throws curam.util.exception.AppException,
                                                                 curam.util.exception.InformationalException

Modifies the contents of a specified document template.

Parameters:

key - The document template identifier.

details - The document template contents and version number.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

DocumentTemplate

createBatchErrorCode
```
@AccessLevel(value=EXTERNAL)
void createBatchErrorCode(curam.core.facade.struct.BatchErrorCodeDetails batchErrorCodeDetails)
                                                throws curam.util.exception.AppException,
                                                       curam.util.exception.InformationalException
```
Creates a new batch error code. The batch error code will be positive and less than the integer maximum size.

Parameters:

batchErrorCodeDetails - Details of the batch error code to be created.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:
BatchAdmin

readBatchErrorCode

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.BatchErrorCodeDetails readBatchErrorCode(curam.core.facade.struct.ReadBatchErrorCodeKey readBatchErrorCodeKey)
                                                                                        throws curam.util.exception.AppException,
                                                                                               curam.util.exception.InformationalException

Reads batch error code details.

Parameters:

readBatchErrorCodeKey - The batch error code to be read.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

BatchAdmin

modifyBatchErrorCode

@AccessLevel(value=EXTERNAL)
void modifyBatchErrorCode(curam.core.facade.struct.ModifyBatchErrorCodeDetails modifyBatchErrorCodeDetails)
                                                throws curam.util.exception.AppException,
                                                       curam.util.exception.InformationalException

Modifies an existing batch error code.

Parameters:

modifyBatchErrorCodeDetails - The batch error code to be modified.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

BatchAdmin

listBatchErrorCode

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

Returns a list of all batch error codes.

Returns:

The list of batch error codes.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

BatchAdmin

removeBatchErrorCode

@AccessLevel(value=EXTERNAL)
void removeBatchErrorCode(curam.core.facade.struct.RemoveBatchErrorCodeKey removeBatchErrorCodeKey)
                                                throws curam.util.exception.AppException,
                                                       curam.util.exception.InformationalException

Removes a batch error code.

Parameters:

removeBatchErrorCodeKey - The batch error code to be removed.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

BatchAdmin

readCodeTable

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CodeTableDetails readCodeTable(curam.core.facade.struct.CodeTableName codeTableName)
                                                                              throws curam.util.exception.AppException,
                                                                                     curam.util.exception.InformationalException

Reads the details for a specified codetable.

Parameters:

codeTableName - Name of the codetable.

Returns:

Details for the codetable.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CodeTableAdmin

listHierarchies

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

Lists all the hierarchies available on the system.

Returns:

List of hierarchies.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CodeTableAdmin

listCodetablesInHierarchy

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListCodetableInHierarchy listCodetablesInHierarchy(curam.core.facade.struct.HierarchyName hierarchyName)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Lists all the code tables contained in a specified hierarchy.

Parameters:

hierarchyName - Name of the hierarchy.

Returns:

List of codetables.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CodeTableAdmin

readCodetableHierarchyDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CodetableInHierarchy readCodetableHierarchyDetails(curam.core.facade.struct.CodeTableName codetableName)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Reads the hierarchy details for a particular codetable.

Parameters:

codetableName - Name of the code table.

Returns:

Details for the codetable item.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CodeTableAdmin

listCodes

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListCodeDetails listCodes(curam.core.facade.struct.CodeTableName codetableName)
                                                                         throws curam.util.exception.AppException,
                                                                                curam.util.exception.InformationalException

Lists the codes contained in a table.

Parameters:

codetableName - Name of the code table.

Returns:

List details of codetable items.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CodeTableAdmin

readCodeDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CodeDetails readCodeDetails(curam.core.facade.struct.ReadCodeTableItemKey key)
                                                                           throws curam.util.exception.AppException,
                                                                                  curam.util.exception.InformationalException

Reads the details for a specified codetable item.

Parameters:

key - Key for the codetable item.

Returns:

Details for the codetable item.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CodeTableAdmin

readParentCode

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CodeDetails readParentCode(curam.core.facade.struct.ReadCodeTableItemKey key)
                                                                          throws curam.util.exception.AppException,
                                                                                 curam.util.exception.InformationalException

Reads the details for a parent codetable item.

Parameters:

key - A codetable item identifier.

Returns:

Details for the codetable item.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CodeTableAdmin

listChildrenCodes

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListCodeDetails listChildrenCodes(curam.core.facade.struct.ReadCodeTableItemKey key)
                                                                                 throws curam.util.exception.AppException,
                                                                                        curam.util.exception.InformationalException

Returns the list of child codes for a specified codetable item.

Parameters:

key - Codetable item identifer.

Returns:

List of code details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CodeTableAdmin

isTopLevel

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.HierarchyIndicator isTopLevel(curam.core.facade.struct.CodeTableName codetableName)
                                                                             throws curam.util.exception.AppException,
                                                                                    curam.util.exception.InformationalException

Returns true if the codetable is at the top-level of the hierarchy.

Parameters:

name - Name of the specified code table.

Returns:

True if the table has no parent table.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CodeTableAdmin

isBottomLevel

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.HierarchyIndicator isBottomLevel(curam.core.facade.struct.CodeTableName codetableName)
                                                                                throws curam.util.exception.AppException,
                                                                                       curam.util.exception.InformationalException

Returns true if the codetable is at the bottom-level of the hierarchy.

Parameters:

name - Name of the specified code table.

Returns:

True if the table has no child table.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CodeTableAdmin

listChildrenCodesForModification

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListSelectedCodes listChildrenCodesForModification(curam.core.facade.struct.ReadCodeTableItemKey key)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Lists the current and potential children codes.

Parameters:

key - Codetable item identifier.

Returns:

List of code details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CodeTableAdmin

modifyChildrenCodes

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.PopupParams modifyChildrenCodes(curam.core.facade.struct.ReadCodeTableItemKey key,
                                                                                      curam.core.facade.struct.TabDelimitedString initialStr,
                                                                                      curam.core.facade.struct.TabDelimitedString newStr,
                                                                                      curam.core.facade.struct.PopupParams popupParams)
                                                                               throws curam.util.exception.AppException,
                                                                                      curam.util.exception.InformationalException

Modifies the child codes for a specified codetable item.

Parameters:

key - Key for the codetable item.

initialStr - Tab-delimited string of the current child codes.

newStr - Tab-delimited string of the new child codes.

popupParams - Parameters from the popup window.

Returns:

Parameters for the popup window.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

CodeTableAdmin

listPotentialParentCodes

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListCodeDetails listPotentialParentCodes(curam.core.facade.struct.CodeTableName name)
                                                                                        throws curam.util.exception.AppException,
                                                                                               curam.util.exception.InformationalException

Lists the codes that are eligible to be used as parent code types for a specified codetable.

Parameters:

Codetable - name.

Returns:

List of code details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CodeTableAdmin

modifyParentCode

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.PopupParams modifyParentCode(curam.core.facade.struct.ReadCodeTableItemKey key,
                                                                                   curam.core.facade.struct.CodeDetails newParentCode,
                                                                                   curam.core.facade.struct.PopupParams popupParams)
                                                                            throws curam.util.exception.AppException,
                                                                                   curam.util.exception.InformationalException

Modifies the details of an existing parent code.

Parameters:

key - Key for the codetable item.

newParentCode - Details of the new parent code.

popupParams - Parameters from the popup.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

CodeTableAdmin

readHierarchyDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.HierarchyDetails readHierarchyDetails(curam.core.facade.struct.HierarchyName name)
                                                                                     throws curam.util.exception.AppException,
                                                                                            curam.util.exception.InformationalException

Reads the details of a particular hierarchy.

Parameters:

name - Name of the hierarchy.

Returns:

Details for the hierarchy.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CodeTableAdmin

readAllWithoutContent

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

Reads all data from available document templates except the content data.

Returns:

List of available. document templates.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

DocumentTemplate

listNickname

@AccessLevel(value=EXTERNAL)
curam.core.sl.entity.struct.NicknameDtlsList listNickname()
                                                                                throws curam.util.exception.AppException,
                                                                                       curam.util.exception.InformationalException

Returns a list of all nicknames on the system.

Returns:

The complete list of nickname details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Nickname

readNickname

@AccessLevel(value=EXTERNAL)
curam.core.sl.entity.struct.NicknameDtls readNickname(curam.core.sl.entity.struct.NicknameKey key)
                                                                            throws curam.util.exception.AppException,
                                                                                   curam.util.exception.InformationalException

Reads the details for a specified nickname.

Parameters:

key - The nickname and proper name of the person.

Returns:

The nickname details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Nickname

modifyNickname

@AccessLevel(value=EXTERNAL)
void modifyNickname(curam.core.sl.entity.struct.NicknameKey key,
                                                 curam.core.sl.entity.struct.NicknameDtls details)
                                          throws curam.util.exception.AppException,
                                                 curam.util.exception.InformationalException

Modifies a specified nickname record.

Parameters:

key - The nickname key for the record to be modified.

details - The nickname details to be modified.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

Nickname

cancelNickname

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

Removes a nickname record.

Parameters:

key - The nickname key for the record to be removed.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

Nickname

createNickname

@AccessLevel(value=EXTERNAL)
void createNickname(curam.core.sl.entity.struct.NicknameDtls details)
                                          throws curam.util.exception.AppException,
                                                 curam.util.exception.InformationalException

Creates a nickname record.

Parameters:

details - The nickname details to be created.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

Nickname

listDocumentTemplatesByRelatedID

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListSelectedFieldsDocumentTemplateDetails listDocumentTemplatesByRelatedID(curam.core.facade.struct.SearchByRelatedIDKey key)
                                                                                                                          throws curam.util.exception.AppException,
                                                                                                                                 curam.util.exception.InformationalException

Lists all available document templates for a specified case or concern role type.

Parameters:

key - Case identifier and concern role identifier.

Returns:

List of document templates available.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

DocumentTemplate

listAllItemsInCodeTable

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListItemsInCodeTable listAllItemsInCodeTable(curam.core.facade.struct.CodeTableName key)
                                                                                            throws curam.util.exception.AppException,
                                                                                                   curam.util.exception.InformationalException

Returns the list of all the items in a specified codetable.

Parameters:

key - Codetable name.

Returns:

List of codetable items in a codetable.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CodeTableAdmin

listLanguageLocaleMap

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

Returns the list of all the language locale map items.

Returns:

A list of language locale map items.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

LanguageLocale

createLanguageLocaleMap

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

Creates a new language locale map.

Parameters:

details - Details of the new language locale map item to be created.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

LanguageLocale

readLanguageLocaleMap

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.LanguageLocaleDetails readLanguageLocaleMap(curam.core.facade.struct.LanguageLocaleMapKey key)
                                                                                           throws curam.util.exception.AppException,
                                                                                                  curam.util.exception.InformationalException

Reads the details of a language locale map.

Parameters:

key - A language locale map item.

Returns:

Details of a language locale map item.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

LanguageLocale

modifyLanguageLocaleMap

@AccessLevel(value=EXTERNAL)
void modifyLanguageLocaleMap(curam.core.facade.struct.LanguageLocaleMapKey key,
                                                          curam.core.facade.struct.LanguageLocaleMapDetails details)
                                                   throws curam.util.exception.AppException,
                                                          curam.util.exception.InformationalException

Modifies the details of a specified language locale map.

Parameters:

key - A language locale map item.

Details - of language Locale Map item to be modified.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

LanguageLocale

removeLanguageLocaleMap

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

Removes a language locale map.

Parameters:

key - A language locale map item identifier.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

LanguageLocale

readLanguageLocaleDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListItemsInLocaleCodeTable readLanguageLocaleDetails(curam.core.facade.struct.LanguageLocaleMapKey key)
                                                                                                    throws curam.util.exception.AppException,
                                                                                                           curam.util.exception.InformationalException

Reads the language and locale code details including the locale code list from the code table.

Parameters:

key - A language locale map item.

Returns:

Details of language and locale code for a specific language locale.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CodeTableAdmin, LanguageLocale

listEnabledItemsInCodetableForLocale

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CodetableCodeAndDescriptionList listEnabledItemsInCodetableForLocale(curam.core.facade.struct.CodeTableName key)
                                                                                                                    throws curam.util.exception.AppException,
                                                                                                                           curam.util.exception.InformationalException

Returns a list of codes and descriptions for all enabled items in the specified code table for a particular locale.

Parameters:

key - A codetable name.

Returns:

List of codetable codes and their descriptions.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CodeTable

readLanguageDetails

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

Reads the details of all languages on the system.

Returns:

List of languages available.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

Codetable

readAllWithoutContentAndVersionNo

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

Reads all data (including the version number) from available document templates except the content data.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

DocumentTemplate

searchCodeTables

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CodeTableSearchResults searchCodeTables(curam.core.facade.struct.CodeTableSearchKey key)
                                                                                       throws curam.util.exception.AppException,
                                                                                              curam.util.exception.InformationalException

Searches for code tables in the system.

Parameters:

key - Contains search string parameters.

Returns:

A list of code tables.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CodeTableAdmin

searchSecurityIdentifiers

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.SecurityIdentifierSearchResults searchSecurityIdentifiers(curam.core.facade.struct.SecurityIdentifierSearchKey key)
                                                                                                         throws curam.util.exception.AppException,
                                                                                                                curam.util.exception.InformationalException

Searches for security identifiers in the system.

Parameters:

key - Contains search string parameters. It can be an exact, partial or region match of a security identifier name.

Returns:

A list of security identifiers

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

SecurityAdmin

listTemplate1

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

Return details of all available XSL templates on the system.

Returns:

The list of XSL templates returned from the database.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

XSLTemplate

getTemplateVersions1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListTemplateVersions getTemplateVersions1(curam.core.facade.struct.XSLTemplateKey1 key)
                                                                                         throws curam.util.exception.AppException,
                                                                                                curam.util.exception.InformationalException

Reads all the version numbers for a specified template.

Parameters:

key - The template identifier.

Returns:

The list of templates versions for the specified template identifier.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

XSLTemplate

createDocumentTemplate1

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

Creates a document template.

Parameters:

details - Creation details for the new document template.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

DocumentTemplate

readDocumentTemplate1

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadDocumentTemplateDetails1 readDocumentTemplate1(curam.core.facade.struct.ReadDocumentTemplateKey key)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Reads the details of a specified document template.

Parameters:

key - A document template identifier.

Returns:

The details of the document template.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

DocumentTemplate

updateDocumentTemplate1

@AccessLevel(value=EXTERNAL)
void updateDocumentTemplate1(curam.core.facade.struct.ModifyDocumentTemplateKey key,
                                                          curam.core.facade.struct.ModifyDocumentTemplateDetails1 details)
                                                   throws curam.util.exception.AppException,
                                                          curam.util.exception.InformationalException

Modifies the details of a particular document template.

Parameters:

key - A document template identifier.

details - Contains the operation name, field name and the security identifer for that field.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

DocumentTemplate

listActiveDocumentTemplates1

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

Returns a list of active document templates.

Returns:

A list of active document templates.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

DocumentTemplate

listBatchProcessAndHasParam

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

Returns the complete list of batch processes that have associated descriptions and parameters.

Returns:

A list of the batch processes in the system which have descriptions and parameters.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

BatchAdmin

readXSLTemplate

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadXSLTemplateDetails readXSLTemplate(curam.core.facade.struct.XSLTemplateKey1 key)
                                                                                      throws curam.util.exception.AppException,
                                                                                             curam.util.exception.InformationalException

Reads the details of a specified XSL template.

Parameters:

key - Identifier of the template.

Returns:

The XSL template details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

XSLTemplate, UserAccess

modifyXSLTemplate

@AccessLevel(value=EXTERNAL)
void modifyXSLTemplate(curam.core.facade.struct.ModifyXSLTemplateDetails modifyDetails)
                                             throws curam.util.exception.AppException,
                                                    curam.util.exception.InformationalException

Modifies details of an existing XSL template.

Parameters:

details - The details of the template that are to be modified.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Write:

XSLTemplate

createXSLTemplate

@AccessLevel(value=EXTERNAL)
void createXSLTemplate(curam.core.facade.struct.CreateXSLTemplateDetails templateDetails)
                                             throws curam.util.exception.AppException,
                                                    curam.util.exception.InformationalException

Creates a new XSL template record.

Parameters:

details - The template details being created.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

XSLTemplate

Business Object Write:

XSLTemplate

listAllItemsInCodeTableForProgramLocale

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListItemsInCodeTable listAllItemsInCodeTableForProgramLocale(curam.core.facade.struct.CodeTableName key)
                                                                                                            throws curam.util.exception.AppException,
                                                                                                                   curam.util.exception.InformationalException

Returns the list of all the items in a specified codetable for program locale.

Parameters:

key - Codetable name.

Returns:

List of codetable items in a codetable.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CodeTableAdmin

listTranslationDescriptionText

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.LocalizableDescTxtDtlsList listTranslationDescriptionText(curam.core.facade.struct.LocalizableDescTxtKey key)
                                                                                                         throws curam.util.exception.AppException,
                                                                                                                curam.util.exception.InformationalException

Retrieve a list of translations associated with a given code table header.

Parameters:: key - Struct holding the ID associated with code table's translations.
Returns:: A list translations for that code table.
Throws:: AppException - Generic Exception Signature.; InformationalException - Generic Exception Signature.

addTranslationDescriptionText

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.AddTranslationDtlsOut addTranslationDescriptionText(curam.core.facade.struct.AddTranslationDtls translationDtls)
                                                                                                   throws curam.util.exception.AppException,
                                                                                                          curam.util.exception.InformationalException

Adds a localised name for a database header.

Parameters:: translationDtls - struct holding translation details
Returns:: Struct holding the ID associated with this translation.
Throws:: AppException - Generic Exception Signature.; InformationalException - Generic Exception Signature.

modifyTextTranslation

@AccessLevel(value=EXTERNAL)
void modifyTextTranslation(curam.core.facade.struct.AddTranslationDtls translationDtls)
                                                 throws curam.util.exception.AppException,
                                                        curam.util.exception.InformationalException

Modify a translation for a code table name.

Parameters:: translationDtls - Struct holding the displayNameId, local code and the translation text.
Throws:: AppException - Generic Exception Signature.; InformationalException - Generic Exception Signature.

removeTextTranslation

@AccessLevel(value=EXTERNAL)
void removeTextTranslation(curam.core.facade.struct.LocalizableDescTxtDtls descDtls)
                                                 throws curam.util.exception.AppException,
                                                        curam.util.exception.InformationalException

Delete a translation for a code table name.

Parameters:: descDtls - Struct holding the displayNameId, local code.
Throws:: AppException - Generic Exception Signature.; InformationalException - Generic Exception Signature.

searchByKeyAndLocale

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.LocalizableDescTxtDtls searchByKeyAndLocale(curam.core.facade.struct.LocalizableDescTxtDtls searchInput)
                                                                                           throws curam.util.exception.AppException,
                                                                                                  curam.util.exception.InformationalException

Retrieve a list of translations associated with a certain localeand displayNameId.

Parameters:: searchKey - Struct holding the displayNameId and locale code.
Returns:: A list translations.
Throws:: AppException - Generic Exception Signature.; InformationalException - Generic Exception Signature.

toggleCodeTableItem
```
@AccessLevel(value=EXTERNAL)
void toggleCodeTableItem(curam.core.facade.struct.ToggleCodeTableItemKey key)
                                               throws curam.util.exception.AppException,
                                                      curam.util.exception.InformationalException
```
Toggle the enabled property of a code table item. Method simply sets the code table item's enabled property to the opposite of what it currently is, either true or false.

Parameters:

key - Struct to read codetable item details.

Throws:

AppException - Generic Exception Signature.

InformationalException - Generic Exception Signature.

listCodeTableItemTranslations

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.CodeTableItemsDetailsList listCodeTableItemTranslations(curam.core.facade.struct.CodeTableItemCommonCode key)
                                                                                                       throws curam.util.exception.AppException,
                                                                                                              curam.util.exception.InformationalException

Retrieve a list of code table item translations associated with a given code table item.

Parameters:: key - Struct containing the name of the code table and code associated with the code table item of interest.
Returns:: A list translations for that code table item.
Throws:: AppException - Generic Exception Signature.; InformationalException - Generic Exception Signature.

filterListItemsInCodeTable
```
@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListItemsInCodeTable filterListItemsInCodeTable(curam.core.facade.struct.CodeTableItemFilter key)
                                                                                               throws curam.util.exception.AppException,
                                                                                                      curam.util.exception.InformationalException
```
Retrieve a list of code table items associated with a given code table. The list can be filtered to only return values that match a given string.

Parameters:

Key - Struct containing the name of the code table and and optional string value to filter the list.

Returns:

A list code table items associated with given code table.

Throws:

AppException - Generic Exception Signature.

InformationalException - Generic Exception Signature.

searchBatchProcess
```
@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListBatchProcessAndHasParam searchBatchProcess(curam.core.facade.struct.SearchBatchKey input)
                                                                                              throws curam.util.exception.AppException,
                                                                                                     curam.util.exception.InformationalException
```
Returns the list of batch processes that have associated descriptions and parameters, which meets the search criteria.

Parameters:

input - Contains search string parameters. It can be an exact, partial or region match of the name or description of the batch processes and the group they belong to.

Returns:

A list of the batch processes in the system which have descriptions and parameters.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

searchBatchProcessRequest
```
@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListBatchProcessRequest searchBatchProcessRequest(curam.core.facade.struct.SearchBatchKey input)
                                                                                                 throws curam.util.exception.AppException,
                                                                                                        curam.util.exception.InformationalException
```
Returns the list of batch process requests that have associated descriptions and parameters, which meets the search criteria.

Parameters:

input - Contains search string parameters. It can be an exact, partial or region match of the name or description of the batch processes and the group they belong to.

Returns:

A list of the batch process requests in the system which have descriptions and parameters.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listCodetablesWithDisplayInHierarchy

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListCodeTableWithDisplayInHierarchy listCodetablesWithDisplayInHierarchy(curam.core.facade.struct.HierarchyName hierarchyName)
                                                                                                                        throws curam.util.exception.AppException,
                                                                                                                               curam.util.exception.InformationalException

Lists all the code tables with display names contained in a specified hierarchy.

Parameters:

hierarchyName - Name of the hierarchy.

Returns:

List of codetables with display names.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CodeTableAdmin

listChildrenCodesAndDisplayName

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ListCodeDetailsAndDisplayName listChildrenCodesAndDisplayName(curam.core.facade.struct.ReadCodeTableItemKey key)
                                                                                                             throws curam.util.exception.AppException,
                                                                                                                    curam.util.exception.InformationalException

Returns the list of child codes for a specified codetable item.

Parameters:

key - Codetable item identifer.

Returns:

List of code details and table display name.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

Business Object Read:

CodeTableAdmin

Interface System

Method Summary

Method Detail

createCodeTable

listCodeTable

modifyCodeTableName

modifyCodeTableDefault

publishCodeTableChanges

listItemsInCodeTable

createCodeTableItem

modifyCodeTableItem

listSecurityRole

createSecurityRole

publishSecurityChanges

removeSecurityRole

readSecurityRole

readSecurityRoleForModify

removeSecurityGroup

modifySecurityRole

listSecurityGroup

createSecurityGroup

readSecurityGroup

readSecurityGroupForModify

modifySecurityGroup

listSecurityIdentifier

removeSecurityIdentifier

createSecurityIdentifier

readSecurityIdentifier

modifySecurityIdentifier

removeCodeTable

removeCodeTableItem

removeGroupFromRole

removeSIDFromGroup

checkInTemplate

undoCheckOutTemplate

checkOutTemplate

listBatchProcessRequest

listBatchProcess

listParameter

removeBatchProcessRequest

removeBatchProcess

modifyParameter

createBatchProcess

modifyBatchProcess

executeBatchProcess

createBatchGroup

removeBatchGroup

createGroupProcess

listBatchGroup

listGroupsForProcess

listBatchGroupItem

removeProcessFromGroup

readBatchProcess

readBatchParameterDetails

listAllUnassignedFids

listBatchProcessesWithoutDesc

readBatchProcessAndParamDetails

readCodeTableItem

addGroupsToRole

createFunctionSID

addSIDsToGroup

readBatchParameters

getTemplate

cancelDocumentTemplate

listDocumentTemplates

getDocumentTemplateContents

modifyDocumentTemplateContents

createBatchErrorCode

readBatchErrorCode

modifyBatchErrorCode

listBatchErrorCode

removeBatchErrorCode

readCodeTable

listHierarchies

listCodetablesInHierarchy

readCodetableHierarchyDetails

listCodes

readCodeDetails

readParentCode

listChildrenCodes