railo-context.Componentcontentbox.model.search.SearchResults
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 |
---|
Property Detail |
---|
Mark if the search results produce an error or not
required
- falseserializable
- trueAn array of error messagse if any
required
- falseserializable
- trueAny metadata structure you wish to store
required
- falseserializable
- trueThe search results in query or array or whatever format
required
- falseserializable
- trueThe search term used
required
- falseserializable
- trueThe amount of time it took for the search in milliseconds
required
- falseserializable
- trueThe total number of records found
required
- falseserializable
- trueMethod Detail |
---|
get: Mark if the search results produce an error or not
get: An array of error messagse if any
get: Any metadata structure you wish to store
get: The search results in query or array or whatever format
get: The search term used
get: The amount of time it took for the search in milliseconds
get: The total number of records found
memento
set: Mark if the search results produce an error or not
error
set: An array of error messagse if any
errorMessages
set: Any metadata structure you wish to store
metadata
set: The search results in query or array or whatever format
results
set: The search term used
searchTerm
set: The amount of time it took for the search in milliseconds
searchTime
set: The total number of records found
total