Index

A C E F G H I M O R T U 
All Classes and Interfaces|All Packages|Constant Field Values

A

AbstractEntityNameValidation - Class in org.xwiki.model.validation
Define generic methods for transforming or validating entities based on the implementation of the EntityNameValidation.transform(String) and EntityNameValidation.isValid(String).
AbstractEntityNameValidation() - Constructor for class org.xwiki.model.validation.AbstractEntityNameValidation
 
append(EditConfirmationCheckerResult) - Method in class org.xwiki.model.validation.edit.EditConfirmationCheckerResults
Appends the check result to the existing list of messages.

C

check() - Method in interface org.xwiki.model.validation.edit.EditConfirmationChecker
Checks if edit confirmation is required, or allowed, based on the provided boolean value.
check() - Method in class org.xwiki.model.validation.edit.EditConfirmationScriptService
Performs a check by invoking the check method of all available EditConfirmationChecker components and aggregating their results.

E

EditConfirmationChecker - Interface in org.xwiki.model.validation.edit
Provides the operation that a pre-edit checker must provide.
EditConfirmationCheckerResult - Class in org.xwiki.model.validation.edit
The result of a EditConfirmationChecker.
EditConfirmationCheckerResult(Block, boolean) - Constructor for class org.xwiki.model.validation.edit.EditConfirmationCheckerResult
Constructs a new object with the specified message and error status.
EditConfirmationCheckerResult(Block, boolean, Serializable) - Constructor for class org.xwiki.model.validation.edit.EditConfirmationCheckerResult
Constructs a new object with the specified message, an error status, and a cache result object.
EditConfirmationCheckerResults - Class in org.xwiki.model.validation.edit
Represents the aggregated result of a check operation.
EditConfirmationCheckerResults() - Constructor for class org.xwiki.model.validation.edit.EditConfirmationCheckerResults
 
EditConfirmationScriptService - Class in org.xwiki.model.validation.edit
This class provides the script services for handling document edit confirmation.
EditConfirmationScriptService() - Constructor for class org.xwiki.model.validation.edit.EditConfirmationScriptService
 
EntityNameValidation - Interface in org.xwiki.model.validation
Define a strategy to validate or transform an entity reference.
EntityNameValidationConfiguration - Interface in org.xwiki.model.validation
Define the configuration of the name strategy to be used.
EntityNameValidationManager - Interface in org.xwiki.model.validation
Manage the available EntityNameValidation components.
equals(Object) - Method in class org.xwiki.model.validation.edit.EditConfirmationCheckerResult
 
equals(Object) - Method in class org.xwiki.model.validation.edit.EditConfirmationCheckerResults
 

F

force() - Method in class org.xwiki.model.validation.edit.EditConfirmationScriptService
Force the last EditConfirmationChecker components checks.

G

get(String) - Method in class org.xwiki.model.validation.script.ModelValidationScriptService
 
getAvailableEntityNameValidations() - Method in interface org.xwiki.model.validation.EntityNameValidationManager
 
getConfiguration() - Method in class org.xwiki.model.validation.script.ModelValidationScriptService
Return the name strategy configuration if the user has programming rights only.
getEntityNameValidation() - Method in interface org.xwiki.model.validation.EntityNameValidationConfiguration
 
getEntityReferenceNameStrategy() - Method in interface org.xwiki.model.validation.EntityNameValidationManager
 
getEntityReferenceNameStrategy(String) - Method in interface org.xwiki.model.validation.EntityNameValidationManager
 
getErrorMessages() - Method in class org.xwiki.model.validation.edit.EditConfirmationCheckerResults
 
getManager() - Method in class org.xwiki.model.validation.script.ModelValidationScriptService
Return the name strategy manager if the user has programming rights only.
getMessage() - Method in class org.xwiki.model.validation.edit.EditConfirmationCheckerResult
Returns the message associated with this result.
getReplaceCharacterEntityNameValidationConfiguration() - Method in class org.xwiki.model.validation.script.ModelValidationScriptService
 
