1. class
  2. Intacct
  3. Functions
  4. Common
  5. ReadByQuery

ReadByQuery

class ReadByQuery extends AbstractFunction

Constants

RETURN_FORMATS

DEFAULT_RETURN_FORMAT

MIN_PAGE_SIZE

MAX_PAGE_SIZE

DEFAULT_PAGE_SIZE

Methods

getControlId()

Get control ID

from AbstractFunction
setControlId($controlId = null)

Set control ID

from AbstractFunction
__construct(string $controlId = null)

Initializes the class with the given parameters.

writeXml(XMLWriter $xml)

Write the readByQuery block XML

string
getObjectName()

No description

setObjectName(string $objectName)

No description

array
getFields()

No description

setFields(array $fields)

No description

string
getQuery()

No description

setQuery(string $query)

No description

int
getPageSize()

No description

setPageSize(int $pageSize)

Set page size

string
getReturnFormat()

No description

setReturnFormat(string $format)

Set return format

string
getDocParId()

No description

setDocParId(string $docParId)

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 183
__construct(string $controlId = null)

Initializes the class with the given parameters.

Parameters

string $controlId Control ID, default=random UUID

at line line 212
writeXml(XMLWriter $xml)

Write the readByQuery block XML

Parameters

XMLWriter $xml

at line line 63
string getObjectName()

Return Value

string

at line line 71
setObjectName(string $objectName)

Parameters

string $objectName

at line line 79
array getFields()

Return Value

array

at line line 87
setFields(array $fields)

Parameters

array $fields

at line line 95
string getQuery()

Return Value

string

at line line 103
setQuery(string $query)

Parameters

string $query

at line line 111
int getPageSize()

Return Value

int

at line line 122
setPageSize(int $pageSize)

Set page size

Parameters

int $pageSize

Exceptions

InvalidArgumentException

at line line 148
string getReturnFormat()

Return Value

string

at line line 159
setReturnFormat(string $format)

Set return format

Parameters

string $format

Exceptions

InvalidArgumentException

at line line 170
string getDocParId()

Return Value

string

at line line 178
setDocParId(string $docParId)

Parameters

string $docParId