Package org.ametys.plugins.workflow

Interface EnhancedFunction

All Superinterfaces:

com.opensymphony.workflow.FunctionProvider

All Known Implementing Classes:

AbstractContentFunction, AbstractCoursePartFunction, AbstractCreateODFContentByCopyFunction, AbstractCreateODFContentFunction, AbstractCreateODFProgramItemFunction, AbstractCreateProgramItemByCopyFunction, ActiveEntryFunction, AddEventFunction, CheckDuplicateContentsFunction, CommentStepFunction, CreateContainerByCopyFunction, CreateContainerFunction, CreateContentByCopyFunction, CreateContentByCopyFunction, CreateContentFunction, CreateContentFunction, CreateCourseByCopyFunction, CreateCourseFunction, CreateCourseListByCopyFunction, CreateCourseListFunction, CreateCoursePartByCopyFunction, CreateCoursePartFunction, CreateExtractionDescriptionFunction, CreateNewsletterFunction, CreateOrgUnitByCopyFunction, CreateOrgUnitFunction, CreatePersonByCopyFunction, CreatePersonFunction, CreateProgramByCopyFunction, CreateProgramFunction, CreateReferenceTableContentFunction, CreateSubProgramByCopyFunction, CreateSubProgramFunction, CreateSynchronizedContentFunction, CreateSynchronizedUserDirectoryContentFunction, CreateSynchronizedVersionFunction, CreateVersionFunction, DeactiveEntryFunction, DeleteContentFunction, DeleteRemoteProgramFunction, DepositCDMFRFunction, EditContentFunction, EditEventFunction, EditSynchronizedContentFunction, ExtensibleFunction, ExtractOutgoingReferencesFunction, FormEditionFunction, InitContentFunction, MarkContentArchivedFunction, MoveLiveTagOnCoursePartFunction, NotifyCopyFunction, RemoveLiveLabelFunction, RemoveLiveLabelFunction, ResetWorkflowIdFunction, RestoreRevisionFunction, SendCDMFRFunction, SendMailFunction, SendMailFunction, SendMailFunction, SendMailFunction, SendMailToCreatorFunction, SendMailToPersonInChargeFunction, SendMailToUserFunction, SendMailToUserFunction, SendMailToUserFunction, SendNewsletterFunction, SetCurrentStepIdAndNotifyFunction, SetNotifiedFunction, SetProposalDateContentFunction, UnpublishCoursePartFunction, ValidateContentFunction, ValidateSynchronizedContentFunction, ValidationStepFunction

public interface EnhancedFunction
extends com.opensymphony.workflow.FunctionProvider

Interface for adding description and arguments to FunctionProvider

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	EnhancedFunction.FunctionArgument	Record of the function argument

Method Summary

Modifier and Type	Method	Description
default List<EnhancedFunction.FunctionArgument>	getArguments()	Get the list of accepted arguments for this function
default I18nizableText	getDescription(Map<String,String> argumentsValues)	Get the function descriptions depending on arguments values

Methods inherited from interface com.opensymphony.workflow.FunctionProvider

execute

Method Details

getArguments

default List<EnhancedFunction.FunctionArgument> getArguments()

Get the list of accepted arguments for this function

Returns:

a List of argument names and associated description

getDescription

default I18nizableText getDescription(Map<String,String> argumentsValues)

Get the function descriptions depending on arguments values

Parameters:

argumentsValues - a map of the arguments with their values in current workflow

Returns:

a description to display in workflow editor vue