Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- ActionMailSender - Class in com.collibra.dgc.workflow.api.listener
-
This Mail sender will send workflow action emails for the task this
TaskListener
is configured for. - ActionMailSender() - Constructor for class com.collibra.dgc.workflow.api.listener.ActionMailSender
B
- BODY_CONTENT_SEPARATOR - Static variable in class com.collibra.dgc.workflow.api.listener.ActionMailSender
- buildDefaultTranslations(String) - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowTranslation
-
Builds a properties file with all the translation keys and the built-in values.
C
- CheckMandatoryFieldCombinationTaskListener - Class in com.collibra.dgc.workflow.api.listener
-
This
TaskListener
checks if the configured combination of form property input fields have at least one value field filled in. - CheckMandatoryFieldCombinationTaskListener() - Constructor for class com.collibra.dgc.workflow.api.listener.CheckMandatoryFieldCombinationTaskListener
- com.collibra.dgc.workflow.api.bean - package com.collibra.dgc.workflow.api.bean
- com.collibra.dgc.workflow.api.delegate - package com.collibra.dgc.workflow.api.delegate
- com.collibra.dgc.workflow.api.exception - package com.collibra.dgc.workflow.api.exception
- com.collibra.dgc.workflow.api.listener - package com.collibra.dgc.workflow.api.listener
D
- DEFAULT_GROUPED_TEMPLATE - Static variable in class com.collibra.dgc.workflow.api.listener.ActionMailSender
-
Workflow email action mail default grouped template.
- DEFAULT_MAIL_BUTTON_KEY - Static variable in class com.collibra.dgc.workflow.api.listener.ActionMailSender
-
Workflow email action mail default button.
- DEFAULT_MAIL_SUBJECT_KEY - Static variable in class com.collibra.dgc.workflow.api.listener.ActionMailSender
-
Workflow email action mail default subject.
- DEFAULT_NON_GROUPED_TEMPLATE - Static variable in class com.collibra.dgc.workflow.api.listener.ActionMailSender
-
Workflow email action mail default non grouped template.
- DEFAULT_SECTION - Static variable in class com.collibra.dgc.workflow.api.listener.ActionMailSender
-
Workflow email action mail default section.
E
- execute(DelegateExecution) - Method in class com.collibra.dgc.workflow.api.delegate.StartCollibraConnectFlowDelegate
F
- fillTranslations(String, String) - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowTranslation
-
This will update the (override) translation file and add all keys that are not present yet.
- FlushExecutionListener - Class in com.collibra.dgc.workflow.api.listener
-
This
ExecutionListener
will flush all changes which has been done in scope of current session. - FlushExecutionListener() - Constructor for class com.collibra.dgc.workflow.api.listener.FlushExecutionListener
G
- getAllLocales() - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowTranslation
-
Returns all the possible locales.
- getAvailableLocales() - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowTranslation
-
Returns a list of available locales.
- getAvailableOverrideLocales() - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowTranslation
-
Returns a list of locales that have overridden values.
- getCapitalizedMessage(String, Object...) - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowTranslation
-
Get the capitalized message for the given key, using the given parameters and the current localization.
- getCommunityId() - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowBusinessItem
-
Retrieve the community id of the business item if present.
- getCronExpressionNextRunDate(String, Date) - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowUtility
-
Retrieves next run date based on a cron expression and the last run date.
- getCurrent() - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowUsers
-
Return the current user name.
- getDefaultLocale() - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowTranslation
-
Retrieve the default locale of the application.
- getDomainId() - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowBusinessItem
-
Retrieve the UUID of the vocabulary of the business item, if possible, otherwise return null.
- getEmailAddresses(String) - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowMail
-
Retrieves the email addresses from a comma separated string of user expressions.
- getEmailAddressesForUserNames(String) - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowMail
-
Retrieves the email addresses from a comma separated string of usernames.
- getEmailAddressForUserName(String) - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowMail
-
Retrieves the primary email address for a single user, empty string if none found.
- getEscalationType() - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowEvent
-
Retrieve the escalation type.
- getEscalationType() - Method in class com.collibra.dgc.workflow.api.listener.SendEscalationEventExecutionListener
- getEscalationType(DelegateExecution) - Method in class com.collibra.dgc.workflow.api.listener.SendEscalationEventExecutionListener
-
Retrieve the escalation type, first look in the escalationType field of this Listener, then look in the standard escalation type variable of the current execution.
- getEventResourceId() - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowEvent
-
Retrieve the resource id causing the event.
- getEventResourceType() - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowEvent
-
Retrieve the ResourceType of the resource that caused the event.
- getEventType() - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowEvent
-
Retrieve the
WorkflowStartEventType
. - getId() - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowBusinessItem
-
Retrieve the id of the business item.
- getMessage(String, Object...) - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowTranslation
-
Get the message for the given key, using the given parameters and the current localization.
- getName() - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowBusinessItem
-
Retrieve the verbalised form the the item.
- getResource() - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowBusinessItem
-
Retrieve the actual
Resource
object of the business item. - getRoleId(String) - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowUsers
-
Retrieves the role Id for the given roleName.
- getRoleIds(String) - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowUsers
-
Retrieves all the role Ids from a comma separated string of role names.
- getTaskCandidateUsers() - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowEvent
-
Returns the candidate users of the current task if any.
- getTaskId() - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowEvent
-
Returns the original task id that sent out this event, if any.
- getTaskId() - Method in class com.collibra.dgc.workflow.api.listener.SendEscalationEventExecutionListener
- getTaskKey() - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowEvent
-
Returns the original task key that sent out this event, if any.
- getTitleMessage() - Method in exception com.collibra.dgc.workflow.api.exception.WorkflowException
-
Retrieves the title of the exception message.
- getTranslationOverrides(String) - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowTranslation
-
Provides the translation overrides of a specific language.
- getType() - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowBusinessItem
-
Retrieve the
ResourceType
of the business item. - getTypeName() - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowBusinessItem
-
Get the name of the Type of the business item.
- getUrl() - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowBusinessItem
-
Retrieve the url to be able to consult the business item directly in the application or
null
if none. - getUserIds(String) - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowUsers
-
Retrieves all the user Ids from a comma separated string of user expressions.
- getUserIdsFromRoles(String) - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowUsers
-
Retrieve the userIds from a comma separated list of roles.
- getUserMessage() - Method in exception com.collibra.dgc.workflow.api.exception.WorkflowException
-
Retrieves the user message.
- getUserNames(String) - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowUsers
-
Converts a Candidate user expression to a
Set
of user names using the current workflow business item. - getUserNamesCsv(String) - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowUsers
-
Converts a Candidate user expression to a comma separated list of user names using the current workflow business item.
- getUserNamesWithError(String) - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowUsers
-
Converts a Candidate user expression to a
Set
of user names using the current workflow business item. - getUserNamesWithParticipatePermissionWithError(String) - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowUsers
-
Converts a Candidate user expression to a
Set
of user names using the current workflow business item with Participate Permissions. - getUsers(String) - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowUsers
-
Retrieves all the users from a comma separated string of user expressions.
- getUsersFromRoles(String) - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowUsers
-
Retrieve the users from a comma separated list of roles.
- getWorkflowDefinition() - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowEvent
-
Returns the workflow definition of this event if it was triggered in a workflow.
I
- isEmpty(String) - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowUsers
-
Analyses the given expression and indicates if the expression resolves to any user or not.
N
- notify(DelegateExecution) - Method in class com.collibra.dgc.workflow.api.listener.FlushExecutionListener
- notify(DelegateExecution) - Method in class com.collibra.dgc.workflow.api.listener.SendEscalationEventExecutionListener
- notify(DelegateExecution) - Method in class com.collibra.dgc.workflow.api.listener.SetActivityStreamListener
- notify(DelegateExecution) - Method in class com.collibra.dgc.workflow.api.listener.SetResponsibilitiesExecutionListener
- notify(DelegateTask) - Method in class com.collibra.dgc.workflow.api.listener.ActionMailSender
- notify(DelegateTask) - Method in class com.collibra.dgc.workflow.api.listener.CheckMandatoryFieldCombinationTaskListener
- notify(DelegateTask) - Method in class com.collibra.dgc.workflow.api.listener.SetActivityStreamListener
- notify(DelegateTask) - Method in class com.collibra.dgc.workflow.api.listener.SetFormSubtitleTaskListener
R
- runAsUserById(UUID, Runnable) - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowUsers
-
Run the given runnable logic as a given user.
- runAsUserByUserName(String, Runnable) - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowUsers
-
Run the given runnable logic as a given user.
S
- SendEscalationEventExecutionListener - Class in com.collibra.dgc.workflow.api.listener
-
This
ExecutionListener
will send an escalation application event. - SendEscalationEventExecutionListener() - Constructor for class com.collibra.dgc.workflow.api.listener.SendEscalationEventExecutionListener
- sendMails(Collection<UUID>, String, String, ExecutionEntity) - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowMail
-
Sending mails from the workflow.
- SetActivityStreamListener - Class in com.collibra.dgc.workflow.api.listener
-
A listener capable of setting the filter which will be used to generate a activity stream.
- SetActivityStreamListener() - Constructor for class com.collibra.dgc.workflow.api.listener.SetActivityStreamListener
- setEscalationType(Expression) - Method in class com.collibra.dgc.workflow.api.listener.SendEscalationEventExecutionListener
- SetFormSubtitleTaskListener - Class in com.collibra.dgc.workflow.api.listener
-
This
TaskListener
sets a given string value as the subtitle for the form to be displayed on the task. - SetFormSubtitleTaskListener() - Constructor for class com.collibra.dgc.workflow.api.listener.SetFormSubtitleTaskListener
- setNotificationEmail(VariableContainer, String, boolean) - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowMail
-
Sets notification email sending to the given value for the given task id.
- SetResponsibilitiesExecutionListener - Class in com.collibra.dgc.workflow.api.listener
-
This
ExecutionListener
will set the responsibilities for the business item of the workflow. - SetResponsibilitiesExecutionListener() - Constructor for class com.collibra.dgc.workflow.api.listener.SetResponsibilitiesExecutionListener
- setTaskId(Expression) - Method in class com.collibra.dgc.workflow.api.listener.SendEscalationEventExecutionListener
- setTitleMessage(String) - Method in exception com.collibra.dgc.workflow.api.exception.WorkflowException
-
Sets the title of the exception.
- setTranslationOverrides(String, String) - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowTranslation
-
Override and save the translations of the given locale.
- setUserMessage(String) - Method in exception com.collibra.dgc.workflow.api.exception.WorkflowException
-
Sets the exception message.
- StartCollibraConnectFlowDelegate - Class in com.collibra.dgc.workflow.api.delegate
-
JavaDelegate
for starting Collibra Connect flow. - StartCollibraConnectFlowDelegate() - Constructor for class com.collibra.dgc.workflow.api.delegate.StartCollibraConnectFlowDelegate
- stripHtml(String) - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowUtility
-
Remove all the HTML formatting from the given input string, unescaping it before.
T
- TEMPLATE_VAR_ACTION_CONTENTS - Static variable in class com.collibra.dgc.workflow.api.listener.ActionMailSender
-
Deprecated.This field will be removed in the future.
- toCsv(Collection<?>) - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowUtility
-
Creates a csv of the given @{link Collection}.
- toIdCsv(Collection<? extends Resource>) - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowUtility
-
Converts a
Collection
ofResource
s to a csv resource ids. - toIdList(String) - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowUtility
-
Creates a list of the given csv string.
- toIdList(Collection<? extends Resource>) - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowUtility
-
Converts a
Collection
of resources to a list of resource ids. - toList(String) - Method in interface com.collibra.dgc.workflow.api.bean.WorkflowUtility
-
Creates a list of the given csv string.
W
- WORKFLOW_ACTION_BODY_LINE - Static variable in class com.collibra.dgc.workflow.api.listener.ActionMailSender
-
Workflow email action mail line telling user to provide a body to the task.
- WORKFLOW_ACTION_BODY_MANDATORY - Static variable in class com.collibra.dgc.workflow.api.listener.ActionMailSender
- WORKFLOW_ACTION_BODY_OPTIONAL - Static variable in class com.collibra.dgc.workflow.api.listener.ActionMailSender
- WorkflowBusinessItem - Interface in com.collibra.dgc.workflow.api.bean
-
A bean to provide easy access to business item related variables and operations of the running process.
- WorkflowEvent - Interface in com.collibra.dgc.workflow.api.bean
-
A bean to provide easy access to event related variables and operations of the running process.
- WorkflowException - Exception in com.collibra.dgc.workflow.api.exception
-
This exception indicates that something went wrong in workflow script.
- WorkflowException(String) - Constructor for exception com.collibra.dgc.workflow.api.exception.WorkflowException
- WorkflowException(String, Throwable) - Constructor for exception com.collibra.dgc.workflow.api.exception.WorkflowException
- WorkflowException(Throwable) - Constructor for exception com.collibra.dgc.workflow.api.exception.WorkflowException
- WorkflowMail - Interface in com.collibra.dgc.workflow.api.bean
-
A bean to provide easy access to mail related functionalities.
- WorkflowTranslation - Interface in com.collibra.dgc.workflow.api.bean
-
A bean providing i18n (translation) related functionality.
- WorkflowUsers - Interface in com.collibra.dgc.workflow.api.bean
-
Workflow bean providing access to user related functionalities.
- WorkflowUtility - Interface in com.collibra.dgc.workflow.api.bean
-
A bean to provide general utility functions.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form