Package org.ametys.plugins.workflow

Interface EnhancedFunction

All Superinterfaces:

com.opensymphony.workflow.FunctionProvider

All Known Implementing Classes:

AbstractCodeEditionFunction, AbstractContentFunction, AbstractCoursePartFunction, AbstractCreateODFContentByCopyFunction, AbstractCreateODFContentFunction, AbstractCreateODFProgramItemFunction, AbstractCreateProgramItemByCopyFunction, ActiveEntryFunction, AddEventFunction, CheckDuplicateContentsFunction, CommentStepFunction, ContainerThematicCodeEditionFunction, 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, DeleteRemoteProgramFunction, EditContentFunction, EditContextualizedDataFunction, EditEventFunction, EditSynchronizedContentFunction, ExtensibleFunction, ExtractOutgoingReferencesFunction, FormEditionFunction, FormSendMailFunction, InitContentFunction, MarkContentArchivedFunction, MoveLiveTagOnCoursePartFunction, NotifyCopyFunction, NotifyFunction, RemoveLiveLabelFunction, RemoveLiveLabelFunction, ResetWorkflowIdFunction, RestoreContentAttachmentsFunction, RestoreRevisionFunction, SendMailFunction, SendMailFunction, SendMailFunction, SendMailFunction, SendMailToCreatorFunction, SendMailToPersonInChargeFunction, SendMailToUserFunction, SendMailToUserFunction, SendMailToUserFunction, SendNewsletterFunction, SetCurrentStepIdAndNotifyFunction, SetNotifiedFunction, SetProposalDateContentFunction, SkillEditionFunction, ThematicCodeEditionFunction, TranslationAlertFunction, UnlockContentFunction, UnpublishCoursePartFunction, ValidateContentFunction, ValidateSynchronizedContentFunction, ValidationStepFunction, WorkflowFormSendMailFunction, WorkflowFormSendMailWithCommentFunction

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 enum	EnhancedFunction.FunctionType	The order of execution for the function

Method Summary

Modifier and Type	Method	Description
default List<WorkflowArgument>	getArguments()	Get the list of accepted arguments for this function
default I18nizableText	getFullLabel(Map<String,String> argumentsValues)	Get the function label depending on arguments values
default EnhancedFunction.FunctionType	getFunctionExecType()	Return the type for the function
I18nizableText	getLabel()	Get the label for this function
default List<WorkflowHelper.WorkflowVisibility>	getVisibilities()	Get the function's visibilities depending on rights

Methods inherited from interface com.opensymphony.workflow.FunctionProvider

execute

Method Details

getArguments

default List<WorkflowArgument> getArguments()

Get the list of accepted arguments for this function

Returns:

a List of argument names and associated description

getLabel

I18nizableText getLabel()

Get the label for this function

Returns:

the label

getFullLabel

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

Get the function label depending on arguments values

Parameters:

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

Returns:

a label to display in workflow editor vue

getFunctionExecType

default EnhancedFunction.FunctionType getFunctionExecType()

Return the type for the function

Returns:

the type 's code

getVisibilities

default List<WorkflowHelper.WorkflowVisibility> getVisibilities()

Get the function's visibilities depending on rights

Returns:

a list of all the allowed right profiles