contentbox.models.search

Class SearchResults

lucee.Component
    extended by contentbox.models.search.SearchResults

ContentBox - A Modular Content Platform Copyright since 2012 by Ortus Solutions, Corp www.ortussolutions.com/products/contentbox --- The official ContentBox Search Results Object

Class Attributes:
  • synchronized : false
    •  
  • accessors : true
    •  
  • persistent : false
    •  
    Property Summary
    type property default serializable required
    boolean error
          Mark if the search results produce an error or not.

    • access = public
    • returntype = any
    		 true false
    array errorMessages
          An array of error messagse if any.

    • access = public
    • returntype = any
    		 true false
    struct metadata
          Any metadata structure you wish to store.

    • access = public
    • returntype = any
    		 true false
    any results
          The search results in query or array or whatever format.

    • access = public
    • returntype = any
    		 true false
    string searchTerm
          The search term used.

    • access = public
    • returntype = any
    		 true false
    numeric searchTime
          The amount of time it took for the search in milliseconds.

    • access = public
    • returntype = any
    		 true false
    numeric total
          The total number of records found.

    • access = public
    • returntype = any
    		 true false
    Constructor Summary
    init()
          Constructor.
    Method Summary
    string getError()
    string getErrorMessages()
    struct getMemento()
         Get the search memento.
    string getMetadata()
    string getResults()
    string getSearchTerm()
    string getSearchTime()
    string getTotal()
    any populate(struct memento)
         Populate a memento.
    any setError(boolean error)
    any setErrorMessages(array errorMessages)
    any setMetadata(struct metadata)
    any setResults(any results)
    any setSearchTerm(string searchTerm)
    any setSearchTime(numeric searchTime)
    any setTotal(numeric total)
     
    Methods inherited from class lucee.Component
    None
    Constructor Detail

    init

    public init()

    Constructor

    Property Detail

    error

    property boolean error

    Mark if the search results produce an error or not

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    errorMessages

    property array errorMessages

    An array of error messagse if any

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    metadata

    property struct metadata

    Any metadata structure you wish to store

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    results

    property any results

    The search results in query or array or whatever format

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    searchTerm

    property string searchTerm

    The search term used

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    searchTime

    property numeric searchTime

    The amount of time it took for the search in milliseconds

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    total

    property numeric total

    The total number of records found

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true
    Method Detail

    getError

    public string getError()

    getErrorMessages

    public string getErrorMessages()

    getMemento

    public struct getMemento()

    Get the search memento

    getMetadata

    public string getMetadata()

    getResults

    public string getResults()

    getSearchTerm

    public string getSearchTerm()

    getSearchTime

    public string getSearchTime()

    getTotal

    public string getTotal()

    populate

    public any populate(struct memento)

    Populate a memento

    Parameters:
    memento
    Returns:
    SearchResults

    setError

    public any setError(boolean error)

    Parameters:
    error

    setErrorMessages

    public any setErrorMessages(array errorMessages)

    Parameters:
    errorMessages

    setMetadata

    public any setMetadata(struct metadata)

    Parameters:
    metadata

    setResults

    public any setResults(any results)

    Parameters:
    results

    setSearchTerm

    public any setSearchTerm(string searchTerm)

    Parameters:
    searchTerm

    setSearchTime

    public any setSearchTime(numeric searchTime)

    Parameters:
    searchTime

    setTotal

    public any setTotal(numeric total)

    Parameters:
    total