Index

A B C D E F G H I J L M N O P R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values

A

ACTIVE_FROM_DATE_PATH - Static variable in class com.apgar.common.lib.constants.Constants
Possible path of the field active from date
ACTIVE_INDICATOR_ACTIVE - Static variable in class com.apgar.common.lib.constants.Constants
Possible value of the field Active Indicator: Active
ACTIVE_INDICATOR_INACTIVE - Static variable in class com.apgar.common.lib.constants.Constants
Possible value of the field Active Indicator: Inactive
ACTIVE_INDICATOR_PATH - Static variable in class com.apgar.common.lib.constants.Constants
Possible path of the field Active Indicator
ACTIVE_INDICATOR_UNUSED - Static variable in class com.apgar.common.lib.constants.Constants
Possible value of the field Active Indicator: Unused
ACTIVE_TO_DATE_PATH - Static variable in class com.apgar.common.lib.constants.Constants
Possible path of the field active to date
AD_PASS - Static variable in class com.apgar.common.lib.constants.EnvironmentVariablesConstants
Environment variable containing the password for Active Directory (AD) authentication.
AD_URL - Static variable in class com.apgar.common.lib.constants.EnvironmentVariablesConstants
Environment variable containing the URL for Active Directory (AD) access.
AD_USER - Static variable in class com.apgar.common.lib.constants.EnvironmentVariablesConstants
Environment variable containing the username for Active Directory (AD) authentication.
addForEdit(UITableFilterResponseContext) - Method in class com.apgar.common.lib.filter.WorkflowIdUITableFilter
Adds editable forms that allow users to set and customize the filtering.
AffectationUserTask - Class in com.apgar.common.lib.workflow.usertask
Represents a common user task extension.
AffectationUserTask() - Constructor for class com.apgar.common.lib.workflow.usertask.AffectationUserTask
 
AND_WITH_SPACES - Static variable in class com.apgar.common.lib.constants.Constants
AND Value to use in Predicates and Queries
APPROVED_BY_PATH - Static variable in class com.apgar.common.lib.lineage.TrackingPath
approvedBy Path Tracking Information Path
APPROVED_DATE_PATH - Static variable in class com.apgar.common.lib.lineage.TrackingPath
approvedDate Path Tracking Information Path

B

BundledConstraint - Class in com.apgar.common.lib.constraint
Class that allows the use of the messages of file Bundle.
BundledConstraint() - Constructor for class com.apgar.common.lib.constraint.BundledConstraint
 

C

checkBeforeWorkItemCompletion(UserTaskBeforeWorkItemCompletionContext) - Method in class com.apgar.common.lib.workflow.usertask.CheckUpdatedRecordsValidationReportUserTask
Performs a blocking validation report check on the created/modified records.
checkBeforeWorkItemCompletion(UserTaskBeforeWorkItemCompletionContext) - Method in class com.apgar.common.lib.workflow.usertask.CheckValidationReportUserTask
Performs a blocking validation report check, at the dataset level, on the created/modified records.
checkNull(ValueContextForValidation) - Method in class com.apgar.common.lib.constraint.MandatoryIfOtherFieldEmpty
Checks if both fields are null and raise warnings/errors accordingly
checkNull(ValueContextForValidation) - Method in class com.apgar.common.lib.constraint.MandatoryOnOtherFieldValueConstraint
Performs constraint check in case of both null and raise warning/error accordingly
checkNull(ValueContextForValidation) - Method in class com.apgar.common.lib.constraint.MandatoryOnOtherFieldValueOtherwiseEmptyConstraint
Performs constraint check in case of both null and raise warning/error accordingly
checkNull(ValueContextForValidation) - Method in class com.apgar.common.lib.constraint.NotMandatoryOnOtherFieldValueConstraint
Checks if fields are null and raise error/warning accordingly
checkOccurrence(Object, ValueContextForValidation) - Method in class com.apgar.common.lib.constraint.GreaterOrEqualThanConstraint
Performs constraint check
checkOccurrence(Object, ValueContextForValidation) - Method in class com.apgar.common.lib.constraint.GreaterThanConstraint
Performs constraint check
checkOccurrence(Object, ValueContextForValidation) - Method in class com.apgar.common.lib.constraint.MandatoryIfOtherFieldEmpty
Checks if field is empty and raise warnings/errors accordingly
checkOccurrence(Object, ValueContextForValidation) - Method in class com.apgar.common.lib.constraint.MandatoryOnOtherFieldValueConstraint
Performs constraint check and raise warning/error accordingly
checkOccurrence(Object, ValueContextForValidation) - Method in class com.apgar.common.lib.constraint.MandatoryOnOtherFieldValueOtherwiseEmptyConstraint
Performs constraint check and raise warning/error accordingly
checkOccurrence(Object, ValueContextForValidation) - Method in class com.apgar.common.lib.constraint.NotMandatoryOnOtherFieldValueConstraint
Performs constraint check
checkRecord(ValueContextForValidationOnRecord) - Method in class com.apgar.common.lib.constraint.UniquenessCheckWithConditionConstraintOnTable
Checks uniqueness of record and raise error in case of violation
checkTable(ValueContextForValidationOnTable) - Method in class com.apgar.common.lib.constraint.UniquenessCheckWithConditionConstraintOnTable
Checks uniqueness across all records of the table based on the fields and predicate parameters
CheckUpdatedRecordsValidationReportUserTask - Class in com.apgar.common.lib.workflow.usertask
Blocks the work item completion if the created/modified records, in the same table, contain errors.
CheckUpdatedRecordsValidationReportUserTask() - Constructor for class com.apgar.common.lib.workflow.usertask.CheckUpdatedRecordsValidationReportUserTask
 
checkValidationError(Adaptation) - Static method in class com.apgar.common.lib.utils.ValidationUtils
Evaluates the validation report of the specified dataset and returns the records that contain errors.
checkValidationError(AdaptationHome, Map<PrimaryKey, Set<ValidationReportItem>>, Session) - Static method in class com.apgar.common.lib.utils.ValidationUtils
Evaluates the validation report of the specified dataspace and returns the records with validation errors, excluding those with matching errors in the provided initialErrorsMap.
checkValidationError(Adaptation, Map<PrimaryKey, Set<ValidationReportItem>>, Session) - Static method in class com.apgar.common.lib.utils.ValidationUtils
Evaluates the validation report of the specified dataset and returns the records with validation errors, excluding those with matching errors in the provided initialErrorsMap.
checkValidationError(Collection<AdaptationTable>) - Static method in class com.apgar.common.lib.utils.ValidationUtils
Evaluates the validation report of the tables belonging to the updatedTable collection and returns the records that contain errors.
checkValidationError(Collection<AdaptationTable>, Map<PrimaryKey, Set<ValidationReportItem>>, Session) - Static method in class com.apgar.common.lib.utils.ValidationUtils
Retrieves records with validation errors from the specified tables, excluding those with matching errors in the provided initialErrorsMap.
CheckValidationReportUserTask - Class in com.apgar.common.lib.workflow.usertask
Blocks the work item completion if the created/modified records, within the same dataset, contain errors.
CheckValidationReportUserTask() - Constructor for class com.apgar.common.lib.workflow.usertask.CheckValidationReportUserTask
 
CLOSE_PARENTHESES - Static variable in class com.apgar.common.lib.constants.Constants
) Value to use in Predicates and Queries
ClosedDataspaceRolloverScheduledTask - Class in com.apgar.common.lib.scheduledtask
This task deletes closed dataspaces that have been closed n days before.
ClosedDataspaceRolloverScheduledTask() - Constructor for class com.apgar.common.lib.scheduledtask.ClosedDataspaceRolloverScheduledTask
 
com.apgar.common.lib.constants - package com.apgar.common.lib.constants
Offers generic constraints for fields and tables, along with a base class for accessing messages from the resource bundle.
com.apgar.common.lib.constraint - package com.apgar.common.lib.constraint
Defines constants for EBX, including common variable names, environment variable identifiers, and workflow process constants.
com.apgar.common.lib.filter - package com.apgar.common.lib.filter
Provides common UI table filters.
com.apgar.common.lib.lineage - package com.apgar.common.lib.lineage
Defines the paths for commonly used tracking information fields.
com.apgar.common.lib.mail - package com.apgar.common.lib.mail
Enables sending emails in various formats using the specified mail configuration.
com.apgar.common.lib.procedure - package com.apgar.common.lib.procedure
Contains helper classes for procedures to inactivate and restore settings.
com.apgar.common.lib.properties - package com.apgar.common.lib.properties
Provides access to various properties files, including EBX properties, text properties, error properties, and localized resource files.
com.apgar.common.lib.rules - package com.apgar.common.lib.rules
Includes common rules, such as setting record metadata and field timestamps, retrieving foreign key labels, and obtaining relative paths.
com.apgar.common.lib.scheduledtask - package com.apgar.common.lib.scheduledtask
Contains common ScheduledTask.
com.apgar.common.lib.service - package com.apgar.common.lib.service
Includes common services for tables, datasets, and dataspaces, covering both declarations and user services.
com.apgar.common.lib.service.declaration - package com.apgar.common.lib.service.declaration
Includes declarations for the user services defined here.
com.apgar.common.lib.service.validation - package com.apgar.common.lib.service.validation
Provides validation services for tables, datasets, and dataspaces.
com.apgar.common.lib.trigger - package com.apgar.common.lib.trigger
Provides common table triggers.
com.apgar.common.lib.ui.widget - package com.apgar.common.lib.ui.widget
Contains common widgets with their corresponding factories.
com.apgar.common.lib.ui.widget.highlightwidget - package com.apgar.common.lib.ui.widget.highlightwidget
Contains the highlight widget, its corresponding factory, and an abstract widget for extending to accommodate additional widgets that work along with the highlight widget.
com.apgar.common.lib.ui.widget.passwordwidget - package com.apgar.common.lib.ui.widget.passwordwidget
com.apgar.common.lib.ui.widget.readonlywidget - package com.apgar.common.lib.ui.widget.readonlywidget
com.apgar.common.lib.utils - package com.apgar.common.lib.utils
Provides common utilities for datasets, user services, workflows, validation, tracking information, and module loaders.
com.apgar.common.lib.workflow - package com.apgar.common.lib.workflow
Provides common workflow functionalities, including launchers, script tasks, and user tasks.
com.apgar.common.lib.workflow.launcher - package com.apgar.common.lib.workflow.launcher
Provides common utilities for launching workflows.
com.apgar.common.lib.workflow.scripttask - package com.apgar.common.lib.workflow.scripttask
Provides common script task beans.
com.apgar.common.lib.workflow.usertask - package com.apgar.common.lib.workflow.usertask
Provides common user tasks along with generic abstract tasks for extension.
COMMA_WITH_SPACES - Static variable in class com.apgar.common.lib.constants.Constants
, Value to use in Predicates
CommonRules - Class in com.apgar.common.lib.rules
This class allows to define common rules of the project.
CommonUserTask - Class in com.apgar.common.lib.workflow.usertask
Represents a user task extension.
CommonUserTask() - Constructor for class com.apgar.common.lib.workflow.usertask.CommonUserTask
 
Constants - Class in com.apgar.common.lib.constants
Common MDM EBX Constants including commonly used variable names, values, and constants.
CopyChangesToMainDataspace - Class in com.apgar.common.lib.workflow.scripttask
Copies changes made to a specific table in a child dataspace to the main dataspace without closing the child dataspace.
CopyChangesToMainDataspace() - Constructor for class com.apgar.common.lib.workflow.scripttask.CopyChangesToMainDataspace
 