getSkipValue() - Method in class org.xwiki.model.validation.edit.EditConfirmationCheckerResult
The value used to check if a result can be skipped.
getWarningMessages() - Method in class org.xwiki.model.validation.edit.EditConfirmationCheckerResults
 

H

hashCode() - Method in class org.xwiki.model.validation.edit.EditConfirmationCheckerResult
 
hashCode() - Method in class org.xwiki.model.validation.edit.EditConfirmationCheckerResults
 

I

ID - Static variable in class org.xwiki.model.validation.edit.EditConfirmationScriptService
This component hint.
ID - Static variable in class org.xwiki.model.validation.script.ModelValidationScriptService
The id of this script service.
isError() - Method in class org.xwiki.model.validation.edit.EditConfirmationCheckerResult
Checks if the result is an error.
isError() - Method in class org.xwiki.model.validation.edit.EditConfirmationCheckerResults
Checks if an error has occurred.
isValid(String) - Method in interface org.xwiki.model.validation.EntityNameValidation
Validate a name against a set of rules: usually a pattern is used to validate a name.
isValid(String) - Method in class org.xwiki.model.validation.script.ModelValidationScriptService
Validate a name according to the current name strategy, only if the configuration is set to use validation.
isValid(String, String) - Method in class org.xwiki.model.validation.script.ModelValidationScriptService
Validate a name according to the given name strategy.
isValid(EntityReference) - Method in class org.xwiki.model.validation.AbstractEntityNameValidation
 
isValid(EntityReference) - Method in interface org.xwiki.model.validation.EntityNameValidation
Validate that the given EntityReference respects the current policy.
isValid(EntityReference) - Method in class org.xwiki.model.validation.script.ModelValidationScriptService
Validate a source entity according to the current name strategy, only if the configuration is set to use validation.
isValid(EntityReference, String) - Method in class org.xwiki.model.validation.script.ModelValidationScriptService
Validate a source entity according to the given name strategy.

M

ModelValidationScriptService - Class in org.xwiki.model.validation.script
Script service for name strategies.
ModelValidationScriptService() - Constructor for class org.xwiki.model.validation.script.ModelValidationScriptService
 

O

org.xwiki.model.validation - package org.xwiki.model.validation
 
org.xwiki.model.validation.edit - package org.xwiki.model.validation.edit
 
org.xwiki.model.validation.script - package org.xwiki.model.validation.script
 

R

resetStrategies() - Method in interface org.xwiki.model.validation.EntityNameValidationManager
Allow to reset the configuration of the strategies.

T

toString() - Method in class org.xwiki.model.validation.edit.EditConfirmationCheckerResult
 
toString() - Method in class org.xwiki.model.validation.edit.EditConfirmationCheckerResults
 
transform(String) - Method in interface org.xwiki.model.validation.EntityNameValidation
Transforms a name such as EntityNameValidation.isValid(String) return true.
transform(EntityReference) - Method in class org.xwiki.model.validation.AbstractEntityNameValidation
 
transform(EntityReference) - Method in interface org.xwiki.model.validation.EntityNameValidation
Aims at transforming an entity reference such as EntityNameValidation.isValid(EntityReference) returns true.
transformEntityReference(EntityReference) - Method in class org.xwiki.model.validation.script.ModelValidationScriptService
Transform an entity reference according to the current name strategy if the configuration is set to use transformation.
transformEntityReference(EntityReference, String) - Method in class org.xwiki.model.validation.script.ModelValidationScriptService
Transform a source entity according to the given name strategy.
transformName(String) - Method in class org.xwiki.model.validation.script.ModelValidationScriptService
Transform a name according to the current name strategy, if the configuration is set to use transformation.
transformName(String, String) - Method in class org.xwiki.model.validation.script.ModelValidationScriptService
Transform a name according to the given name strategy.

U

useTransformation() - Method in interface org.xwiki.model.validation.EntityNameValidationConfiguration
 
useValidation() - Method in interface org.xwiki.model.validation.EntityNameValidationConfiguration
 
A C E F G H I M O R T U 
All Classes and Interfaces|All Packages|Constant Field Values