class GetList extends AbstractFunction

Methods

getControlId()

Get control ID

setControlId($controlId = null)

Set control ID

__construct(string $controlId = null)

Initializes the class with the given parameters.

writeXml(XMLWriter $xml)

Write the function block XML

string
getObjectName()

No description

setObjectName(string $objectName)

No description

int
getMaxTotalCount()

No description

setMaxTotalCount(int $maxTotalCount)

No description

int
getStartAtCount()

No description

setStartAtCount(int $startAtCount)

Set start at count, zero-based

boolean
isShowPrivate()

No description

setShowPrivate(boolean $showPrivate)

No description

getSortFields()

No description

setSortFields(SortField[] $sortFields)

No description

array
getReturnFields()

No description

setReturnFields(array $returnFields)

No description

getFilters()

No description

setFilters(FilterInterface[] $filters)

No description

setAdditionalParameters(AdditionalParameter[] $additionalParameters)

No description

Details

in AbstractFunction at line line 35
getControlId()

Get control ID

in AbstractFunction at line line 46
setControlId($controlId = null)

Set control ID

Parameters

$controlId

Exceptions

InvalidArgumentException

in AbstractFunction at line line 67
__construct(string $controlId = null)

Initializes the class with the given parameters.

Parameters

string $controlId Control ID, default=random UUID

at line line 187
writeXml(XMLWriter $xml)

Write the function block XML

Parameters

XMLWriter $xml

at line line 54
string getObjectName()

Return Value

string

at line line 62
setObjectName(string $objectName)

Parameters

string $objectName

at line line 70
int getMaxTotalCount()

Return Value

int

at line line 78
setMaxTotalCount(int $maxTotalCount)

Parameters

int $maxTotalCount

at line line 86
int getStartAtCount()

Return Value

int

at line line 96
setStartAtCount(int $startAtCount)

Set start at count, zero-based

Parameters

int $startAtCount

at line line 104
boolean isShowPrivate()

Return Value

boolean

at line line 112
setShowPrivate(boolean $showPrivate)

Parameters

boolean $showPrivate

at line line 120
SortField[] getSortFields()

Return Value

SortField[]

at line line 128
setSortFields(SortField[] $sortFields)

Parameters

SortField[] $sortFields

at line line 136
array getReturnFields()

Return Value

array

at line line 144
setReturnFields(array $returnFields)

Parameters

array $returnFields

at line line 152
FilterInterface[] getFilters()

Return Value

FilterInterface[]

at line line 160
setFilters(FilterInterface[] $filters)

Parameters

FilterInterface[] $filters

at line line 168
AdditionalParameter[] getAdditionalParameters()

Return Value

AdditionalParameter[]

at line line 176
setAdditionalParameters(AdditionalParameter[] $additionalParameters)

Parameters

AdditionalParameter[] $additionalParameters