contentbox.model.search

Class SearchResults

railo-context.Component
        extended by contentbox.model.search.SearchResults
Class Attributes:
  • synchronized : false
  •  
  • accessors : true
  •  
  • persistent : false
  •  

    ContentBox - A Modular Content Platform Copyright 2012 by Luis Majano and Ortus Solutions, Corp www.ortussolutions.com Apache License, Version 2.0 Copyright Since [2012] [Luis Majano and Ortus Solutions,Corp] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. The official ContentBox Search Results Object

    Property Summary
    type property default serializable required
    boolean error
          Mark if the search results produce an error or not.

    true false
    array errorMessages
          An array of error messagse if any.

    true false
    struct metadata
          Any metadata structure you wish to store.

    true false
    any results
          The search results in query or array or whatever format.

    true false
    string searchTerm
          The search term used.

    true false
    numeric searchTime
          The amount of time it took for the search in milliseconds.

    true false
    numeric total
          The total number of records found.

    true false
    Constructor Summary
    init()
    Method Summary
    string getError()
         get: Mark if the search results produce an error or not.
    string getErrorMessages()
         get: An array of error messagse if any.
    struct getMemento()
    string getMetadata()
         get: Any metadata structure you wish to store.
    string getResults()
         get: The search results in query or array or whatever format.
    string getSearchTerm()
         get: The search term used.
    string getSearchTime()
         get: The amount of time it took for the search in milliseconds.
    string getTotal()
         get: The total number of records found.
    SearchResults populate(struct memento)
    any setError(boolean error)
         set: Mark if the search results produce an error or not.
    any setErrorMessages(array errorMessages)
         set: An array of error messagse if any.
    any setMetadata(struct metadata)
         set: Any metadata structure you wish to store.
    any setResults(any results)
         set: The search results in query or array or whatever format.
    any setSearchTerm(string searchTerm)
         set: The search term used.
    any setSearchTime(numeric searchTime)
         set: The amount of time it took for the search in milliseconds.
    any setTotal(numeric total)
         set: The total number of records found.
     
    Methods inherited from class railo-context.Component
    None

    Constructor Detail

    init

    public init()


    Property Detail

    error

    property boolean error

    Mark if the search results produce an error or not

    Attributes:
    required - false
    serializable - true

    errorMessages

    property array errorMessages

    An array of error messagse if any

    Attributes:
    required - false
    serializable - true

    metadata

    property struct metadata

    Any metadata structure you wish to store

    Attributes:
    required - false
    serializable - true

    results

    property any results

    The search results in query or array or whatever format

    Attributes:
    required - false
    serializable - true

    searchTerm

    property string searchTerm

    The search term used

    Attributes:
    required - false
    serializable - true

    searchTime

    property numeric searchTime

    The amount of time it took for the search in milliseconds

    Attributes:
    required - false
    serializable - true

    total

    property numeric total

    The total number of records found

    Attributes:
    required - false
    serializable - true

    Method Detail

    getError

    public string getError()

    get: Mark if the search results produce an error or not


    getErrorMessages

    public string getErrorMessages()

    get: An array of error messagse if any


    getMemento

    public struct getMemento()


    getMetadata

    public string getMetadata()

    get: Any metadata structure you wish to store


    getResults

    public string getResults()

    get: The search results in query or array or whatever format


    getSearchTerm

    public string getSearchTerm()

    get: The search term used


    getSearchTime

    public string getSearchTime()

    get: The amount of time it took for the search in milliseconds


    getTotal

    public string getTotal()

    get: The total number of records found


    populate

    public SearchResults populate(struct memento)

    Parameters:
    memento

    setError

    public any setError(boolean error)

    set: Mark if the search results produce an error or not

    Parameters:
    error

    setErrorMessages

    public any setErrorMessages(array errorMessages)

    set: An array of error messagse if any

    Parameters:
    errorMessages

    setMetadata

    public any setMetadata(struct metadata)

    set: Any metadata structure you wish to store

    Parameters:
    metadata

    setResults

    public any setResults(any results)

    set: The search results in query or array or whatever format

    Parameters:
    results

    setSearchTerm

    public any setSearchTerm(string searchTerm)

    set: The search term used

    Parameters:
    searchTerm

    setSearchTime

    public any setSearchTime(numeric searchTime)

    set: The amount of time it took for the search in milliseconds

    Parameters:
    searchTime

    setTotal

    public any setTotal(numeric total)

    set: The total number of records found

    Parameters:
    total