CREATED_BY_PATH - Static variable in class com.apgar.common.lib.lineage.TrackingPath
createdBy Path Tracking Information Path
CREATED_DATE_PATH - Static variable in class com.apgar.common.lib.lineage.TrackingPath
createdDate Path Tracking Information Path
createErrorUserMessage(Severity) - Method in class com.apgar.common.lib.constraint.BundledConstraint
Allows to create an error message using the defined messages in the error file bundle BundledConstraint.getErrorBundleBaseName()
createErrorUserMessage(Severity, String) - Method in class com.apgar.common.lib.constraint.BundledConstraint
Allows to create an error message using the defined messages in the error file bundle BundledConstraint.getErrorBundleBaseName()
createErrorUserMessage(Severity, String...) - Method in class com.apgar.common.lib.constraint.BundledConstraint
Allows to create an error message using the defined messages in the error file bundle BundledConstraint.getErrorBundleBaseName()
createErrorUserMessage(Severity, String, String...) - Method in class com.apgar.common.lib.constraint.BundledConstraint
Allows to create an error message using the defined messages in the error file bundle BundledConstraint.getErrorBundleBaseName()
createTechSessionForUser(Repository, UserReference) - Static method in class com.apgar.common.lib.utils.WorkflowUtils
Creates a technical session for the specified user.
createUserDocumentation(Locale) - Method in class com.apgar.common.lib.constraint.BundledConstraint
Creates user documentation
createUserDocumentation(Locale, String) - Method in class com.apgar.common.lib.constraint.BundledConstraint
Creates user documentation
createUserDocumentation(Locale, String...) - Method in class com.apgar.common.lib.constraint.BundledConstraint
Creates user documentation
createUserDocumentation(Locale, String, String...) - Method in class com.apgar.common.lib.constraint.BundledConstraint
Creates user documentation
createUserService() - Method in class com.apgar.common.lib.service.declaration.DatasetValidationReportExportServiceDeclaration
Creates a new user service implementation of the dataset validation report export.
createUserService() - Method in class com.apgar.common.lib.service.declaration.DataspaceValidationReportExportServiceDeclaration
Creates a new user service implementation of the dataspace validation report export.
createUserService() - Method in class com.apgar.common.lib.service.declaration.ValidationReportExportServiceDeclaration
Creates a new user service implementation of the validation report export.
Crypto - Class in com.apgar.common.lib.ui.widget.passwordwidget
Crypto Class used for the Password Widget.
CustomWidget - Class in com.apgar.common.lib.ui.widget.highlightwidget
Custom Widget Class.
CustomWidget() - Constructor for class com.apgar.common.lib.ui.widget.highlightwidget.CustomWidget
 

D

DASH_WITH_SPACES - Static variable in class com.apgar.common.lib.constants.Constants
- Value to use in Predicates
DATACONTEXT_APPROVER - Static variable in class com.apgar.common.lib.constants.Constants
approver Data Context Variable Name
DATACONTEXT_APPROVER - Static variable in class com.apgar.common.lib.constants.WorkflowConstants
approver Data Context Variable Name
DATACONTEXT_APPROVER_FOR_NOTIFICATION_FULL_NAME - Static variable in class com.apgar.common.lib.constants.Constants
approverForNotificationFullName Data Context Variable Name
DATACONTEXT_APPROVER_FOR_NOTIFICATION_FULL_NAME - Static variable in class com.apgar.common.lib.constants.WorkflowConstants
approverForNotificationFullName Data Context Variable Name
DATACONTEXT_CREATOR_KEY - Static variable in class com.apgar.common.lib.constants.Constants
creator Data Context Variable Name
DATACONTEXT_CREATOR_KEY - Static variable in class com.apgar.common.lib.constants.WorkflowConstants
creator Data Context Variable Name
DATACONTEXT_CREATOR_NOTIFICATION - Static variable in class com.apgar.common.lib.constants.Constants
creatorForNotification Data Context Variable Name
DATACONTEXT_CREATOR_NOTIFICATION - Static variable in class com.apgar.common.lib.constants.WorkflowConstants
creatorForNotification Data Context Variable Name
DATACONTEXT_CREATOR_NOTIFICATION_FULL_NAME - Static variable in class com.apgar.common.lib.constants.Constants
creatorForNotificationFullName Data Context Variable Name
DATACONTEXT_CREATOR_NOTIFICATION_FULL_NAME - Static variable in class com.apgar.common.lib.constants.WorkflowConstants
creatorForNotificationFullName Data Context Variable Name
DATACONTEXT_DATASET_KEY - Static variable in class com.apgar.common.lib.constants.Constants
dataSet Data Context Variable Name
DATACONTEXT_DATASET_KEY - Static variable in class com.apgar.common.lib.constants.WorkflowConstants
dataSet Data Context Variable Name
DATACONTEXT_DATASPACE_KEY - Static variable in class com.apgar.common.lib.constants.Constants
dataSpace Data Context Variable Name
DATACONTEXT_DATASPACE_KEY - Static variable in class com.apgar.common.lib.constants.WorkflowConstants
dataSpace Data Context Variable Name
DATACONTEXT_DATASPACE_WORKSPACE_KEY - Static variable in class com.apgar.common.lib.constants.Constants
workSpace Data Context Variable Name
DATACONTEXT_DATASPACE_WORKSPACE_KEY - Static variable in class com.apgar.common.lib.constants.WorkflowConstants
workSpace Data Context Variable Name
DATACONTEXT_DESCRIPTION_KEY - Static variable in class com.apgar.common.lib.constants.Constants
description Data Context Variable Name
DATACONTEXT_DESCRIPTION_KEY - Static variable in class com.apgar.common.lib.constants.WorkflowConstants
description Data Context Variable Name
DATACONTEXT_LAST_COMMENT - Static variable in class com.apgar.common.lib.constants.Constants
lastComment Data Context Variable Name
DATACONTEXT_LAST_COMMENT - Static variable in class com.apgar.common.lib.constants.WorkflowConstants
lastComment Data Context Variable Name
DATACONTEXT_LAST_USER - Static variable in class com.apgar.common.lib.constants.Constants
lastUser Data Context Variable Name
DATACONTEXT_LAST_USER - Static variable in class com.apgar.common.lib.constants.WorkflowConstants
lastUser Data Context Variable Name
DATACONTEXT_PREDICATE_KEY - Static variable in class com.apgar.common.lib.constants.Constants
predicate Data Context Variable Name
DATACONTEXT_PREDICATE_KEY - Static variable in class com.apgar.common.lib.constants.WorkflowConstants
predicate Data Context Variable Name
DATACONTEXT_PUBLICATION_NAME_KEY - Static variable in class com.apgar.common.lib.constants.Constants
publicationName Data Context Variable Name
DATACONTEXT_PUBLICATION_NAME_KEY - Static variable in class com.apgar.common.lib.constants.WorkflowConstants
publicationName Data Context Variable Name
DATACONTEXT_RECORD_KEY - Static variable in class com.apgar.common.lib.constants.Constants
record Data Context Variable Name
DATACONTEXT_RECORD_KEY - Static variable in class com.apgar.common.lib.constants.WorkflowConstants
record Data Context Variable Name
DATACONTEXT_RECORD_NAME - Static variable in class com.apgar.common.lib.constants.Constants
RecordName Data Context Variable Name
DATACONTEXT_RECORD_NAME - Static variable in class com.apgar.common.lib.constants.WorkflowConstants
RecordName Data Context Variable Name
DATACONTEXT_TABLE_NAME - Static variable in class com.apgar.common.lib.constants.Constants
tableName Data Context Variable Name
DATACONTEXT_TABLE_NAME - Static variable in class com.apgar.common.lib.constants.WorkflowConstants
tableName Data Context Variable Name
DATACONTEXT_TABLE_PATH - Static variable in class com.apgar.common.lib.constants.Constants
table Data Context Variable Name
DATACONTEXT_TABLE_PATH - Static variable in class com.apgar.common.lib.constants.WorkflowConstants
table Data Context Variable Name
DATACONTEXT_URL_CONNEXION - Static variable in class com.apgar.common.lib.constants.Constants
urlConnexion Data Context Variable Name
DATACONTEXT_URL_CONNEXION - Static variable in class com.apgar.common.lib.constants.WorkflowConstants
urlConnexion Data Context Variable Name
DATACONTEXT_USER_SALUTATION - Static variable in class com.apgar.common.lib.constants.Constants
userSalutation Data Context Variable Name
DATACONTEXT_USER_SALUTATION - Static variable in class com.apgar.common.lib.constants.WorkflowConstants
userSalutation Data Context Variable Name
DATACONTEXT_VIEW_PUBLICATION - Static variable in class com.apgar.common.lib.constants.Constants
viewPublication Data Context Variable Name
DATACONTEXT_VIEW_PUBLICATION - Static variable in class com.apgar.common.lib.constants.WorkflowConstants
viewPublication Data Context Variable Name
DATACONTEXT_WORKFLOW_ID - Static variable in class com.apgar.common.lib.constants.Constants
workflowId Data Context Variable Name
DATACONTEXT_WORKFLOW_ID - Static variable in class com.apgar.common.lib.constants.WorkflowConstants
workflowId Data Context Variable Name
DATACONTEXT_WORKSPACE_LABEL_KEY - Static variable in class com.apgar.common.lib.constants.Constants
workspaceLabel Data Context Variable Name
DATACONTEXT_WORKSPACE_LABEL_KEY - Static variable in class com.apgar.common.lib.constants.WorkflowConstants
workspaceLabel Data Context Variable Name
DatasetUtils - Class in com.apgar.common.lib.utils
Utility class for handling datasets
DatasetUtils() - Constructor for class com.apgar.common.lib.utils.DatasetUtils
 
DatasetValidationReportExportService - Class in com.apgar.common.lib.service.validation
Implementation of the Dataset Validation Report Export Service.
DatasetValidationReportExportService() - Constructor for class com.apgar.common.lib.service.validation.DatasetValidationReportExportService
 
DatasetValidationReportExportServiceDeclaration - Class in com.apgar.common.lib.service.declaration
Service Declaration for the Dataset Validation Report Export Service.
DatasetValidationReportExportServiceDeclaration(String) - Constructor for class com.apgar.common.lib.service.declaration.DatasetValidationReportExportServiceDeclaration
Constructor to be used to register this user service for a specific module.
DATASPACE_ID_DATE_FORMAT - Static variable in class com.apgar.common.lib.constants.WorkflowConstants
Date Format - Used to build the workflow dataspace ID
DATASPACE_ID_PREFIX - Static variable in class com.apgar.common.lib.constants.WorkflowConstants
ID Prefix - Used to build the workflow dataspace ID
DataSpaceMonthlySnapshotScheduledTask - Class in com.apgar.common.lib.scheduledtask
This task generates a snapshot of the specified dataspace.
DataSpaceMonthlySnapshotScheduledTask() - Constructor for class com.apgar.common.lib.scheduledtask.DataSpaceMonthlySnapshotScheduledTask
 
DataspaceValidationReportExportService - Class in com.apgar.common.lib.service.validation
Implementation of the Dataspace Validation Report Export Service.
DataspaceValidationReportExportService() - Constructor for class com.apgar.common.lib.service.validation.DataspaceValidationReportExportService
 
DataspaceValidationReportExportServiceDeclaration - Class in com.apgar.common.lib.service.declaration
Service Declaration for the Dataspace Validation Report Export Service.
DataspaceValidationReportExportServiceDeclaration(String) - Constructor for class com.apgar.common.lib.service.declaration.DataspaceValidationReportExportServiceDeclaration
Constructor to be used to register this user service for a specific module.
DATE_FORMAT_DAY_MONTH_YEAR - Static variable in class com.apgar.common.lib.constants.Constants
d MMMM yyyy Date Format
DATE_FORMAT_MONTH_YEAR - Static variable in class com.apgar.common.lib.constants.Constants
MM-yyyy Date Format
DateDefaultValueTrigger - Class in com.apgar.common.lib.trigger
Table trigger to fill a field (path as a parameter) with the current date value.
DateDefaultValueTrigger() - Constructor for class com.apgar.common.lib.trigger.DateDefaultValueTrigger
 
