...
Code Block | ||
---|---|---|
| ||
public interface WorkflowActionConstraint { /** * Returns the domain prefixes for which the workflow action constraint is scoped to. Domain prefixes must * correspond with the available concrete implementations of the {@link ContentDomain} interface, though * limited to those whose's default domain type is an instance of {@link WorkflowEnabled}. * <p> * Allowed standard domain prefixes: * <ul> * <li>pageversion</li> * <li>pagesectionversion</li> * <li>articleversion</li> * <li>downloadversion</li> * <li>flashversion</li> * <li>imageversion</li> * <li>multimediaversion</li> * </ul> * Note that the domain prefix <code>mediapageversion</code> which corresponds to the content domain * representing {@link MediaItemPageVersion} is NOT allowed. A media item page version is a media item * which references a page version, and in context of its workflow it should be seen as a page version. * * @return Array of domain prefixes. An empty array represents that the constraint is designed for all * known workflow enabled content domains. Must not return <code>null</code>. */ String[] getDomainPrefixes(); /** * Returns the per locale title of the workflow action constraint. * * @return The title of the workflow action constraint. */ Map<Locale, String> getTitleMessages(); /** * Returns the identifier of the workflow action constraint. MustThis must be unique among other workflow action * constraints available in the system. If not it will be denied (as logged) and therefore unavailable. * * @return The identifier of the workflow action constraint. */ String getIdentifier(); /** * Validates the workflow action constraint. * * @param webEnabled A workflowEnabled object that is the subject of the workflow action. * @return A {@link WorkflowActionResult} that contains the validation status (true/false) and info * messages. */ WorkflowActionConstraintResult validate(WorkflowEnabled workflowEnabled); } |
...