class AbstractAllocation extends AbstractFunction

Constants

ALLOCATE_BY_PERCENTAGE

ALLOCATE_BY_ABSOLUTE

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 XML

string
getAllocationId()

Get allocation ID

setAllocationId(string $allocationId)

Set allocation ID

string
getDescription()

Get description

setDescription(string $description)

Set description

string
getDocumentNo()

Get document number

setDocumentNo(string $documentNo)

Set document number

string
getAllocateBy()

Get allocate by

setAllocateBy(string $allocateBy)

Set allocate by

string
getAttachmentsId()

Get attachments ID

setAttachmentsId(string $attachmentsId)

Set attachments ID

boolean
isActive()

Get active

setActive(boolean $active)

Set active

getLines()

Get allocation lines

setLines(array $lines)

Set allocation lines

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

in AbstractFunction at line line 72
abstract writeXml(XMLWriter $xml)

Write the XML

Parameters

XMLWriter $xml

at line line 57
string getAllocationId()

Get allocation ID

Return Value

string

at line line 67
setAllocationId(string $allocationId)

Set allocation ID

Parameters

string $allocationId

at line line 77
string getDescription()

Get description

Return Value

string

at line line 87
setDescription(string $description)

Set description

Parameters

string $description

at line line 97
string getDocumentNo()

Get document number

Return Value

string

at line line 107
setDocumentNo(string $documentNo)

Set document number

Parameters

string $documentNo

at line line 117
string getAllocateBy()

Get allocate by

Return Value

string

at line line 128
setAllocateBy(string $allocateBy)

Set allocate by

Parameters

string $allocateBy

at line line 138
string getAttachmentsId()

Get attachments ID

Return Value

string

at line line 148
setAttachmentsId(string $attachmentsId)

Set attachments ID

Parameters

string $attachmentsId

at line line 158
boolean isActive()

Get active

Return Value

boolean

at line line 168
setActive(boolean $active)

Set active

Parameters

boolean $active

at line line 178
AbstractAllocationLine[] getLines()

Get allocation lines

Return Value

AbstractAllocationLine[]

at line line 188
setLines(array $lines)

Set allocation lines

Parameters

array $lines