Interface ClassPropertyValuesProvider


  • @Role
    public interface ClassPropertyValuesProvider
    Provides values for a class property.
    Since:
    9.8RC1
    Version:
    $Id: 2fe654bf1b3f9b93dede63511e0b0cb8868954f4 $
    • 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 for
        limit - the maximum number of values to return
        filterParameters - 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 a PropertyValue of the specified class property.
        Parameters:
        propertyReference - the property to provide the value for
        rawValue - 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