Package org.xwiki.rest.resources.classes
Interface ClassPropertyValuesProvider
-
@Role public interface ClassPropertyValuesProvider
Provides values for a class property.- Since:
- 9.8RC1
- Version:
- $Id: 2fe654bf1b3f9b93dede63511e0b0cb8868954f4 $
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default PropertyValue
getValue(ClassPropertyReference propertyReference, Object rawValue)
Resolves the given raw value into aPropertyValue
of the specified class property.PropertyValues
getValues(ClassPropertyReference propertyReference, int limit, Object... filterParameters)
Provides values for a class property.
-
-
-
Method Detail
-
getValues
PropertyValues getValues(ClassPropertyReference propertyReference, int limit, Object... filterParameters) throws XWikiRestException
Provides values for a class property.- Parameters:
propertyReference
- the property to provide the values forlimit
- the maximum number of values to returnfilterParameters
- additional parameters used to filter the values- Returns:
- the values for the specified property
- Throws:
XWikiRestException
- if retrieving the property values fails
-
getValue
default PropertyValue getValue(ClassPropertyReference propertyReference, Object rawValue) throws XWikiRestException
Resolves the given raw value into aPropertyValue
of the specified class property.- Parameters:
propertyReference
- the property to provide the value forrawValue
- raw value used to resolve the property value- Returns:
- the property value based on the raw value or null if the raw value is empty
- Throws:
XWikiRestException
- if retrieving the property value fails- Since:
- 10.9
-
-