ContentBox Core API 1.6.0

contentbox.model.search
Class SearchResults

WEB-INF.cftags.component
        extended by contentbox.model.search.SearchResults

public class SearchResults
extends WEB-INF.cftags.component

******************************************************************************* ContentBox - A Modular Content Platform Copyright 2012 by Luis Majano and Ortus Solutions, Corp www.gocontentbox.org | www.luismajano.com | 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 & Description Default Serializable Required
 boolean error
          Mark if the search results produce an error or not

Attributes:
true false
 array errorMessages
          An array of error messagse if any

Attributes:
true false
 struct metadata
          Any metadata structure you wish to store

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

Attributes:
true false
 string searchTerm
          The search term used

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

Attributes:
true false
 numeric total
          The total number of records found

Attributes:
true false
 
Constructor Summary
init()
 
Method Summary
 boolean GETERROR()
          get: Mark if the search results produce an error or not
 array GETERRORMESSAGES()
          get: An array of error messagse if any
 struct GETMETADATA()
          get: Any metadata structure you wish to store
 any GETRESULTS()
          get: The search results in query or array or whatever format
 string GETSEARCHTERM()
          get: The search term used
 numeric GETSEARCHTIME()
          get: The amount of time it took for the search in milliseconds
 numeric GETTOTAL()
          get: The total number of records found
 SearchResults SETERROR(boolean error)
          set: Mark if the search results produce an error or not
 SearchResults SETERRORMESSAGES(array errorMessages)
          set: An array of error messagse if any
 SearchResults SETMETADATA(struct metadata)
          set: Any metadata structure you wish to store
 SearchResults SETRESULTS(any results)
          set: The search results in query or array or whatever format
 SearchResults SETSEARCHTERM(string searchTerm)
          set: The search term used
 SearchResults SETSEARCHTIME(numeric searchTime)
          set: The amount of time it took for the search in milliseconds
 SearchResults SETTOTAL(numeric total)
          set: The total number of records found
 struct getMemento()
 SearchResults populate(struct memento)
 
Methods inherited from class WEB-INF.cftags.component
None
 

Constructor Detail

init

public init()

Property Detail

error

boolean error
Mark if the search results produce an error or not

Attributes:
default -
serializable - true
required - false

errorMessages

array errorMessages
An array of error messagse if any

Attributes:
default -
serializable - true
required - false

metadata

struct metadata
Any metadata structure you wish to store

Attributes:
default -
serializable - true
required - false

results

any results
The search results in query or array or whatever format

Attributes:
default -
serializable - true
required - false

searchTerm

string searchTerm
The search term used

Attributes:
default -
serializable - true
required - false

searchTime

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

Attributes:
default -
serializable - true
required - false

total

numeric total
The total number of records found

Attributes:
default -
serializable - true
required - false

Method Detail

GETERROR

public boolean GETERROR()
get: Mark if the search results produce an error or not


GETERRORMESSAGES

public array GETERRORMESSAGES()
get: An array of error messagse if any


GETMETADATA

public struct GETMETADATA()
get: Any metadata structure you wish to store


GETRESULTS

public any GETRESULTS()
get: The search results in query or array or whatever format


GETSEARCHTERM

public string GETSEARCHTERM()
get: The search term used


GETSEARCHTIME

public numeric GETSEARCHTIME()
get: The amount of time it took for the search in milliseconds


GETTOTAL

public numeric GETTOTAL()
get: The total number of records found


SETERROR

public SearchResults SETERROR(boolean error)
set: Mark if the search results produce an error or not

Parameters:
error

SETERRORMESSAGES

public SearchResults SETERRORMESSAGES(array errorMessages)
set: An array of error messagse if any

Parameters:
errorMessages

SETMETADATA

public SearchResults SETMETADATA(struct metadata)
set: Any metadata structure you wish to store

Parameters:
metadata

SETRESULTS

public SearchResults SETRESULTS(any results)
set: The search results in query or array or whatever format

Parameters:
results

SETSEARCHTERM

public SearchResults SETSEARCHTERM(string searchTerm)
set: The search term used

Parameters:
searchTerm

SETSEARCHTIME

public SearchResults SETSEARCHTIME(numeric searchTime)
set: The amount of time it took for the search in milliseconds

Parameters:
searchTime

SETTOTAL

public SearchResults SETTOTAL(numeric total)
set: The total number of records found

Parameters:
total

getMemento

public struct getMemento()


populate

public SearchResults populate(struct memento)

Parameters:
memento

ContentBox Core API 1.6.0