Class: Scrivito::ObjFacetValue

Inherits:
Object
  • Object
show all
Defined in:
lib/scrivito/obj_facet_value.rb

Overview

Instances of this class represent the result of a faceted search.

Instance Method Summary collapse

Instance Method Details

#count ⇒ Integer

Total number of Objs available that have this value.

Note that this refers to all Objs, not just the Objs included in this search. Also note that the count is approximate.

Returns:

  • (Integer) 


35
36
37
 
# File 'lib/scrivito/obj_facet_value.rb', line 35

def count
  @count
end

#included_objs ⇒ Array<BasicObj>

The Objs that were included in this search.

If you did not specify include_objs in your facet options, an empty array is returned. The Objs are ordered by relevance.

Returns:



50
51
52
 
# File 'lib/scrivito/obj_facet_value.rb', line 50

def included_objs
  @included_objs
end

#name ⇒ String

The value of the attribute name of this ObjFacetValue.

Returns:

  • (String) 


21
22
23
 
# File 'lib/scrivito/obj_facet_value.rb', line 21

def name
  @name
end