class ReadReport extends AbstractFunction

Constants

RETURN_FORMATS

DEFAULT_RETURN_FORMAT

MIN_PAGE_SIZE

MAX_PAGE_SIZE

DEFAULT_PAGE_SIZE

MIN_WAIT_TIME

MAX_WAIT_TIME

DEFAULT_WAIT_TIME

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 readReport block XML

string
getReportName()

No description

setReportName(string $report)

Set report name

array
getArguments()

No description

setArguments(array $arguments)

No description

int
getPageSize()

No description

setPageSize(int $pageSize)

Set page size

string
getReturnFormat()

No description

setReturnFormat(string $format)

Set return format

int
getWaitTime()

No description

setWaitTime(int $waitTime)

Set wait time

string
getListSeparator()

No description

setListSeparator(string $listSeparator)

Set list separator

setReturnDef(bool $returnDef)

No description

boolean
isReturnDef()

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

at line line 254
__construct(string $controlId = null)

Initializes the class with the given parameters.

Parameters

string $controlId Control ID, default=random UUID

at line line 295
writeXml(XMLWriter $xml)

Write the readReport block XML

Parameters

XMLWriter $xml

at line line 75
string getReportName()

Return Value

string

at line line 86
setReportName(string $report)

Set report name

Parameters

string $report Report name

Exceptions

InvalidArgumentException

at line line 100
array getArguments()

Return Value

array

at line line 109
setArguments(array $arguments)

Parameters

array $arguments

at line line 117
int getPageSize()

Return Value

int

at line line 128
setPageSize(int $pageSize)

Set page size

Parameters

int $pageSize Page size

Exceptions

InvalidArgumentException

at line line 154
string getReturnFormat()

Return Value

string

at line line 165
setReturnFormat(string $format)

Set return format

Parameters

string $format Return format

Exceptions

InvalidArgumentException

at line line 176
int getWaitTime()

Return Value

int

at line line 187
setWaitTime(int $waitTime)

Set wait time

Parameters

int $waitTime Wait time

Exceptions

InvalidArgumentException

at line line 213
string getListSeparator()

Return Value

string

at line line 224
setListSeparator(string $listSeparator)

Set list separator

Parameters

string $listSeparator

Exceptions

InvalidArgumentException

at line line 236
setReturnDef(bool $returnDef)

Parameters

bool $returnDef

at line line 244
boolean isReturnDef()

Return Value

boolean