declareWebComponent(WebComponentDeclarationContext) - Method in class com.apgar.common.lib.service.declaration.DatasetValidationReportExportServiceDeclaration
Defines the web component properties of the user service.
declareWebComponent(WebComponentDeclarationContext) - Method in class com.apgar.common.lib.service.declaration.DataspaceValidationReportExportServiceDeclaration
Defines the web component properties of the user service.
declareWebComponent(WebComponentDeclarationContext) - Method in class com.apgar.common.lib.service.declaration.ValidationReportExportServiceDeclaration
Defines the web component properties of the user service.
decrypt(String) - Static method in class com.apgar.common.lib.ui.widget.passwordwidget.Crypto
Decrypt the passed String with authentication verification.
DefaultValueTrigger - Class in com.apgar.common.lib.trigger
Table trigger to fill a String field (path as a parameter) with a default value (as a parameter).
DefaultValueTrigger() - Constructor for class com.apgar.common.lib.trigger.DefaultValueTrigger
 
defineActivation(ActivationContextOnDataset) - Method in class com.apgar.common.lib.service.declaration.DatasetValidationReportExportServiceDeclaration
Defines the activation scope of this service.
defineActivation(ActivationContextOnDataspace) - Method in class com.apgar.common.lib.service.declaration.DataspaceValidationReportExportServiceDeclaration
Defines the activation scope of this service.
defineActivation(ActivationContextOnTableView) - Method in class com.apgar.common.lib.service.declaration.ValidationReportExportServiceDeclaration
Defines the activation scope of this service.
defineProperties(UserServicePropertiesDefinitionContext) - Method in class com.apgar.common.lib.service.declaration.DatasetValidationReportExportServiceDeclaration
Defines the properties of the user service.
defineProperties(UserServicePropertiesDefinitionContext) - Method in class com.apgar.common.lib.service.declaration.DataspaceValidationReportExportServiceDeclaration
Defines the properties of the user service.
defineProperties(UserServicePropertiesDefinitionContext) - Method in class com.apgar.common.lib.service.declaration.ValidationReportExportServiceDeclaration
Defines the properties of the user service.
displayIframeDivAndRefreshOnButtonClick(UserServiceWriter, String, String) - Static method in class com.apgar.common.lib.utils.UserServiceUtils
Displays a specific div element and refreshes its content when a button is clicked.
displayUserUpdateAlreadyOngoingErrorMessage(List<ProcessInstanceKey>, Locale, Repository, Session) - Static method in class com.apgar.common.lib.utils.WorkflowUtils
Displays a page indicating that there is an ongoing process associated with the record, along with a list of users currently holding processes.
distinctByKeys(Function<? super T, ?>...) - Static method in class com.apgar.common.lib.utils.ValidationUtils
Creates a Predicate that filters elements based on distinct keys extracted using the provided key extractors.
doesActiveIndicatorHaveToBeSet(TriggerSetupContext) - Static method in class com.apgar.common.lib.rules.CommonRules
Checks whether the Active Indicator needs to be set.
doInactive(boolean, boolean, boolean) - Method in class com.apgar.common.lib.procedure.ProcedureContextHelper
Sets the parameters of the procedureContext as per the method's arguments
doInactiveAll() - Method in class com.apgar.common.lib.procedure.ProcedureContextHelper
Gives all rights to the procedureContext
doRestoreAll() - Method in class com.apgar.common.lib.procedure.ProcedureContextHelper
Allows the restoring of the parameters' values
drawWidget(WidgetWriter, WidgetDisplayContext, String) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.CustomWidget
Abstract method to draw the widget.

E

EBX_DATE_FORMAT - Static variable in class com.apgar.common.lib.constants.Constants
yyyy-MM-dd EBX Date Format
EBX_DATE_FORMAT_MONTH_DAY_YEAR - Static variable in class com.apgar.common.lib.constants.Constants
MM-dd-yyyy EBX Date Format
EBX_DATETIME_FORMAT - Static variable in class com.apgar.common.lib.constants.Constants
yyyy-MM-dd'T'HH:mm:ss.SSS EBX Datetime Format
EBX_DATETIME_FORMAT_NO_MS - Static variable in class com.apgar.common.lib.constants.Constants
yyyy-MM-dd HH:mm:ss EBX Datetime Format without milliseconds
EBX_DATETIME_FORMAT_SQL - Static variable in class com.apgar.common.lib.constants.Constants
yyyy-MM-dd HH:mm:ss.SSS EBX Datetime Format For SQL Queries
EBX_DB_PASSWORD - Static variable in class com.apgar.common.lib.constants.EnvironmentVariablesConstants
Environment variable containing the password for connecting to the EBX database.
EBX_DB_URL - Static variable in class com.apgar.common.lib.constants.EnvironmentVariablesConstants
Environment variable containing the URL for the EBX database.
EBX_DB_USER - Static variable in class com.apgar.common.lib.constants.EnvironmentVariablesConstants
Environment variable containing the username for connecting to the EBX database.
EBX_SMTP_HOST - Static variable in class com.apgar.common.lib.constants.EnvironmentVariablesConstants
Environment variable containing the SMTP host for email configuration.
EBX_SMTP_LOGIN - Static variable in class com.apgar.common.lib.constants.EnvironmentVariablesConstants
Environment variable containing the login username for SMTP authentication.
EBX_SMTP_PASSWORD - Static variable in class com.apgar.common.lib.constants.EnvironmentVariablesConstants
Environment variable containing the password for SMTP authentication.
EBX_SMTP_PORT - Static variable in class com.apgar.common.lib.constants.EnvironmentVariablesConstants
Environment variable containing the SMTP port for email configuration.
EBX_SMTP_SSL_ENABLED - Static variable in class com.apgar.common.lib.constants.EnvironmentVariablesConstants
Environment variable indicating whether SSL is enabled for the SMTP connection.
EBX_TIME_FORMAT - Static variable in class com.apgar.common.lib.constants.Constants
HH:mm:ss EBX Time Format
EBX_WORKFLOW_MAIL_SENDER - Static variable in class com.apgar.common.lib.constants.EnvironmentVariablesConstants
Environment variable containing the email address used as the sender for workflow-related emails.
EbxProperties - Class in com.apgar.common.lib.properties
Utility class for managing EBX properties.
encrypt(String) - Static method in class com.apgar.common.lib.ui.widget.passwordwidget.Crypto
Encrypt the passed String and append authentication tag.
ENV_NAME - Static variable in class com.apgar.common.lib.constants.EnvironmentVariablesConstants
Environment variable containing the name of the environment.
ENV_TYPE - Static variable in class com.apgar.common.lib.constants.EnvironmentVariablesConstants
Environment variable containing the type of environment (e.g., development, production).
EnvironmentVariablesConstants - Class in com.apgar.common.lib.constants
This class defines constants for common environment variable names.
EQUALS_WITH_SPACES - Static variable in class com.apgar.common.lib.constants.Constants
= Value to use in Predicates and Queries
ES_PWD - Static variable in class com.apgar.common.lib.constants.EnvironmentVariablesConstants
Environment variable containing the password for Elastic Search (ES) access.
ES_USER - Static variable in class com.apgar.common.lib.constants.EnvironmentVariablesConstants
Environment variable containing the username for Elastic Search (ES) access.
execute(ScheduledExecutionContext) - Method in class com.apgar.common.lib.scheduledtask.ClosedDataspaceRolloverScheduledTask
Collects all the dataspaces that were closed threshold days before and deletes them.
execute(ScheduledExecutionContext) - Method in class com.apgar.common.lib.scheduledtask.DataSpaceMonthlySnapshotScheduledTask
Creates a snapshot of the specified dataspace.
executeScript(ScriptTaskBeanContext) - Method in class com.apgar.common.lib.workflow.scripttask.CopyChangesToMainDataspace
Copies changes made in the workflow working workspace to the main dataspace for a specific table in the designated dataset, including additions, modifications, and deletions.
executeScript(ScriptTaskBeanContext) - Method in class com.apgar.common.lib.workflow.scripttask.SetApprovalInformationScriptTask
Executes the script task to update the approval information for records.

F

formatRecordToTrackingInfo(Adaptation) - Static method in class com.apgar.common.lib.utils.TrackingInfoUtils
Format record to tracking info.

G

GenericValueCreationTrigger - Class in com.apgar.common.lib.trigger
Table trigger to pre-fill a few fields using data in a record passed in the session's tracking info.
GenericValueCreationTrigger() - Constructor for class com.apgar.common.lib.trigger.GenericValueCreationTrigger
 
getActiveProcessList(PublishedProcessKey, String, String, Repository, Session) - Static method in class com.apgar.common.lib.utils.WorkflowUtils
Retrieves active processes that have the value of the dataContextKey variable equals to variableValue.
getAllFieldsOfTable(Adaptation, Path, boolean) - Static method in class com.apgar.common.lib.utils.DatasetUtils
Retrieves a list of field paths from the specified table within the dataset.
getAllFieldsOfTable(Adaptation, Path, boolean, boolean) - Static method in class com.apgar.common.lib.utils.DatasetUtils
Retrieves a list of field paths from the specified table within the dataset.
getAllFieldsOfTable(Repository, String, Path, String, boolean, boolean) - Static method in class com.apgar.common.lib.utils.DatasetUtils
Retrieves a list of field paths from the specified table within the dataset.
getAllFieldsOfTable(SchemaNode[], boolean, boolean) - Static method in class com.apgar.common.lib.utils.DatasetUtils
Retrieves a list of field paths from the specified table and optionally includes paths of child fields.
getAllFieldsOfTable(SchemaNode, Path, boolean, boolean) - Static method in class com.apgar.common.lib.utils.DatasetUtils
Retrieves a list of field paths from the specified table within the schema node.
getAllTablesFromAdaptation(Adaptation) - Static method in class com.apgar.common.lib.utils.DatasetUtils
Returns the list of tables located under the specified dataset
getAllTablesFromNode(SchemaNode) - Static method in class com.apgar.common.lib.utils.DatasetUtils
Retrieves all table paths located under the specified schema node.
getAttachment() - Method in class com.apgar.common.lib.mail.MailSpecif
Returns the attachment file.
getBcc() - Method in class com.apgar.common.lib.mail.MailSpecif
Returns a set of bcc recipient email addresses.
getBlockCommit() - Method in class com.apgar.common.lib.constraint.GreaterThanConstraint
Gets the blockCommit variable specifying whether the constraint blocks an operation
getBothNullEndKeysProperty() - Method in class com.apgar.common.lib.constraint.MandatoryIfOtherFieldEmpty
Gets the bothNullEndKeysProperty field
getCc() - Method in class com.apgar.common.lib.mail.MailSpecif
Returns a set of cc recipient email addresses.
getClassLoader(String) - Method in class com.apgar.common.lib.utils.ModulesClassLoadersUtils
Retrieves the class loader for the specified module name.
getContent() - Method in class com.apgar.common.lib.mail.MailSpecif
Returns the body content of the email.
getCurrentDataset(AdaptationHome, DataContextReadOnly) - Static method in class com.apgar.common.lib.utils.WorkflowUtils
Returns the current dataset, as an adaptation, from the specified workflow data context.
getCurrentDataspace(Repository, DataContextReadOnly) - Static method in class com.apgar.common.lib.utils.WorkflowUtils
Returns the dataspace defined in the dataSpace data context variable as an AdaptationHome utilizing the given data context.
getCurrentDataspace(ScriptTaskContext) - Static method in class com.apgar.common.lib.utils.WorkflowUtils
Returns the dataspace defined in the dataSpace data context variable as an AdaptationHome in the context of a script task.
getCurrentDataspace(UserTaskBeforeWorkItemCompletionContext) - Static method in class com.apgar.common.lib.utils.WorkflowUtils
Returns the dataspace defined in the workSpace data context variable as an AdaptationHome before user task work item completion.
getCurrentDataspace(UserTaskCreationContext) - Static method in class com.apgar.common.lib.utils.WorkflowUtils
Returns the dataspace defined in the dataSpace data context variable as an AdaptationHome in the context of user task creation.
getCurrentRecord(Repository, DataContextReadOnly) - Static method in class com.apgar.common.lib.utils.WorkflowUtils
Retrieves the record as an Adaptation from the workflow context (i.e, the child dataspace created for the workflow instance) using its XPath.
getCurrentRecord(ProcessInstance) - Static method in class com.apgar.common.lib.utils.WorkflowUtils
Returns the current workflow record created/modified using the workflow data context variables of the specified processInstance.
getCurrentRecord(ScriptTaskContext) - Static method in class com.apgar.common.lib.utils.WorkflowUtils
Returns the current workflow record created/modified using the workflow data context variables for the specified script task.
getCurrentRecord(UserTaskBeforeWorkItemCompletionContext) - Static method in class com.apgar.common.lib.utils.WorkflowUtils
Returns the current workflow record created/modified using the workflow data context variables before work item completion.
getCurrentRecord(UserTaskCreationContext) - Static method in class com.apgar.common.lib.utils.WorkflowUtils
Returns the current workflow record created/modified using the workflow data context variables when handling work item creation.
getCurrentRecord(UserTaskWorkItemCompletionContext) - Static method in class com.apgar.common.lib.utils.WorkflowUtils
Returns the current workflow record created/modified using the workflow data context variables when handling work item completion.
getCurrentWorkspace(Repository, DataContextReadOnly) - Static method in class com.apgar.common.lib.utils.WorkflowUtils
Returns the current workflow working workspace utilizing the given data context.
getCurrentWorkspace(ScriptTaskContext) - Static method in class com.apgar.common.lib.utils.WorkflowUtils
Returns the current workflow working workspace in the context of a script task.
getDataset() - Method in class com.apgar.common.lib.workflow.scripttask.CopyChangesToMainDataspace
Returns the unique name of the dataset.
getDatasetList(AdaptationHome) - Static method in class com.apgar.common.lib.utils.DatasetUtils
Retrieves a list of datasets from the specified dataspace.
getDatasetTableList(Adaptation) - Static method in class com.apgar.common.lib.utils.DatasetUtils
Retrieves a list of table paths from a dataset.
getDatasetTableList(AdaptationHome, String) - Static method in class com.apgar.common.lib.utils.DatasetUtils
Retrieves a list of table paths for a dataset within a specified dataspace.
getDatasetTableList(Repository, String, String) - Static method in class com.apgar.common.lib.utils.DatasetUtils
Retrieves a list of table paths for a dataset within a specified dataspace.
getDataspace() - Method in class com.apgar.common.lib.scheduledtask.DataSpaceMonthlySnapshotScheduledTask
Returns the dataspace name.
getDataspace() - Method in class com.apgar.common.lib.workflow.scripttask.CopyChangesToMainDataspace
Returns the dataspace name.
getDefaultValue() - Method in class com.apgar.common.lib.trigger.DefaultValueTrigger
Returns the string value to be set to the field
getDocumentationBundleBaseName() - Method in class com.apgar.common.lib.constraint.BundledConstraint
 
