beanFeed

Class beanFeed

WEB-INF.cftags.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

Property Summary
type	property	default	serializable	required
`string`	additionalColumns returntype = any access = public		`true`	`false`
`string`	contentpoolid returntype = any access = public		`true`	`false`
`string`	entityName returntype = any access = public		`true`	`false`
`string`	keyField returntype = any access = public		`true`	`false`
`numeric`	maxItems returntype = any access = public	`1000`	`true`	`true`
`numeric`	nextN returntype = any access = public	`0`	`true`	`true`
`string`	orderby returntype = any access = public		`true`	`false`
`numeric`	pageIndex returntype = any access = public	`1`	`true`	`false`
`string`	siteID returntype = any access = public		`true`	`false`
`string`	sortBy returntype = any access = public		`true`	`false`
`string`	sortDirection returntype = any access = public	`asc`	`true`	`true`
`string`	sortTable returntype = any access = public		`true`	`false`
`string`	table returntype = any access = public		`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`	aggregate([any type], [any property])
`any`	andOpenGrouping()
`any`	andProp([any property])
`any`	beginsWith([any criteria])
`private any`	caseInsensitiveOrderBy(any orderBy)
`any`	clearAdvancedParams()
`any`	clearJoins()
`any`	clearParams()
`any`	clone()
`any`	closeGrouping()
`any`	containsValue([any criteria])
`any`	distinct([any distinct='true'])
`any`	endsWith([any criteria])
`any`	fields([any fields])
`any`	formatField([any field])
`any`	getAdvancedParams()
`any`	getAvailableCount()
`any`	getContentPoolID()
`any`	getCustomDatasource()
`any`	getDbType()
`any`	getDiscriminatorColumn()
`any`	getDiscriminatorValue()
`any`	getDistinct()
`any`	getEndRow()
`any`	getEntity()
`any`	getEntityName()
`any`	getFetch()
`any`	getFields()
`any`	getIsHistorical()
`any`	getItemsPerPage()
`any`	getIterator([any cachedWithin='[runtime expression]'])
`any`	getJoins()
`any`	getOffset()
`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`	getStartRow()
`any`	getTableFieldList()
`any`	groupBy([any property])
`any`	hasColumn([any column])
`any`	hasCustomDatasource()
`any`	hasDiscriminatorColumn()
`any`	hasJoin([any table])
`any`	innerJoin([any relatedEntity])
`any`	isAggregateQuery()
`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`	sanitizedValue([any value])
`any`	setAdvancedParams(any params)
`any`	setConfigBean([any configBean])
`any`	setDistinct([any distinct='true'])
`any`	setEntityName([any entityName])
`any`	setFields([any fields])
`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])
`any`	transformFieldName([any fieldname])
`any`	transformFields([any fields])
`any`	where([any property])

Methods inherited from class `mura.bean.bean`
OnMissingMethod, addEventHandler, addObject, allowAccess, allowDelete, allowQueryParams, allowRead, allowSave, compare, exists, get, getAll, getAllValues, getBundleable, getDynamic, getEntityDisplayName, getErrors, getFeed, getHasManyPropArray, getHasOnePropArray, getInstanceName, getPrimaryKey, getProperties, getPublicAPI, getRegisteredEntity, getScaffold, getSynthedFunctions, getTable, getValidations, getValue, has, hasErrors, hasProperty, hasTable, isComparable, on, parseDateArg, registerAsEntity, removeObject, set, setAddedObjectValues, setAllValues, setErrors, setPropAsIDColumn, setValidations, setValue, setlastUpdateBy, synthArgs, transformEventName, translatePropKey, trigger, validate, valueExists

Methods inherited from class mura.bean.bean

OnMissingMethod, addEventHandler, addObject, allowAccess, allowDelete, allowQueryParams, allowRead, allowSave, compare, exists, get, getAll, getAllValues, getBundleable, getDynamic, getEntityDisplayName, getErrors, getFeed, getHasManyPropArray, getHasOnePropArray, getInstanceName, getPrimaryKey, getProperties, getPublicAPI, getRegisteredEntity, getScaffold, getSynthedFunctions, getTable, getValidations, getValue, has, hasErrors, hasProperty, hasTable, isComparable, on, parseDateArg, registerAsEntity, removeObject, set, setAddedObjectValues, setAllValues, setErrors, setPropAsIDColumn, setValidations, setValue, setlastUpdateBy, synthArgs, transformEventName, translatePropKey, trigger, 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 `WEB-INF.cftags.component`
None

Constructor Detail

init

public init()

Property Detail

additionalColumns

property string additionalColumns

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

contentpoolid

property string contentpoolid

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

entityName

property string entityName

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

keyField

property string keyField

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

maxItems

property numeric maxItems = [1000]

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

nextN

property numeric nextN = [0]

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

orderby

property string orderby

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

pageIndex

property numeric pageIndex = [1]

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

siteID

property string siteID

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

sortBy

property string sortBy

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

sortDirection

property string sortDirection = [asc]

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

sortTable

property string sortTable

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

table

property string table

Attributes:: returntype - any; required - false; access - public; 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; relationship; criteria; condition; datatype

aggregate

public any aggregate([any type], [any property])

Parameters:: type; property

andOpenGrouping

public any andOpenGrouping()

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()

containsValue

public any containsValue([any criteria])

Parameters:: criteria

distinct

public any distinct([any distinct='true'])

Parameters:: distinct

endsWith

public any endsWith([any criteria])

Parameters:: criteria

fields

public any fields([any fields])

Parameters:: fields

formatField

public any formatField([any field])

Parameters:: field

getAdvancedParams

public any getAdvancedParams()

getAvailableCount

public any getAvailableCount()

getContentPoolID

public any getContentPoolID()

getCustomDatasource

public any getCustomDatasource()

getDbType

public any getDbType()

getDiscriminatorColumn

public any getDiscriminatorColumn()

getDiscriminatorValue

public any getDiscriminatorValue()

getDistinct

public any getDistinct()

getEndRow

public any getEndRow()

getEntity

public any getEntity()

Overrides:: getEntity in class cfobject

getEntityName

public any getEntityName()

Overrides:: getEntityName in class bean

getFetch

public any getFetch()

getFields

public any getFields()

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()

getOffset

public any getOffset()

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()

getStartRow

public any getStartRow()

getTableFieldList

public any getTableFieldList()

groupBy

public any groupBy([any property])

Parameters:: property

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

isAggregateQuery

public any isAggregateQuery()

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

sanitizedValue

public any sanitizedValue([any value])

Parameters:: value

setAdvancedParams

public any setAdvancedParams(any params)

Parameters:: params

setConfigBean

public any setConfigBean([any configBean])

Parameters:: configBean

setDistinct

public any setDistinct([any distinct='true'])

Parameters:: distinct

setEntityName

public any setEntityName([any entityName])

Parameters:: entityName

setFields

public any setFields([any fields])

Parameters:: fields

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])

Parameters:: property; direction

transformFieldName

public any transformFieldName([any fieldname])

Parameters:: fieldname

transformFields

public any transformFields([any fields])

Parameters:: fields

where

public any where([any property])

Parameters:: property