Interface ITriggerDataDescriptor

All Known Subinterfaces:
IBaseTrigger<TData>, IBeanValidatingTrigger<TData>, IBuiltinTriggerType<TData>, IDefaultClientHandlerTrigger<TData>, IFcCatchErrorDescriptors, IFcDoiVerifiedDescriptors, IFcFormRecordMessagePostedDescriptors, IFcFormRecordMessageUploadRequestFulfilledDescriptors, IFcFormSubmitButtonDescriptors, IFcInvitationErrorDescriptors, IFcInvitationSentDescriptors, IFcManualDescriptors, IFcQualifiedFormSubmitButtonDescriptors, IFcStateTimerDescriptors, IFcTimePointDescriptors, IFcUserInvocationDescriptors, IOfficialHelpPageTrigger<TData>, IPluginTriggerHandler<TData>, ISemverUpdatingTrigger<TData>, ISingleBaseBuiltinTriggerPrototype<TData>, ISingleBaseTriggerPrototype<TData>, ISingleBuiltinTriggerPrototype<TData>, ISingleTriggerPrototype<TData>, ISpecificTriggerListener<TData>, ITriggerHandler<Model>
All Known Implementing Classes:
APluginTriggerHandler, FcCatchErrorHandler, FcDoiVerifiedHandler, FcFormRecordMessagePostedHandler, FcFormRecordMessageUploadRequestFulfilledHandler, FcFormSubmitButtonHandler, FcInvitationErrorHandler, FcInvitationSentHandler, FcManualHandler, FcQualifiedFormSubmitButtonHandler, FcStateTimerHandler, FcTimePointHandler, FcUserInvocationHandler
public interface ITriggerDataDescriptor
Each trigger may provide a set of data that is made available via placeholders when the task is executed. This interface contains the descriptors that describe the type of data that is created in case the action succeeds and fails. This descriptor is used to show the user in the designer an overview of the available results.

You can create the descriptor on demand when the methods of this interface are called, but no guarantees are made as to whether or how much the descriptors get cached. The value descriptors created by the default ValueDescriptorFactory are immutable, so you may create them once and store them in a static field. Use ValueDescriptorFactory#getInstance() for creating the descriptors.

  • Method Details

    • getTriggerDataDescriptor

      IValueDescriptor<?, ? extends IValueBuilder<?>> getTriggerDataDescriptor(IValueDescriptorFactory factory)
      Creates the value descriptor for the data that is made available to the workflow when a task with this trigger starts.
      Parameters:
      factory - Factory that may be used for creating the descriptor. Instead of the factory passed in to this method, you may also use ValueDescriptorFactory.getInstance() if you wish to cache the descriptor in a static or instance field.
      Returns:
      The value descriptor for the data that is made available to the workflow when a task with this trigger is executed.
      See Also:

    • getTriggerFilesDescriptor

      default IFileValueDescriptor getTriggerFilesDescriptor()
      Creates the files descriptor for the files that are made available to the workflow when a task with this trigger starts.
      Returns:
      The files descriptor for the files that are made available to the workflow when a task with this trigger is executed.
      See Also: