Package org.xwiki.model.validation.edit

Class EditConfirmationScriptService

java.lang.Object

org.xwiki.model.validation.edit.EditConfirmationScriptService

All Implemented Interfaces:

org.xwiki.script.service.ScriptService

@Component
@Singleton
@Named("modelvalidation.edit")
@Unstable
public class EditConfirmationScriptService
extends Object
implements org.xwiki.script.service.ScriptService

This class provides the script services for handling document edit confirmation.

Since:

15.9RC1

Version:

$Id: 79da79d03646d19fcffe016466aac083d0339251 $

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ID	This component hint.

Constructor Summary

Constructors

Constructor	Description
EditConfirmationScriptService()

Method Summary

Modifier and Type	Method	Description
EditConfirmationCheckerResults	check()	Performs a check by invoking the check method of all available EditConfirmationChecker components and aggregating their results.
void	force()	Force the last EditConfirmationChecker components checks.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ID

public static final String ID

This component hint.

See Also:

• Constant Field Values

Constructor Details

EditConfirmationScriptService

public EditConfirmationScriptService()

Method Details

check

public EditConfirmationCheckerResults check()

Performs a check by invoking the check method of all available EditConfirmationChecker components and aggregating their results.

Returns:

a EditConfirmationCheckerResults object containing the results of the check

force

@Unstable
public void force()

Force the last EditConfirmationChecker components checks. The results of the last call to check() are persisted, and new checks are skipped as long as they match the persisted results.

Since:

15.10RC1