getEbxHomeDirectory() - Static method in class com.apgar.common.lib.properties.EbxProperties
Retrieves the EBX home directory based on the system property ebx.home.
getEbxServerUrlForMail() - Static method in class com.apgar.common.lib.mail.MailService
Retrieves the URL defined in the workflow configuration for email settings.
getEmailActivationFromDeploymentVariable() - Method in class com.apgar.common.lib.mail.MailBean
Gets the email activation status from environment variables.
getEmailActivationFromEbxProperties() - Method in class com.apgar.common.lib.mail.MailBean
Retrieves the email activation status from ebx.mail.activate property in ebx.properties file.
getEndKeysProperty() - Method in class com.apgar.common.lib.constraint.MandatoryIfOtherFieldEmpty
Gets the endKeysProperty field
getEndKeysProperty() - Method in class com.apgar.common.lib.constraint.UniquenessCheckWithConditionConstraintOnTable
Gets the endKeyProperty
getErrorBundleBaseName() - Method in class com.apgar.common.lib.constraint.BundledConstraint
 
getErrorMessageBundle() - Static method in class com.apgar.common.lib.properties.RefResourceBundle
Retrieves the default error message resource bundle.
getErrorMessageBundle(Locale) - Static method in class com.apgar.common.lib.properties.RefResourceBundle
Retrieves the error message resource bundle based on the specified locale.
getErrorMessageFileName() - Static method in class com.apgar.common.lib.properties.PropertiesFiles
Returns the filename for the error properties file.
getFields() - Method in class com.apgar.common.lib.constraint.UniquenessCheckWithConditionConstraintOnTable
Gets fields which should be unique
getFileName() - Method in class com.apgar.common.lib.mail.MailSpecif
Returns the name of the attachment file.
getFkLabel(Adaptation, Path, Session) - Static method in class com.apgar.common.lib.rules.CommonRules
Gets foreign key label from record and path.
getFks() - Method in class com.apgar.common.lib.constraint.UniquenessCheckWithConditionConstraintOnTable
Gets the foreign keys as a semi-colon separated String
getFrom() - Method in class com.apgar.common.lib.mail.MailSpecif
Returns the sender's email address.
getHighlightColorForAssociation(WidgetWriter, WidgetDisplayContext) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidgetFactory
Returns the color used to highlight the field in association.
getHighlightColorForCreation(WidgetWriter, WidgetDisplayContext) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidgetFactory
Returns the color used to highlight the field during creation.
getHighlightColorForUpdate(WidgetWriter, WidgetDisplayContext) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidgetFactory
Returns the color used to highlight the field during update.
getInstance() - Static method in class com.apgar.common.lib.utils.ModulesClassLoadersUtils
Retrieves the instance of ModulesClassLoadersUtils.
getInstance(MailSpecif) - Static method in class com.apgar.common.lib.mail.MailService
Creates a new instance of MailService with the specified mail specifications.
getKeys() - Method in class com.apgar.common.lib.properties.RefResourceBundle
Retrieves all keys in the resource bundle.
getLastUser(ScriptTaskContext) - Static method in class com.apgar.common.lib.utils.WorkflowUtils
Returns the user ID (i.e., UserReference of the lastUser data context variable in the context of a script task.
getLocale(String) - Static method in class com.apgar.common.lib.properties.RefResourceBundle
Returns a complete Locale object based on the specified language.
getLogin() - Method in class com.apgar.common.lib.mail.MailBean
Gets the login for the SMTP server.
getMandatoringField() - Method in class com.apgar.common.lib.constraint.MandatoryOnOtherFieldValueConstraint
Gets the mandatoring field path
getMandatoringField() - Method in class com.apgar.common.lib.constraint.MandatoryOnOtherFieldValueOtherwiseEmptyConstraint
Gets the mandatoring field path
getMandatoringField() - Method in class com.apgar.common.lib.constraint.NotMandatoryOnOtherFieldValueConstraint
Gets the mandatoring field path
getMandatoringValue() - Method in class com.apgar.common.lib.constraint.MandatoryOnOtherFieldValueConstraint
Gets the mandatoring value
getMandatoringValue() - Method in class com.apgar.common.lib.constraint.MandatoryOnOtherFieldValueOtherwiseEmptyConstraint
Gets the mandatoring value
getMandatoringValue() - Method in class com.apgar.common.lib.constraint.NotMandatoryOnOtherFieldValueConstraint
Get the mandatoring value
getName() - Method in class com.apgar.common.lib.trigger.GenericValueCreationTrigger
Gets the parameter field
getOtherFieldPath() - Method in class com.apgar.common.lib.constraint.MandatoryIfOtherFieldEmpty
Gets the other field path
getParentHome(Session, WidgetDisplayContext) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidgetFactory
Returns the dataspace of the field the widget is declared on.
getParentRecordPkFromTrackingInfo(Session) - Static method in class com.apgar.common.lib.utils.WorkflowUtils
Parses the tracking information of the session in a workflow context to get the primary key of the created/modified record.
getPassword() - Method in class com.apgar.common.lib.mail.MailBean
Gets the password for the SMTP server.
getPath() - Method in class com.apgar.common.lib.constraint.GreaterOrEqualThanConstraint
Gets the path of the compared field
getPath() - Method in class com.apgar.common.lib.constraint.GreaterThanConstraint
Gets the path of the compared field
getPathToField() - Method in class com.apgar.common.lib.trigger.DateDefaultValueTrigger
Returns the path of the field to be set as a string
getPathToField() - Method in class com.apgar.common.lib.trigger.DefaultValueTrigger
Returns the path of the field to be set as a string
getPathToParentSdlId() - Method in class com.apgar.common.lib.trigger.MetaDataTableTrigger
Gets the pathToParentSdlId
getPks() - Method in class com.apgar.common.lib.constraint.UniquenessCheckWithConditionConstraintOnTable
Gets the primary keys as a semi-colon separated String
getPredicate() - Method in class com.apgar.common.lib.constraint.UniquenessCheckWithConditionConstraintOnTable
Gets the uniqueness predicate
getPropertiesBaseKey() - Method in class com.apgar.common.lib.constraint.BundledConstraint
 
getPropertiesDirectory() - Static method in class com.apgar.common.lib.properties.PropertiesFiles
Returns the directory where properties files are located.
getProperty(String) - Static method in class com.apgar.common.lib.properties.EbxProperties
Retrieves the value of property ebxPropertiesKey from the EBX properties file.
getProperty(String, String) - Static method in class com.apgar.common.lib.properties.EbxProperties
Retrieves the value of property ebxPropertiesKey from the EBX properties file, or returns defaultValue if the property is not found.
getPublishProcessKey(DataContext) - Static method in class com.apgar.common.lib.utils.WorkflowUtils
Returns the PublishedProcessKey from the specified data context.
getRecord(Repository, DataContextReadOnly, String) - Static method in class com.apgar.common.lib.utils.WorkflowUtils
Retrieves the record as an Adaptation from the specified workflow data context using the XPath defined in the recordVariableName data context variable.
getRecord(UserTaskCreationContext, String) - Static method in class com.apgar.common.lib.utils.WorkflowUtils
Retrieves the record as an Adaptation from the dataspace specified in the dataSpace data context variable using the given recordXPath.
getRecordDatasetFromTrackingInfo(String) - Static method in class com.apgar.common.lib.utils.TrackingInfoUtils
Get record dataset from tracking info.
getRecordFromTrackingInfo(AdaptationHome, String, String) - Static method in class com.apgar.common.lib.utils.TrackingInfoUtils
Get record from tracking info provided the dataset name and adaptation home.
getRecordFromTrackingInfo(Adaptation, String) - Static method in class com.apgar.common.lib.utils.TrackingInfoUtils
Get record from tracking info.
getRecordFromTrackingInfo(TableTriggerExecutionContext) - Static method in class com.apgar.common.lib.utils.TrackingInfoUtils
Get record from tracking provided the table trigger execution context.
getRecordPrimaryKeyFromTrackingInfo(TableTriggerExecutionContext) - Static method in class com.apgar.common.lib.utils.TrackingInfoUtils
Get record primary key from tracking info.
getRecordPrimaryKeyFromTrackingInfo(String) - Static method in class com.apgar.common.lib.utils.TrackingInfoUtils
Get record primary key from tracking info.
getRecordTablePathFromTrackingInfo(String) - Static method in class com.apgar.common.lib.utils.TrackingInfoUtils
Get record table path from tracking info.
getRecordUsingDatasetFromTrackingInfo(TableTriggerExecutionContext) - Static method in class com.apgar.common.lib.utils.TrackingInfoUtils
Get record from tracking info provided the table trigger execution context.
getRelativePathToRoot(ValueContext) - Static method in class com.apgar.common.lib.rules.CommonRules
Gets Relative Path To Root.
getRepositoryMailSender() - Static method in class com.apgar.common.lib.mail.MailService
Retrieves the sender email address configured for the workflow in the workflow administration settings.
getSavedPassword() - Method in class com.apgar.common.lib.ui.widget.passwordwidget.PasswordWidget
Get the saved password.
getServiceKey() - Method in class com.apgar.common.lib.service.declaration.DatasetValidationReportExportServiceDeclaration
Returns the identifier of the user service.
getServiceKey() - Method in class com.apgar.common.lib.service.declaration.DataspaceValidationReportExportServiceDeclaration
Returns the identifier of the user service.
getServiceKey() - Method in class com.apgar.common.lib.service.declaration.ValidationReportExportServiceDeclaration
Returns the identifier of the user service.
getSeverity() - Method in class com.apgar.common.lib.constraint.UniquenessCheckWithConditionConstraintOnTable
Gets the error severity
getSmtpHost() - Method in class com.apgar.common.lib.mail.MailBean
Gets the SMTP host.
getSmtpPort() - Method in class com.apgar.common.lib.mail.MailBean
Gets the SMTP port.
getSsl() - Method in class com.apgar.common.lib.mail.MailBean
Gets the SSL activation status for the SMTP connection.
getString(String) - Method in class com.apgar.common.lib.properties.RefResourceBundle
Returns the value corresponding to the specified key.
getString(String, String) - Method in class com.apgar.common.lib.properties.RefResourceBundle
Returns a formatted string corresponding to the specified key, replacing the placeholder with the provided single parameter.
getString(String, String[]) - Method in class com.apgar.common.lib.properties.RefResourceBundle
Returns a formatted string corresponding to the specified key, replacing placeholders with provided parameters.
getStringWithDefault(String, String) - Method in class com.apgar.common.lib.properties.RefResourceBundle
Returns the value associated with the specified key, or a default value if the key is not found.
getSubject() - Method in class com.apgar.common.lib.mail.MailSpecif
Returns the subject of the email.
getTable() - Method in class com.apgar.common.lib.workflow.scripttask.CopyChangesToMainDataspace
Returns the table path.
getTextBundle() - Static method in class com.apgar.common.lib.properties.RefResourceBundle
Retrieves the default text resource bundle for display.
getTextBundle(Locale) - Static method in class com.apgar.common.lib.properties.RefResourceBundle
Retrieves the text resource bundle for display based on the specified locale.
getTextBundle(Locale, String) - Static method in class com.apgar.common.lib.properties.RefResourceBundle
Retrieves the text resource bundle for display based on the specified locale and master data.
getTextFileName() - Static method in class com.apgar.common.lib.properties.PropertiesFiles
Returns the filename for the text properties file.
getThreshold() - Method in class com.apgar.common.lib.scheduledtask.ClosedDataspaceRolloverScheduledTask
Retrieves the threshold for closed dataspace deletion.
getTo() - Method in class com.apgar.common.lib.mail.MailSpecif
Returns a set of recipient email addresses.
getUser() - Method in class com.apgar.common.lib.workflow.usertask.AffectationUserTask
Gets owner of the work item.
getUserWithSalutation(Repository, UserReference, Locale) - Static method in class com.apgar.common.lib.rules.CommonRules
Gets the user with the salutation.
getUserWithSalutation(Repository, UserReference, Locale) - Static method in class com.apgar.common.lib.utils.WorkflowUtils
Returns the user's label with their salutation.
getValidationError(Adaptation) - Static method in class com.apgar.common.lib.utils.ValidationUtils
Retrieves all records in error along with their validation errors from the input dataset.
getValidationError(AdaptationHome) - Static method in class com.apgar.common.lib.utils.ValidationUtils
Retrieves all records in error along with their validation errors from the input dataspace.
getValidationError(Collection<AdaptationTable>) - Static method in class com.apgar.common.lib.utils.ValidationUtils
Retrieves all records in error, along with their validation errors, from the tables in the updatedTable collection.
getWorkDataspaceLabel(Session, PublishedProcessKey, AdaptationTable) - Static method in class com.apgar.common.lib.utils.WorkflowUtils
Creates the label of the workflow working dataspace (i.e., the created child dataspace).
getWorkDataspaceLabelWithCreatorName(Repository, Session, PublishedProcessKey, AdaptationTable) - Static method in class com.apgar.common.lib.utils.WorkflowUtils
Creates the label of the workflow working dataspace (i.e., the created child dataspace).
getWorkflowIdFieldPath() - Method in class com.apgar.common.lib.filter.WorkflowIdUITableFilter
Returns the string representation of the workflow ID field path.
getWorkflowPublicatioKeyFromTrackingInfo(String) - Static method in class com.apgar.common.lib.utils.TrackingInfoUtils
Get workflow publication key from tracking info.
getWorkspace() - Method in class com.apgar.common.lib.workflow.scripttask.CopyChangesToMainDataspace
Returns the child dataspace name (workflow working workspace).
GOOGLE_MAPS_API - Static variable in class com.apgar.common.lib.constants.EnvironmentVariablesConstants
Environment variable containing the URL for the Google Maps API.
GreaterOrEqualThanConstraint - Class in com.apgar.common.lib.constraint
Greater or Equal Than Constraint used to compare two fields.
GreaterOrEqualThanConstraint() - Constructor for class com.apgar.common.lib.constraint.GreaterOrEqualThanConstraint
 
GreaterThanConstraint - Class in com.apgar.common.lib.constraint
Greater Than Constraint used to compare two fields.
GreaterThanConstraint() - Constructor for class com.apgar.common.lib.constraint.GreaterThanConstraint
 

H

handleAfterCreate(AfterCreateOccurrenceContext) - Method in class com.apgar.common.lib.trigger.MetaDataTableTrigger
Set the record's meta data information at creation.
handleAfterModify(AfterModifyOccurrenceContext) - Method in class com.apgar.common.lib.trigger.MetaDataTableTrigger
Set the record's meta data information at modification.
handleApply(UITableFilterRequestContext) - Method in class com.apgar.common.lib.filter.WorkflowIdUITableFilter
Handles the filtering request when the "Apply filter" button is selected.
handleBeforeCreate(BeforeCreateOccurrenceContext) - Method in class com.apgar.common.lib.trigger.DefaultValueTrigger
 
handleBeforeCreate(BeforeCreateOccurrenceContext) - Method in class com.apgar.common.lib.trigger.MetaDataTableTrigger
Set the record's active indicator if needed at creation.
handleBeforeModify(BeforeModifyOccurrenceContext) - Method in class com.apgar.common.lib.trigger.MetaDataTableTrigger
Set the record's active indicator if needed at modification.
handleCreate(UserTaskCreationContext) - Method in class com.apgar.common.lib.workflow.usertask.AffectationUserTask
Executes the handleCreate method of the superclass while sending a notification mail for the work item owner.
handleCreate(UserTaskCreationContext) - Method in class com.apgar.common.lib.workflow.usertask.CommonUserTask
Executes the handleCreate method of the superclass if profiles are defined in the User Task configuration.
handleNewContext(NewTransientOccurrenceContext) - Method in class com.apgar.common.lib.trigger.DateDefaultValueTrigger
 
handleNewContext(NewTransientOccurrenceContext) - Method in class com.apgar.common.lib.trigger.DefaultValueTrigger
 
handleNewContext(NewTransientOccurrenceContext) - Method in class com.apgar.common.lib.trigger.GenericValueCreationTrigger
Sets the parameter value in the record
handleWorkItemCompletion(UserTaskWorkItemCompletionContext) - Method in class com.apgar.common.lib.workflow.usertask.CommonUserTask
Executes the handleWorkItemCompletion method of the superclass while passing along the comment and owner of this work item.
HASH_KEY_PATH - Static variable in class com.apgar.common.lib.lineage.TrackingPath
hashKey Path Tracking Information Path
hideMainDivAndShowWaitOnClick(UserServicePaneWriter, String, String, String) - Static method in class com.apgar.common.lib.utils.UserServiceUtils
Shows a loading screen and hides a specific div when the user clicks a designated button.
HighlightChangesWidget - Class in com.apgar.common.lib.ui.widget.highlightwidget
Highlight Changes Widget Class which highlight the changes for a record in a child dataspace and this same record in its parent dataspace (snapshot).
HighlightChangesWidget(Path, WidgetFactoryContext, HighlightChangesWidgetFactory) - Constructor for class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidget
Constructor.
HighlightChangesWidgetFactory - Class in com.apgar.common.lib.ui.widget.highlightwidget
Factory Class for HighlightChangesWidget
HighlightChangesWidgetFactory() - Constructor for class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidgetFactory
 

I

INTEGRATION_INSTANCE_ID_PATH - Static variable in class com.apgar.common.lib.lineage.TrackingPath
integrationInstanceId Path Tracking Information Path
INTEGRATION_SESSION_ID_PATH - Static variable in class com.apgar.common.lib.lineage.TrackingPath
integrationSessionId Path Tracking Information Path
isActive(Adaptation) - Static method in class com.apgar.common.lib.rules.CommonRules
Checks if Active Indicator is Active.
isHighlightColorEBXDefaultColor(WidgetWriter, WidgetDisplayContext) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidgetFactory
Specifies if the default EBX color is used to highlight fields.
isInWorkflowContext(InteractionHelper.ParametersMap, PublishedProcessKey) - Static method in class com.apgar.common.lib.utils.WorkflowUtils
Determines whether the specified interaction is in the context of the workflow with the given publishedProcessKey, using inputParams.
isInWorkflowContext(Session) - Static method in class com.apgar.common.lib.utils.WorkflowUtils
Determines whether the given session is within a workflow context.
isInWorkflowContext(Session, PublishedProcessKey) - Static method in class com.apgar.common.lib.utils.WorkflowUtils
Determines whether the session is in the context of the workflow with the specified publishedProcessKey.
isInWorkflowContext(Session, String) - Static method in class com.apgar.common.lib.utils.WorkflowUtils
Determines whether the session is in the context of the specified workflow.
isNewOccurence(Adaptation) - Static method in class com.apgar.common.lib.utils.WorkflowUtils
Determines whether the specified record was created during the workflow instance in the child dataspace.
isToIgnoreForImport(SchemaNode) - Static method in class com.apgar.common.lib.lineage.TrackingPath
Checks if node is ignored for import.
isValidAdaptations(Adaptation...) - Static method in class com.apgar.common.lib.utils.ValidationUtils
Checks the validation report of the input record(s) and returns those in error, along with their validation errors.

J

JAVA_COMP_ENV - Static variable in class com.apgar.common.lib.constants.EnvironmentVariablesConstants
The Java EE component environment context.

L

LAST_UPDATED_BY_PATH - Static variable in class com.apgar.common.lib.lineage.TrackingPath
lastUpdatedBy Path Tracking Information Path
LAST_UPDATED_DATE_PATH - Static variable in class com.apgar.common.lib.lineage.TrackingPath
lastUpdatedDate Path Tracking Information Path
launch(Repository, Session, PublishedProcessKey, Adaptation, DataContext, Integer) - Static method in class com.apgar.common.lib.workflow.launcher.WorkflowLauncher
Launches a workflow process created from a record and sets its parameters.
launchWithResult(AdaptationHome, Repository, Session, PublishedProcessKey, DataContext, Integer) - Static method in class com.apgar.common.lib.workflow.launcher.WorkflowLauncher
Creates a workflow and sets its input parameters.
launchWithResult(Session, PublishedProcessKey, Adaptation, DataContext, Integer) - Static method in class com.apgar.common.lib.workflow.launcher.WorkflowLauncher
Creates a workflow from a record and sets its input parameters.
launchWithResultDescription(AdaptationHome, Repository, Session, PublishedProcessKey, DataContext, Integer) - Static method in class com.apgar.common.lib.workflow.launcher.WorkflowLauncher
Creates a workflow and sets its input parameters, including a description.
launchWithWorkspaceCreationWithResult(Session, PublishedProcessKey, Adaptation, DataContext, Integer) - Static method in class com.apgar.common.lib.workflow.launcher.WorkflowLauncher
Creates a workflow from a record and sets its input parameters.

M

MailBean - Class in com.apgar.common.lib.mail
Represents a mail configuration bean that retrieves SMTP settings from environment variables or ebx.properties file.
MailBean() - Constructor for class com.apgar.common.lib.mail.MailBean
Constructs a new MailBean instance.
MailService - Class in com.apgar.common.lib.mail
Provides functionality to send emails using SMTP configuration defined in the environment variables or in the EBX properties file.
MailSpecif - Class in com.apgar.common.lib.mail
Represents a mail specification for sending emails.
MailSpecif(String, String, Role, Repository) - Constructor for class com.apgar.common.lib.mail.MailSpecif
Constructs a MailSpecif instance with a subject, a body, and recipients belonging to a specific role (toRole).
MailSpecif(String, String, UserReference, Repository) - Constructor for class com.apgar.common.lib.mail.MailSpecif
Constructs a MailSpecif instance for a specific user as the recipient, along with a specific subject and content.
MailSpecif(String, String, String) - Constructor for class com.apgar.common.lib.mail.MailSpecif
Constructs a MailSpecif with the specified subject, content, and recipients.
MailSpecif(String, String, String, String) - Constructor for class com.apgar.common.lib.mail.MailSpecif
Constructs a MailSpecif with the specified subject, content, recipients, and bcc recipients.
MailSpecif(String, String, String, String, String) - Constructor for class com.apgar.common.lib.mail.MailSpecif
Constructs a MailSpecif with the specified subject, content, sender, recipients, and bcc recipients.
MailSpecif(String, String, String, String, Set<String>) - Constructor for class com.apgar.common.lib.mail.MailSpecif
Constructs a MailSpecif instance with the specified subject, content, sender, recipients, and bcc recipients.
MailSpecif(String, String, String, String, Set<String>, String) - Constructor for class com.apgar.common.lib.mail.MailSpecif
Constructs a MailSpecif instance with the specified subject, content, sender, recipients, cc recipients, and bcc recipients.
MailSpecif(String, String, String, Set<String>) - Constructor for class com.apgar.common.lib.mail.MailSpecif
Constructs a MailSpecif with the specified subject, content, sender, and recipients.
MailSpecif(String, String, String, Set<String>, Set<String>) - Constructor for class com.apgar.common.lib.mail.MailSpecif
Constructs a MailSpecif with the specified subject, content, sender, recipients, and bcc recipients.
MailSpecif(String, String, String, Set<String>, Set<String>, String) - Constructor for class com.apgar.common.lib.mail.MailSpecif
Constructs a MailSpecif instance with the specified subject, content, sender, recipients, cc recipients, and bcc recipients.
MailSpecif(String, String, Set<String>) - Constructor for class com.apgar.common.lib.mail.MailSpecif
Constructs a MailSpecif with the specified subject, content, and recipients.
MailSpecif(String, String, Set<String>, Set<String>) - Constructor for class com.apgar.common.lib.mail.MailSpecif
Constructs a MailSpecif with the specified subject, content, recipients, and bcc recipients.
MandatoryIfOtherFieldEmpty - Class in com.apgar.common.lib.constraint
Constraint that checks if one field is filled, the other field should be empty.
MandatoryIfOtherFieldEmpty() - Constructor for class com.apgar.common.lib.constraint.MandatoryIfOtherFieldEmpty
 
MandatoryOnOtherFieldValueConstraint - Class in com.apgar.common.lib.constraint
Constraint that sets mandatory the field it is defined on if the parameter mandatoringField field has the same value as the parameter mandatoringValue.
MandatoryOnOtherFieldValueConstraint() - Constructor for class com.apgar.common.lib.constraint.MandatoryOnOtherFieldValueConstraint
 
MandatoryOnOtherFieldValueOtherwiseEmptyConstraint - Class in com.apgar.common.lib.constraint
Constraint that sets mandatory the field it is defined on if the parameter mandatoringField has the same value as the mandatoringValue parameter, otherwise it should be empty.
MandatoryOnOtherFieldValueOtherwiseEmptyConstraint() - Constructor for class com.apgar.common.lib.constraint.MandatoryOnOtherFieldValueOtherwiseEmptyConstraint
 
MASTER_FIELD_PREFIX - Static variable in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidget
Prefix of the master field used when drawing the widget.
MetaDataTableTrigger - Class in com.apgar.common.lib.trigger
Table trigger that allows the handling of a record's Tracking Information section.
MetaDataTableTrigger() - Constructor for class com.apgar.common.lib.trigger.MetaDataTableTrigger
 
ModulesClassLoadersUtils - Class in com.apgar.common.lib.utils
Utility class for managing and retrieving class loaders for modules.

N

NAME_PATH - Static variable in class com.apgar.common.lib.trigger.GenericValueCreationTrigger
Sample field to be set path
newInstance(WidgetFactoryContext) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidgetFactory
Creates an instance of the HighlightChangesWidget widget.
newInstance(WidgetFactoryContext) - Method in class com.apgar.common.lib.ui.widget.passwordwidget.PasswordWidgetFactory
 
newInstance(WidgetFactoryContext) - Method in class com.apgar.common.lib.ui.widget.readonlywidget.ReadOnlyUICustomWidgetFactory
Creates a new instance of ReadOnlyUICustomWidget using the provided WidgetFactoryContext.
NOT_EQUALS_WITH_SPACES - Static variable in class com.apgar.common.lib.constants.Constants
!= Value to use in Predicates
NOT_EQUALS_WITH_SPACES_QUERY - Static variable in class com.apgar.common.lib.constants.Constants
<> Value to use in Queries
NotMandatoryOnOtherFieldValueConstraint - Class in com.apgar.common.lib.constraint
Constraint that sets mandatory the field it is defined on if the parameter mandatoringField field has a different value than the mandatoringValue parameter.
NotMandatoryOnOtherFieldValueConstraint() - Constructor for class com.apgar.common.lib.constraint.NotMandatoryOnOtherFieldValueConstraint
 

O

OPEN_PARENTHESES - Static variable in class com.apgar.common.lib.constants.Constants
( Value to use in Predicates and Queries
OR_WITH_SPACES - Static variable in class com.apgar.common.lib.constants.Constants
OR Value to use in Predicates and Queries

P

PARAMETER_WITH_SPACES - Static variable in class com.apgar.common.lib.constants.Constants
$ Value to use in Predicates
PasswordWidget - Class in com.apgar.common.lib.ui.widget.passwordwidget
Password Widget
PasswordWidget(Path, WidgetFactoryContext) - Constructor for class com.apgar.common.lib.ui.widget.passwordwidget.PasswordWidget
Password Widget
PasswordWidgetFactory - Class in com.apgar.common.lib.ui.widget.passwordwidget
Password Widget Factory Class
PasswordWidgetFactory() - Constructor for class com.apgar.common.lib.ui.widget.passwordwidget.PasswordWidgetFactory
 
PRIORITY_HIGH - Static variable in class com.apgar.common.lib.constants.WorkflowConstants
Workflow Model High Priority
PRIORITY_NORMAL - Static variable in class com.apgar.common.lib.constants.WorkflowConstants
Workflow Model Normal Priority
PRIORITY_VERY_HIGH - Static variable in class com.apgar.common.lib.constants.WorkflowConstants
Workflow Model Very High Priority
ProcedureContextHelper - Class in com.apgar.common.lib.procedure
Allows saving all 3 parameters of the procedure context to execute the procedure, then restores their values
ProcedureContextHelper(ProcedureContext) - Constructor for class com.apgar.common.lib.procedure.ProcedureContextHelper
ProcedureContextHelper Constructor
processEventOutcome(UserServiceProcessEventOutcomeContext<DatasetEntitySelection>, UserServiceEventOutcome) - Method in class com.apgar.common.lib.service.validation.DatasetValidationReportExportService
Returns standard outcomes (outcomes created by UserServiceNext).
processEventOutcome(UserServiceProcessEventOutcomeContext<DataspaceEntitySelection>, UserServiceEventOutcome) - Method in class com.apgar.common.lib.service.validation.DataspaceValidationReportExportService
Returns standard outcomes (outcomes created by UserServiceNext).
processEventOutcome(UserServiceProcessEventOutcomeContext<TableViewEntitySelection>, UserServiceEventOutcome) - Method in class com.apgar.common.lib.service.validation.ValidationReportExportService
Returns standard outcomes (outcomes created by UserServiceNext).
PRODUCER_SYSTEM_ID_PATH - Static variable in class com.apgar.common.lib.lineage.TrackingPath
producerSystemId Path Tracking Information Path
PRODUCER_SYSTEM_LAST_UPDATED_DATE_PATH - Static variable in class com.apgar.common.lib.lineage.TrackingPath
producerSystemLastUpdatedDate Path Tracking Information Path
PRODUCER_SYSTEM_PARENT_RECORD_ID_PATH - Static variable in class com.apgar.common.lib.lineage.TrackingPath
producerSystemParentRecordId Path Tracking Information Path
PRODUCER_SYSTEM_RECORD_ID_PATH - Static variable in class com.apgar.common.lib.lineage.TrackingPath
producerSystemRecordId Path Tracking Information Path
PropertiesFiles - Class in com.apgar.common.lib.properties
This class provides access to the names and directory of properties files.

R

ReadOnlyUICustomWidget - Class in com.apgar.common.lib.ui.widget.readonlywidget
A custom UI widget that enforces read-only rights on a field within a form.
ReadOnlyUICustomWidget(Path, WidgetFactoryContext) - Constructor for class com.apgar.common.lib.ui.widget.readonlywidget.ReadOnlyUICustomWidget
Constructs a new ReadOnlyUICustomWidget for the specified path within the provided context.
ReadOnlyUICustomWidgetFactory - Class in com.apgar.common.lib.ui.widget.readonlywidget
Factory class for creating instances of ReadOnlyUICustomWidget.
ReadOnlyUICustomWidgetFactory() - Constructor for class com.apgar.common.lib.ui.widget.readonlywidget.ReadOnlyUICustomWidgetFactory
 
RefResourceBundle - Class in com.apgar.common.lib.properties
This class provides access to localized resource files.
RefResourceBundle(String, String) - Constructor for class com.apgar.common.lib.properties.RefResourceBundle
Loads a specific properties file.
RefResourceBundle(String, Locale) - Constructor for class com.apgar.common.lib.properties.RefResourceBundle
Loads the global properties file.
RefResourceBundle(String, Locale, String) - Constructor for class com.apgar.common.lib.properties.RefResourceBundle
Loads a specific localized properties file.

S

SDLID_PATH - Static variable in class com.apgar.common.lib.trigger.GenericValueCreationTrigger
Record SdlID path
sendMail() - Method in class com.apgar.common.lib.mail.MailService
Sends an email using the specifications provided in MailSpecif.
setActiveIndicator(ValueContextForUpdate) - Static method in class com.apgar.common.lib.rules.CommonRules
Sets the Active Indicator field.
setAllPrivileges(boolean) - Method in class com.apgar.common.lib.procedure.ProcedureContextHelper
Set the setAllPrivileges parameter
SetApprovalInformationScriptTask - Class in com.apgar.common.lib.workflow.scripttask
Updates the approval information for records in a specified dataset within a workflow context.
SetApprovalInformationScriptTask() - Constructor for class com.apgar.common.lib.workflow.scripttask.SetApprovalInformationScriptTask
 
setAttachment(File) - Method in class com.apgar.common.lib.mail.MailSpecif
Sets the attachment file for the email.
setBcc(Set<String>) - Method in class com.apgar.common.lib.mail.MailSpecif
Sets the bcc recipient email addresses.
setBlockCommit(String) - Method in class com.apgar.common.lib.constraint.GreaterThanConstraint
Sets the blockCommit variable specifying whether the constraint blocks an operation
setBothNullEndKeysProperty(String) - Method in class com.apgar.common.lib.constraint.MandatoryIfOtherFieldEmpty
Sets the setBothNullEndKeysProperty field
setCc(String) - Method in class com.apgar.common.lib.mail.MailSpecif
Sets the cc recipient email addresses from a string.
setCc(Set<String>) - Method in class com.apgar.common.lib.mail.MailSpecif
Sets the cc recipient email addresses.
setColorCodeOnAssociationChange(String) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidget
Sets a custom color code to identify associationChange.
setColorCodeOnCreate(String) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidget
Sets a custom color code to identify creations.
setColorCodeOnUpdate(String) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidget
Sets a custom color code to identify updates.
setContent(String) - Method in class com.apgar.common.lib.mail.MailSpecif
Sets the body content of the email.
setCurrentDateTime(ValueContextForUpdate, Path) - Static method in class com.apgar.common.lib.rules.CommonRules
Sets the date and current hour, minute, and seconds.
setCurrentTime(ValueContextForUpdate, Path) - Static method in class com.apgar.common.lib.rules.CommonRules
Sets the date of the day.
setCustomWidget(boolean) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidget
Sets the isCustomWidget, which specifies that a second widget is used.
setCustomWidgetClass(String) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidget
Sets the customWidgetClass, which specifies the second widget used.
setCustomWidgetClass(String) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidgetFactory
Sets the customWidgetClass, which specifies the second widget used.
setCustomWidgetModuleName(String) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidget
Sets the customWidgetModuleName, which is the module name from which the custom widget class is loaded.
setCustomWidgetModuleName(String) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidgetFactory
Sets the customWidgetModuleName, which is the module name from which the custom widget class is loaded.
setCustomWidgetParams(String) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidget
Sets the customWidgetParams, which will be used to draw the widget in case of HighlightChangesWidget.isCustomWidget = true.
setCustomWidgetParams(String) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidgetFactory
Sets the customWidgetParams, which will be used to draw the widget in case of HighlightChangesWidgetFactory.isCustomWidget = true.
setDataset(String) - Method in class com.apgar.common.lib.workflow.scripttask.CopyChangesToMainDataspace
Sets the dataset ID.
setDataspace(String) - Method in class com.apgar.common.lib.scheduledtask.DataSpaceMonthlySnapshotScheduledTask
Sets the dataspace ID.
setDataspace(String) - Method in class com.apgar.common.lib.workflow.scripttask.CopyChangesToMainDataspace
Sets the dataspace ID.
setDefaultValue(String) - Method in class com.apgar.common.lib.trigger.DefaultValueTrigger
Sets the default string value which the field the trigger is applied on will be set to
setEmailActivationFromDeploymentVariable(String) - Method in class com.apgar.common.lib.mail.MailBean
Sets the email activation status from the deployment variable.
setEmailActivationFromEbxProperties(String) - Method in class com.apgar.common.lib.mail.MailBean
Sets the email activation status.
setEndKeysProperty(String) - Method in class com.apgar.common.lib.constraint.MandatoryIfOtherFieldEmpty
Sets the endKeysProperty
setEndKeysProperty(String) - Method in class com.apgar.common.lib.constraint.UniquenessCheckWithConditionConstraintOnTable
Sets the endKeysProperty
setFactoryInstance(HighlightChangesWidgetFactory) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidget
Sets the instance of the factory class of the widget.
setFieldOnChangeJSMethod(String) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidget
Sets the name of the JavaScript Method called on field change.
setFieldOnChangeJSMethod(String) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidgetFactory
Sets the name of the JavaScript Method called on field change.
setFields(String) - Method in class com.apgar.common.lib.constraint.UniquenessCheckWithConditionConstraintOnTable
Sets fields to be checked
setFileName(String) - Method in class com.apgar.common.lib.mail.MailSpecif
Sets the name of the attachment file.
setFkInAssociation(Boolean) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidget
Sets the fkInAssociation field which detects changes in an association when the PK of the associated records is not a FK to the main record.
setFkInAssociation(String) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidgetFactory
Sets the fkInAssociation field which detects changes in an association when the PK of the associated records is not a FK to the main record.
setFks(String) - Method in class com.apgar.common.lib.constraint.UniquenessCheckWithConditionConstraintOnTable
Sets the foreign keys
setFrom(String) - Method in class com.apgar.common.lib.mail.MailSpecif
Sets the sender's email address.
setHistoryActivation(boolean) - Method in class com.apgar.common.lib.procedure.ProcedureContextHelper
Set the historyActivation parameter
setInputEventListenerJS(UserServicePaneWriter, String, String) - Static method in class com.apgar.common.lib.utils.UserServiceUtils
Sets an event listener for an input element to trigger a specified function on Enter key press.
setIsCustomWidget(String) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidgetFactory
Sets the isCustomWidget, which specifies that a second widget is used.
setIsLinkToRecord(String) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidgetFactory
Sets the isLinkToRecord field which specifies that a "Link to record" widget is drawn.
setIsMaster(String) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidgetFactory
Sets the master flag used to compare between the parent and child dataspace to perform the highlighting accordingly.
setIsReadOnly(String) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidgetFactory
Sets the widget to be read-only.
setIsReadOnlyOnCondition(String) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidgetFactory
Sets the widget to be read-only if a condition is verified.
setLinkToRecord(boolean) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidget
Sets the isLinkToRecord field which specifies that a "Link to record" widget is drawn.
setLinkToRecordBranch(String) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidget
Sets the linkToRecordBranch field which is the target dataspace of the record to be linked through the widget.
setLinkToRecordBranch(String) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidgetFactory
Sets the linkToRecordBranch field which is the target dataspace of the record to be linked through the widget.
setLinkToRecordContainer(String) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidget
Sets the linkToRecordContainer field which is the target dataset of the record to be linked through the widget.
setLinkToRecordContainer(String) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidgetFactory
Sets the linkToRecordContainer field which is the target dataset of the record to be linked through the widget.
setLinkToRecordKeyFieldPath(String) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidget
Sets the linkToRecordKeyFieldPath field which is a field of the target record to be linked through the widget based on this field's value.
setLinkToRecordKeyFieldPath(String) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidgetFactory
Sets the linkToRecordKeyFieldPath field which is a field of the target record to be linked through the widget based on this field's value.
setLinkToRecordTablePath(String) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidget
Sets the linkToRecordTablePath field which is the target table path of the record to be linked through the widget.
setLinkToRecordTablePath(String) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidgetFactory
Sets the linkToRecordTablePath field which is the target table path of the record to be linked through the widget.
setLogin(String) - Method in class com.apgar.common.lib.mail.MailBean
Sets the login for the SMTP server.
setMandatoringField(String) - Method in class com.apgar.common.lib.constraint.MandatoryOnOtherFieldValueConstraint
Sets the mandatoring field
setMandatoringField(String) - Method in class com.apgar.common.lib.constraint.MandatoryOnOtherFieldValueOtherwiseEmptyConstraint
Sets the mandatoring field
setMandatoringField(String) - Method in class com.apgar.common.lib.constraint.NotMandatoryOnOtherFieldValueConstraint
Sets the mandatoring field path
setMandatoringValue(String) - Method in class com.apgar.common.lib.constraint.MandatoryOnOtherFieldValueConstraint
Sets the mandatoring value according to its type
setMandatoringValue(String) - Method in class com.apgar.common.lib.constraint.MandatoryOnOtherFieldValueOtherwiseEmptyConstraint
Sets the mandatoring value according to its type
setMandatoringValue(String) - Method in class com.apgar.common.lib.constraint.NotMandatoryOnOtherFieldValueConstraint
Sets the mandatoring value according to its type
setMaster(boolean) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidget
Sets the master flag used to compare between the parent and child dataspace to perform the highlighting accordingly.
setMessage(String) - Method in class com.apgar.common.lib.workflow.usertask.CheckUpdatedRecordsValidationReportUserTask
Sets the error message displayed if the created/modified records have errors.
setMessage(String) - Method in class com.apgar.common.lib.workflow.usertask.CheckValidationReportUserTask
Sets the error message displayed if the created/modified records have errors.
setMillisecondsToZero(Date) - Static method in class com.apgar.common.lib.rules.CommonRules
Sets the milliseconds to zero for a given date.
setName(String) - Method in class com.apgar.common.lib.trigger.GenericValueCreationTrigger
Sets the parameter field
setOtherFieldPath(String) - Method in class com.apgar.common.lib.constraint.MandatoryIfOtherFieldEmpty
Sets the setOtherFieldPath field
setPassword(String) - Method in class com.apgar.common.lib.mail.MailBean
Sets the password for the SMTP server.
setPath(String) - Method in class com.apgar.common.lib.constraint.GreaterOrEqualThanConstraint
Sets the path of the compared field
setPath(String) - Method in class com.apgar.common.lib.constraint.GreaterThanConstraint
Sets the path of the compared field
setPathToField(String) - Method in class com.apgar.common.lib.trigger.DateDefaultValueTrigger
Sets the pathToField parameter
setPathToField(String) - Method in class com.apgar.common.lib.trigger.DefaultValueTrigger
Sets the path of the field
setPathToParentSdlId(Path) - Method in class com.apgar.common.lib.trigger.MetaDataTableTrigger
Sets the pathToParentSdlId path
setPks(String) - Method in class com.apgar.common.lib.constraint.UniquenessCheckWithConditionConstraintOnTable
Sets the primary keys
setPredicate(String) - Method in class com.apgar.common.lib.constraint.UniquenessCheckWithConditionConstraintOnTable
Sets the uniqueness predicate
setReadOnly(boolean) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidget
Sets the widget to be read-only.
setReadOnlyCondition(String) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidget
Sets the condition for setting the widget to be read-only.
setReadOnlyCondition(String) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidgetFactory
Sets the condition for setting the widget to be read-only.
setReadOnlyfieldToCheck(String) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidgetFactory
Sets the field to be checked, if it meets the HighlightChangesWidgetFactory.isReadOnlyOnCondition, the widget will be read-only.
setReadOnlyFieldToCheck(String) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidget
Sets the field to be checked, if it meets the HighlightChangesWidget.isReadOnlyOnCondition, the widget will be read-only.
setReadOnlyOnCondition(boolean) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidget
Sets the widget to be read-only if a condition is verified.
setSavedPassword(String) - Method in class com.apgar.common.lib.ui.widget.passwordwidget.PasswordWidget
Set the saved password.
setSeverity(String) - Method in class com.apgar.common.lib.constraint.UniquenessCheckWithConditionConstraintOnTable
Sets the error severity
setSmtpHost(String) - Method in class com.apgar.common.lib.mail.MailBean
Sets the SMTP host.
setSmtpPort(String) - Method in class com.apgar.common.lib.mail.MailBean
Sets the SMTP port.
setSsl(String) - Method in class com.apgar.common.lib.mail.MailBean
Sets the SSL activation status for the SMTP connection.
setSubject(String) - Method in class com.apgar.common.lib.mail.MailSpecif
Sets the subject of the email.
setTable(String) - Method in class com.apgar.common.lib.workflow.scripttask.CopyChangesToMainDataspace
Sets the table path.
setThreshold(int) - Method in class com.apgar.common.lib.scheduledtask.ClosedDataspaceRolloverScheduledTask
Sets the threshold for closed dataspace deletion.
setTimeToZero(Date) - Static method in class com.apgar.common.lib.rules.CommonRules
Sets the time to zero for a given date.
setTo(String) - Method in class com.apgar.common.lib.mail.MailSpecif
Sets the recipient email addresses from a single string.
setTo(Set<String>) - Method in class com.apgar.common.lib.mail.MailSpecif
Sets the recipient email addresses.
setTrackingInfo(UIHttpManagerComponent, PublishedProcessKey, Adaptation) - Static method in class com.apgar.common.lib.utils.WorkflowUtils
Formats the tracking information of the UIHttpManagerComponent used to access the record update/creation form before a workflow launch.
setTrackingMetaDataInformations(Adaptation, ProcedureContext, Session, Path, boolean) - Static method in class com.apgar.common.lib.rules.CommonRules
Allows setting the Meta Data Information in the Tracking tab depending on the type of flow.
setTriggerActivation(boolean) - Method in class com.apgar.common.lib.procedure.ProcedureContextHelper
Set the triggerActivation parameter
setup(ConstraintContext) - Method in class com.apgar.common.lib.constraint.GreaterOrEqualThanConstraint
 
setup(ConstraintContext) - Method in class com.apgar.common.lib.constraint.GreaterThanConstraint
 
setup(ConstraintContext) - Method in class com.apgar.common.lib.constraint.MandatoryIfOtherFieldEmpty
 
setup(ConstraintContext) - Method in class com.apgar.common.lib.constraint.MandatoryOnOtherFieldValueConstraint
Preliminary check of parameters and formatting to perform constraint check
setup(ConstraintContext) - Method in class com.apgar.common.lib.constraint.MandatoryOnOtherFieldValueOtherwiseEmptyConstraint
Preliminary check of parameters and formatting to perform constraint check
setup(ConstraintContext) - Method in class com.apgar.common.lib.constraint.NotMandatoryOnOtherFieldValueConstraint
Prepares nodes for constraint check
setup(ConstraintContextOnTable) - Method in class com.apgar.common.lib.constraint.UniquenessCheckWithConditionConstraintOnTable
Preliminary processing of fields from XSD so that they can be appended and included in the uniqueness check query
setup(TriggerSetupContext) - Method in class com.apgar.common.lib.trigger.DateDefaultValueTrigger
Perform type check
setup(TriggerSetupContext) - Method in class com.apgar.common.lib.trigger.DefaultValueTrigger
Performs type check
setup(TriggerSetupContext) - Method in class com.apgar.common.lib.trigger.GenericValueCreationTrigger
 
setup(TriggerSetupContext) - Method in class com.apgar.common.lib.trigger.MetaDataTableTrigger
Checks if active indicator needs to be set.
setup(WidgetFactorySetupContext) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidgetFactory
 
setup(WidgetFactorySetupContext) - Method in class com.apgar.common.lib.ui.widget.passwordwidget.PasswordWidgetFactory
 
setup(WidgetFactorySetupContext) - Method in class com.apgar.common.lib.ui.widget.readonlywidget.ReadOnlyUICustomWidgetFactory
Sets up the ReadOnlyUICustomWidgetFactory during its initialization phase.
setupDisplay(UserServiceSetupDisplayContext<DatasetEntitySelection>, UserServiceDisplayConfigurator) - Method in class com.apgar.common.lib.service.validation.DatasetValidationReportExportService
Sets up the display and functionality of the validation report export user service.
setupDisplay(UserServiceSetupDisplayContext<DataspaceEntitySelection>, UserServiceDisplayConfigurator) - Method in class com.apgar.common.lib.service.validation.DataspaceValidationReportExportService
Sets up the display and functionality of the validation report export user service.
setupDisplay(UserServiceSetupDisplayContext<TableViewEntitySelection>, UserServiceDisplayConfigurator) - Method in class com.apgar.common.lib.service.validation.ValidationReportExportService
Sets up the display and functionality of the validation report export user service.
setupObjectContext(UserServiceSetupObjectContext<DatasetEntitySelection>, UserServiceObjectContextBuilder) - Method in class com.apgar.common.lib.service.validation.DatasetValidationReportExportService
Defines/Removes objects managed by the user service.
setupObjectContext(UserServiceSetupObjectContext<DataspaceEntitySelection>, UserServiceObjectContextBuilder) - Method in class com.apgar.common.lib.service.validation.DataspaceValidationReportExportService
Defines/Removes objects managed by the user service.
setupObjectContext(UserServiceSetupObjectContext<TableViewEntitySelection>, UserServiceObjectContextBuilder) - Method in class com.apgar.common.lib.service.validation.ValidationReportExportService
Defines/Removes objects managed by the user service.
setUseEbxDefaultColor(boolean) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidget
Sets the useEbxDefaultColor field which if true, the widget attempts to use the default EBX color.
setUser(String) - Method in class com.apgar.common.lib.workflow.usertask.AffectationUserTask
Sets the owner of the work item.
setWorkflowIdFieldPath(String) - Method in class com.apgar.common.lib.filter.WorkflowIdUITableFilter
Sets the path of the workflow ID field.
setWorkspace(String) - Method in class com.apgar.common.lib.workflow.scripttask.CopyChangesToMainDataspace
Sets the workflow working workspace.
shouldDrawDefaultWidget(WidgetWriter, WidgetDisplayContext) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidgetFactory
Specifies if the default widget is drawn or not.
SLAVE_FIELD_PREFIX - Static variable in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidget
Prefix of the slave used when drawing the widget.
STATUS_PUBLISHED - Static variable in class com.apgar.common.lib.constants.Constants
Possible value of the field Status: Published
syncIframeHeightWithParent(UserServiceWriter) - Static method in class com.apgar.common.lib.utils.UserServiceUtils
Synchronizes the height of an iframe with its parent window.

T

TECHNICAL_RECORD_STATUS_ID_PATH - Static variable in class com.apgar.common.lib.lineage.TrackingPath
technicalRecordStatusId Path Tracking Information Path
TO_IGNORE_FOR_IMPORT_PATH_SET - Static variable in class com.apgar.common.lib.lineage.TrackingPath
Set of Paths to ignore for import - customizable
toUserDocumentation(Locale, ValueContext) - Method in class com.apgar.common.lib.constraint.GreaterOrEqualThanConstraint
Returns constraint message
toUserDocumentation(Locale, ValueContext) - Method in class com.apgar.common.lib.constraint.GreaterThanConstraint
Returns constraint message
toUserDocumentation(Locale, ValueContext) - Method in class com.apgar.common.lib.constraint.MandatoryIfOtherFieldEmpty
Returns constraint message
toUserDocumentation(Locale, ValueContext) - Method in class com.apgar.common.lib.constraint.MandatoryOnOtherFieldValueConstraint
Returns constraint message
toUserDocumentation(Locale, ValueContext) - Method in class com.apgar.common.lib.constraint.MandatoryOnOtherFieldValueOtherwiseEmptyConstraint
Returns constraint message
toUserDocumentation(Locale, ValueContext) - Method in class com.apgar.common.lib.constraint.NotMandatoryOnOtherFieldValueConstraint
Returns constraint message
toUserDocumentation(Locale, ValueContext) - Method in class com.apgar.common.lib.constraint.UniquenessCheckWithConditionConstraintOnTable
 
TRACKING_LAST_UPDATED_BY_EBX - Static variable in class com.apgar.common.lib.constants.Constants
Possible value of the field Last Updated By: ebx
TRACKING_PATH - Static variable in class com.apgar.common.lib.lineage.TrackingPath
tracking Path Tracking Information Path
TRACKING_TECHNICAL_RECORD_STATUS_DELETE - Static variable in class com.apgar.common.lib.constants.Constants
Technical Record Status Deleted in the producer system
TRACKING_TECHNICAL_RECORD_STATUS_PUBLISHED - Static variable in class com.apgar.common.lib.constants.Constants
Technical Record Status Published
TrackingInfoUtils - Class in com.apgar.common.lib.utils
Utility class providing methods to retrieve several attributes of a record from the tracking info.
TrackingInfoUtils() - Constructor for class com.apgar.common.lib.utils.TrackingInfoUtils
Constructor.
TrackingPath - Class in com.apgar.common.lib.lineage
Class containing the paths of tracking information fields to be referenced throughout the project.
TrackingPath() - Constructor for class com.apgar.common.lib.lineage.TrackingPath
 

U

UniquenessCheckWithConditionConstraintOnTable - Class in com.apgar.common.lib.constraint
Constraint that checks for record uniqueness across the table it is defined on and based on the fields passed as input parameters in the data model.
UniquenessCheckWithConditionConstraintOnTable() - Constructor for class com.apgar.common.lib.constraint.UniquenessCheckWithConditionConstraintOnTable
 
UserServiceUtils - Class in com.apgar.common.lib.utils
Utility class providing methods for displaying loading indicators, error messages, and managing user service interactions in a web interface.

V

validate(WidgetValidationContext) - Method in class com.apgar.common.lib.ui.widget.passwordwidget.PasswordWidget
 
validate(UserServiceValidateContext<DatasetEntitySelection>) - Method in class com.apgar.common.lib.service.validation.DatasetValidationReportExportService
Performs custom validation on a form submit.
validate(UserServiceValidateContext<DataspaceEntitySelection>) - Method in class com.apgar.common.lib.service.validation.DataspaceValidationReportExportService
Performs custom validation on a form submit.
validate(UserServiceValidateContext<TableViewEntitySelection>) - Method in class com.apgar.common.lib.service.validation.ValidationReportExportService
Performs custom validation on a form submit.
ValidationReportExportService - Class in com.apgar.common.lib.service.validation
Implementation of the Validation Report Export Service in table view.
ValidationReportExportService() - Constructor for class com.apgar.common.lib.service.validation.ValidationReportExportService
 
ValidationReportExportServiceDeclaration - Class in com.apgar.common.lib.service.declaration
Service Declaration for the Validation Report Export Service on tables.
ValidationReportExportServiceDeclaration(String) - Constructor for class com.apgar.common.lib.service.declaration.ValidationReportExportServiceDeclaration
Constructor to be used to register this user service for a specific module.
ValidationUtils - Class in com.apgar.common.lib.utils
Utility class that offers methods for checking validation errors for records across various inputs, including tables, datasets, and dataspaces.

W

WORKFLOW_ID - Static variable in class com.apgar.common.lib.lineage.TrackingPath
workflowId Path Tracking Information Path
WorkflowConstants - Class in com.apgar.common.lib.constants
Class containing common workflow constants.
WorkflowIdUITableFilter - Class in com.apgar.common.lib.filter
A custom UI table filter designed to keep only records that were modified or created within the current workflow workspace.
WorkflowIdUITableFilter() - Constructor for class com.apgar.common.lib.filter.WorkflowIdUITableFilter
 
WorkflowLauncher - Class in com.apgar.common.lib.workflow.launcher
Utility Class with common methods to launch a workflow.
WorkflowUtils - Class in com.apgar.common.lib.utils
Workflow Utility class
write(WidgetWriter, WidgetDisplayContext) - Method in class com.apgar.common.lib.ui.widget.highlightwidget.HighlightChangesWidget
Defines and draws the widget depending on the parameters of the HighlightChangesWidgetFactory instance.
write(WidgetWriter, WidgetDisplayContext) - Method in class com.apgar.common.lib.ui.widget.passwordwidget.PasswordWidget
 
write(WidgetWriter, WidgetDisplayContext) - Method in class com.apgar.common.lib.ui.widget.readonlywidget.ReadOnlyUICustomWidget
Renders the widget in the UI, setting the associated field to read-only.
writeDisplayWaitJs(UserServiceWriter, String) - Static method in class com.apgar.common.lib.utils.UserServiceUtils
Displays the loading div element in the user interface using JavaScript.
writeError(UserServicePaneWriter, String, String) - Static method in class com.apgar.common.lib.utils.UserServiceUtils
Displays an error message in the center of the screen.
writeExportValidationWait(UserServicePaneWriter, String, String) - Static method in class com.apgar.common.lib.utils.UserServiceUtils
Displays a loading sign during the export validation process with a custom message.
writeHideDivJs(UserServiceWriter, String) - Static method in class com.apgar.common.lib.utils.UserServiceUtils
Hides the specified div element using JavaScript.
writeHideWaitJsIFrame(UserServiceWriter, String) - Static method in class com.apgar.common.lib.utils.UserServiceUtils
Hides the loading div element in an iframe context, depending on the current user session.
writeHideWaitJsWsIFrame(UserServiceWriter, String) - Static method in class com.apgar.common.lib.utils.UserServiceUtils
Hides the loading div element in a specific iframe context.
writeWait(UserServicePaneWriter, String) - Static method in class com.apgar.common.lib.utils.UserServiceUtils
Displays a loading sign in the center of the screen.
writeWait(UserServicePaneWriter, String, String) - Static method in class com.apgar.common.lib.utils.UserServiceUtils
Displays a loading sign in the center of the screen with a custom message.
A B C D E F G H I J L M N O P R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values