class DdsJobCreate extends AbstractFunction

Create a new DDS job record

Constants

JOB_TYPES

JOB_TYPE_ALL

JOB_TYPE_CHANGE

FILE_FORMATS

FILE_FORMAT_UNIX

FILE_FORMAT_WINDOWS

FILE_FORMAT_MAC

MIN_SPLIT_SIZE

MAX_SPLIT_SIZE

DEFAULT_SPLIT_SIZE

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

string
getCloudDeliveryName()

No description

setCloudDeliveryName(string $cloudDeliveryName)

No description

string
getJobType()

No description

setJobType(string $jobType)

No description

getTimestamp()

No description

setTimestamp(DateTime $timestamp)

No description

string
getDelimiter()

No description

setDelimiter(string $delimiter)

No description

string
getEnclosure()

No description

setEnclosure(string $enclosure)

No description

boolean
isIncludeHeaders()

No description

setIncludeHeaders(boolean $includeHeaders)

No description

string
getFileFormat()

No description

setFileFormat($fileFormat)

No description

string
getSplitSize()

No description

setSplitSize($splitSize)

No description

boolean
isCompressed()

No description

setCompressed(boolean $compressed)

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 271
writeXml(XMLWriter $xml)

Write the function block XML

Parameters

XMLWriter $xml

at line line 94
string getObjectName()

Return Value

string

at line line 102
setObjectName(string $objectName)

Parameters

string $objectName

at line line 110
string getCloudDeliveryName()

Return Value

string

at line line 118
setCloudDeliveryName(string $cloudDeliveryName)

Parameters

string $cloudDeliveryName

at line line 126
string getJobType()

Return Value

string

at line line 135
setJobType(string $jobType)

Parameters

string $jobType

Exceptions

InvalidArgumentException

at line line 146
DateTime getTimestamp()

Return Value

DateTime

at line line 154
setTimestamp(DateTime $timestamp)

Parameters

DateTime $timestamp

at line line 162
string getDelimiter()

Return Value

string

at line line 170
setDelimiter(string $delimiter)

Parameters

string $delimiter

at line line 178
string getEnclosure()

Return Value

string

at line line 186
setEnclosure(string $enclosure)

Parameters

string $enclosure

at line line 194
boolean isIncludeHeaders()

Return Value

boolean

at line line 202
setIncludeHeaders(boolean $includeHeaders)

Parameters

boolean $includeHeaders

at line line 210
string getFileFormat()

Return Value

string

at line line 219
setFileFormat($fileFormat)

Parameters

$fileFormat

Exceptions

InvalidArgumentException

at line line 230
string getSplitSize()

Return Value

string

at line line 239
setSplitSize($splitSize)

Parameters

$splitSize

Exceptions

InvalidArgumentException

at line line 253
boolean isCompressed()

Return Value

boolean

at line line 261
setCompressed(boolean $compressed)

Parameters

boolean $compressed