beanFeed

Class beanFeed

lucee.Component
    mura.cfobject
      mura.bean.bean
        mura.bean.beanFeed

Direct Known Subclasses:

categoryFeedBean , contentCommentFeedBean , feedBean , userFeedBean

This is provides base feed functionality for all entities

Class Attributes:

output : false

synchronized : false

accessors : false

persistent : false

Property Summary
type	property	default	serializable	required
`string`	additionalColumns access = public returntype = any		`true`	`false`
`string`	entityName access = public returntype = any		`true`	`false`
`string`	keyField access = public returntype = any		`true`	`false`
`numeric`	maxItems access = public returntype = any	`0`	`true`	`yes`
`numeric`	nextN access = public returntype = any	`0`	`true`	`yes`
`string`	orderby access = public returntype = any		`true`	`false`
`numeric`	pageIndex access = public returntype = any	`1`	`true`	`false`
`string`	siteID access = public returntype = any		`true`	`false`
`string`	sortBy access = public returntype = any		`true`	`false`
`string`	sortDirection access = public returntype = any	`asc`	`true`	`yes`
`string`	sortTable access = public returntype = any		`true`	`false`
`string`	table access = public returntype = any		`true`	`false`

Constructor Summary
init()

Method Summary
`any`	addAdvancedParam(string field='', string relationship='and', string criteria='', string condition='EQUALS', string datatype='')
`any`	addJoin(string joinType='inner', string table='', string clause='')
`any`	addParam(string field='', string relationship='and', string criteria='', string condition='EQUALS', string datatype='')
`any`	andProp([any property])
`any`	beginsWith([any criteria])
`private any`	caseInsensitiveOrderBy(any orderBy)
`any`	clearAdvancedParams()
`any`	clearJoins()
`any`	clearParams()
`any`	clone()
`any`	closeGrouping()
`any`	contains([any criteria])
`any`	containsValue([any criteria])
`any`	endsWith([any criteria])
`any`	formatField([any field])
`any`	getAdvancedParams()
`any`	getAvailableCount()
`any`	getCustomDatasource()
`any`	getDbType()
`any`	getDiscriminatorColumn()
`any`	getDiscriminatorValue()
`any`	getEntity()
`any`	getEntityName()
`any`	getIsHistorical()
`any`	getItemsPerPage()
`any`	getIterator([any cachedWithin='[runtime expression]'])
`any`	getJoins()
`any`	getOrderBy()
`any`	getParams()
`any`	getQuery([any countOnly='false'], [any cachedWithin='[runtime expression]'])
`any`	getQueryAttrs([any cachedWithin='[runtime expression]'])
`any`	getQueryService([any cachedWithin='[runtime expression]'])
`any`	getSort()
`any`	getTableFieldList()
`any`	hasColumn([any column])
`any`	hasCustomDatasource()
`any`	hasDiscriminatorColumn()
`any`	hasJoin([any table])
`any`	innerJoin([any relatedEntity])
`any`	isEQ([any criteria])
`any`	isGT([any criteria])
`any`	isGTE([any criteria])
`any`	isIn([any criteria])
`any`	isLT([any criteria])
`any`	isLTE([any criteria])
`any`	isNEQ([any criteria])
`any`	isNotIn([any criteria])
`any`	itemsPerPage([any itemsPerPage])
`any`	leftJoin([any entityName])
`any`	loadTableMetaData()
`any`	maxItems([any maxItems])
`any`	null()
`any`	openGrouping()
`any`	orOpenGrouping()
`any`	orProp([any property])
`any`	prop([any property])
`any`	setAdvancedParams(any params)
`any`	setConfigBean([any configBean])
`any`	setEntityName([any entityName])
`any`	setItemsPerPage([any itemsPerPage])
`any`	setMaxItems([any maxItems])
`any`	setNextN([any NextN])
`any`	setOrderBy([any orderby])
`any`	setParams(any params)
`any`	setSort([any sort])
`any`	setSortDirection([any sortDirection])
`any`	sort([any property], [any direction='asc'])
`any`	where([any property])

Methods inherited from class `mura.bean.bean`
addObject, allowDelete, allowQueryParams, allowRead, allowSave, compare, exists, get, getAll, getAllValues, getErrors, getFeed, getHasManyPropArray, getHasOnePropArray, getInstanceName, getListView, getPrimaryKey, getProperties, getSynthedFunctions, getTable, getValidations, getValue, has, hasErrors, hasProperty, hasTable, isComparable, OnMissingMethod, parseDateArg, removeObject, set, setAddedObjectValues, setAllValues, setErrors, setlastUpdateBy, setPropAsIDColumn, setValidations, setValue, synthArgs, translatePropKey, validate, valueExists

Methods inherited from class mura.bean.bean

addObject, allowDelete, allowQueryParams, allowRead, allowSave, compare, exists, get, getAll, getAllValues, getErrors, getFeed, getHasManyPropArray, getHasOnePropArray, getInstanceName, getListView, getPrimaryKey, getProperties, getSynthedFunctions, getTable, getValidations, getValue, has, hasErrors, hasProperty, hasTable, isComparable, OnMissingMethod, parseDateArg, removeObject, set, setAddedObjectValues, setAllValues, setErrors, setlastUpdateBy, setPropAsIDColumn, setValidations, setValue, synthArgs, translatePropKey, validate, valueExists

Methods inherited from class `mura.cfobject`
commitTracePoint, convertTimezone, deleteMethod, getAsJSON, getAsStruct, getBean, getConfigBean, getCurrentUser, getEventManager, getHTTPAttrs, getHTTPService, getJavaTimezone, getPlugin, getPluginManager, getServiceFactory, getSession, initTracePoint, inject, injectMethod, invokeMethod, mixin, removeValue

