class Eaternet::Lives_1_0::Legend

Legends are mappings from score ranges to human-readable descriptions of those scores. Municipalities can use these to communicate the way scores are traditionally presented. For example, 0-60 may map to ‘Fail’ or 95-100 may map to ‘A+’. The provided ranges in {#minimum_score} and {#maximum_score} must cover the entire 0-100 span without overlap. For scores at the edge of two ranges, the greater range will be used. For example, if 80-90 is a ‘B’ and 90-100 is an ‘A’, a score of 90 would be an ‘A’. These are optional.

@see www.yelp.com/healthscores#legend LIVES / Legend specification

Attributes

description[RW]

Formatted version of the score in the format typically presented by the municipality. For example ‘A’ or ‘Pass’.

@required Yes @return [String]

maximum_score[RW]

Maximum score that can be classified with this description.

@required Yes @return [Integer]

minimum_score[RW]

Minimum score that can be classified with this description.

@required Yes @return [Integer]