Interface Rating

  • All Known Implementing Classes:
    RatingDTO

    public interface Rating
    Interface representing a Rating data transfer object.


    The methods of this class provide easy access to all rating related data which was returned by the remote service in JSON format. Please note that, as the remote service declares all of the properties to be optional, most of the methods are marked as Nullable. Methods returning collection-based values however will return an empty collection in case no corresponding data was received.


    The sole purpose of these DTO objects is to encapsulate the exact raw JSON data as received from the remote service in order to facilitate API integration by working with simple Java POJO's instead of nested JSON nodes. Although there will be no intense post-processing of the actual JSON values a type-casting may be applied to some of them to improve the usability and relieve the API user of this task.

    • Method Detail

      • getRating

        @Nullable
        Double getRating()
        Get the value of the {data.rating} JSON property
        Returns:
        The rating property from the received JSON
      • getRatingItemId

        @Nullable
        Long getRatingItemId()
        Get the value of the {data.ratingItemId} JSON property
        Returns:
        The ratingItemId property from the received JSON
      • getRatingType

        @Nullable
        String getRatingType()
        Get the value of the {data.ratingType} JSON property
        Returns:
        The ratingType property from the received JSON