Methods inherited from class `lucee.Component`
None

Constructor Detail

init

public init()

Property Detail

additionalColumns

property string additionalColumns

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

entityName

property string entityName

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

keyField

property string keyField

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

maxItems

property numeric maxItems = [0]

Attributes:: access - public; required - yes; returntype - any; serializable - true

nextN

property numeric nextN = [0]

Attributes:: access - public; required - yes; returntype - any; serializable - true

orderby

property string orderby

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

pageIndex

property numeric pageIndex = [1]

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

siteID

property string siteID

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

sortBy

property string sortBy

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

sortDirection

property string sortDirection = [asc]

Attributes:: access - public; required - yes; returntype - any; serializable - true

sortTable

property string sortTable

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

table

property string table

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

Method Detail

addAdvancedParam

public any addAdvancedParam(string field='', string relationship='and', string criteria='', string condition='EQUALS', string datatype='')

Parameters:: field; relationship; criteria; condition; datatype

addJoin

public any addJoin(string joinType='inner', string table='', string clause='')

Parameters:: joinType; table; clause

addParam

public any addParam(string field='', string relationship='and', string criteria='', string condition='EQUALS', string datatype='')

Parameters:: field - You can use 'Column' as an alias to field; relationship; criteria; condition; datatype

andProp

public any andProp([any property])

Parameters:: property

beginsWith

public any beginsWith([any criteria])

Parameters:: criteria

caseInsensitiveOrderBy

private any caseInsensitiveOrderBy(any orderBy)

Parameters:: orderBy

clearAdvancedParams

public any clearAdvancedParams()

clearJoins

public any clearJoins()

clearParams

public any clearParams()

clone

public any clone()

Overrides:: clone in class bean

closeGrouping

public any closeGrouping()

contains

public any contains([any criteria])

Parameters:: criteria

containsValue

public any containsValue([any criteria])

Parameters:: criteria

endsWith

public any endsWith([any criteria])

Parameters:: criteria

formatField

public any formatField([any field])

Parameters:: field

getAdvancedParams

public any getAdvancedParams()

getAvailableCount

public any getAvailableCount()

getCustomDatasource

public any getCustomDatasource()

getDbType

public any getDbType()

getDiscriminatorColumn

public any getDiscriminatorColumn()

getDiscriminatorValue

public any getDiscriminatorValue()

getEntity

public any getEntity()

getEntityName

public any getEntityName()

Overrides:: getEntityName in class bean

getIsHistorical

public any getIsHistorical()

Overrides:: getIsHistorical in class bean

getItemsPerPage

public any getItemsPerPage()

getIterator

public any getIterator([any cachedWithin='[runtime expression]'])

Parameters:: cachedWithin

getJoins

public any getJoins()

getOrderBy

public any getOrderBy()

Overrides:: getOrderBy in class bean

getParams

public any getParams()

getQuery

public any getQuery([any countOnly='false'], [any cachedWithin='[runtime expression]'])

Parameters:: countOnly; cachedWithin

getQueryAttrs

public any getQueryAttrs([any cachedWithin='[runtime expression]'])

Overrides:: getQueryAttrs in class cfobject

Parameters:: cachedWithin

getQueryService

public any getQueryService([any cachedWithin='[runtime expression]'])

Overrides:: getQueryService in class cfobject

Parameters:: cachedWithin

getSort

public any getSort()

getTableFieldList

public any getTableFieldList()

hasColumn

public any hasColumn([any column])

Parameters:: column

hasCustomDatasource

public any hasCustomDatasource()

Overrides:: hasCustomDatasource in class cfobject

hasDiscriminatorColumn

public any hasDiscriminatorColumn()

hasJoin

public any hasJoin([any table])

Parameters:: table

innerJoin

public any innerJoin([any relatedEntity])

Parameters:: relatedEntity

isEQ

public any isEQ([any criteria])

Parameters:: criteria

isGT

public any isGT([any criteria])

Parameters:: criteria

isGTE

public any isGTE([any criteria])

Parameters:: criteria

isIn

public any isIn([any criteria])

Parameters:: criteria

isLT

public any isLT([any criteria])

Parameters:: criteria

isLTE

public any isLTE([any criteria])

Parameters:: criteria

isNEQ

public any isNEQ([any criteria])

Parameters:: criteria

isNotIn

public any isNotIn([any criteria])

Parameters:: criteria

itemsPerPage

public any itemsPerPage([any itemsPerPage])

Parameters:: itemsPerPage

leftJoin

public any leftJoin([any entityName])

Parameters:: entityName

loadTableMetaData

public any loadTableMetaData()

maxItems

public any maxItems([any maxItems])

Parameters:: maxItems

null

public any null()

openGrouping

public any openGrouping()

orOpenGrouping

public any orOpenGrouping()

orProp

public any orProp([any property])

Parameters:: property

prop

public any prop([any property])

Parameters:: property

setAdvancedParams

public any setAdvancedParams(any params)

Parameters:: params

setConfigBean

public any setConfigBean([any configBean])

Parameters:: configBean

setEntityName

public any setEntityName([any entityName])

Parameters:: entityName

setItemsPerPage

public any setItemsPerPage([any itemsPerPage])

Parameters:: itemsPerPage

setMaxItems

public any setMaxItems([any maxItems])

Parameters:: maxItems

setNextN

public any setNextN([any NextN])

Parameters:: NextN

setOrderBy

public any setOrderBy([any orderby])

Parameters:: orderby

setParams

public any setParams(any params)

Parameters:: params

setSort

public any setSort([any sort])

Parameters:: sort

setSortDirection

public any setSortDirection([any sortDirection])

Parameters:: sortDirection

sort

public any sort([any property], [any direction='asc'])

Parameters:: property; direction

where

public any where([any property])

Parameters:: property