DdsJobCreate Class Reference
Inheritance diagram for DdsJobCreate:
Public Member Functions | |
| getObjectName () | |
| setObjectName ($objectName) | |
| getCloudDeliveryName () | |
| setCloudDeliveryName ($cloudDeliveryName) | |
| getJobType () | |
| setJobType ($jobType) | |
| getTimestamp () | |
| setTimestamp ($timestamp) | |
| getDelimiter () | |
| setDelimiter ($delimiter) | |
| getEnclosure () | |
| setEnclosure ($enclosure) | |
| isIncludeHeaders () | |
| setIncludeHeaders ($includeHeaders) | |
| getFileFormat () | |
| setFileFormat ($fileFormat) | |
| getSplitSize () | |
| setSplitSize ($splitSize) | |
| isCompressed () | |
| setCompressed ($compressed) | |
| writeXml (XMLWriter &$xml) | |
 Public Member Functions inherited from AbstractFunction | |
| getControlId () | |
| setControlId (string $controlId='') | |
| __construct (string $controlId='') | |
| writeXml (XMLWriter &$xml) | |
| getControlId () | |
| setControlId (string $controlId) | |
| writeXml (XMLWriter &$xml) | |
Data Fields | |
| const | JOB_TYPES = ['all', 'change'] |
| const | JOB_TYPE_ALL = 'all' |
| const | JOB_TYPE_CHANGE = 'change' |
| const | FILE_FORMATS = ['unix', 'windows', 'mac'] |
| const | FILE_FORMAT_UNIX = 'unix' |
| const | FILE_FORMAT_WINDOWS = 'windows' |
| const | FILE_FORMAT_MAC = 'mac' |
| const | MIN_SPLIT_SIZE = 10000 |
| const | MAX_SPLIT_SIZE = 100000 |
| const | DEFAULT_SPLIT_SIZE = 100000 |
Additional Inherited Members | |
| Protected Attributes inherited from AbstractFunction | |
| $controlId = '' | |
Detailed Description
Create a new DDS job record
Member Function Documentation
◆ getCloudDeliveryName()
| getCloudDeliveryName | ( | ) |
- Returns
- string
◆ getDelimiter()
| getDelimiter | ( | ) |
- Returns
- string
◆ getEnclosure()
| getEnclosure | ( | ) |
- Returns
- string
◆ getFileFormat()
| getFileFormat | ( | ) |
- Returns
- string
◆ getJobType()
| getJobType | ( | ) |
- Returns
- string
◆ getObjectName()
| getObjectName | ( | ) |
- Returns
- string
◆ getSplitSize()
| getSplitSize | ( | ) |
- Returns
- string
◆ getTimestamp()
| getTimestamp | ( | ) |
- Returns
- DateTime
◆ isCompressed()
| isCompressed | ( | ) |
- Returns
- bool
◆ isIncludeHeaders()
| isIncludeHeaders | ( | ) |
- Returns
- bool
◆ setCloudDeliveryName()
| setCloudDeliveryName | ( | $cloudDeliveryName | ) |
- Parameters
-
string $cloudDeliveryName
◆ setCompressed()
| setCompressed | ( | $compressed | ) |
- Parameters
-
bool $compressed
◆ setDelimiter()
| setDelimiter | ( | $delimiter | ) |
- Parameters
-
string $delimiter
◆ setEnclosure()
| setEnclosure | ( | $enclosure | ) |
- Parameters
-
string $enclosure
◆ setFileFormat()
| setFileFormat | ( | $fileFormat | ) |
- Parameters
-
$fileFormat
- Exceptions
-
InvalidArgumentException
◆ setIncludeHeaders()
| setIncludeHeaders | ( | $includeHeaders | ) |
- Parameters
-
bool $includeHeaders
◆ setJobType()
| setJobType | ( | $jobType | ) |
- Parameters
-
string $jobType
- Exceptions
-
InvalidArgumentException
◆ setObjectName()
| setObjectName | ( | $objectName | ) |
- Parameters
-
string $objectName
◆ setSplitSize()
| setSplitSize | ( | $splitSize | ) |
- Parameters
-
$splitSize
- Exceptions
-
InvalidArgumentException
◆ setTimestamp()
| setTimestamp | ( | $timestamp | ) |
- Parameters
-
DateTime $timestamp
◆ writeXml()
| writeXml | ( | XMLWriter & | $xml | ) |
Field Documentation
◆ DEFAULT_SPLIT_SIZE
| const DEFAULT_SPLIT_SIZE = 100000 |
◆ FILE_FORMAT_MAC
| const FILE_FORMAT_MAC = 'mac' |
◆ FILE_FORMAT_UNIX
| const FILE_FORMAT_UNIX = 'unix' |
◆ FILE_FORMAT_WINDOWS
| const FILE_FORMAT_WINDOWS = 'windows' |
◆ FILE_FORMATS
| const FILE_FORMATS = ['unix', 'windows', 'mac'] |
◆ JOB_TYPE_ALL
| const JOB_TYPE_ALL = 'all' |
◆ JOB_TYPE_CHANGE
| const JOB_TYPE_CHANGE = 'change' |
◆ JOB_TYPES
| const JOB_TYPES = ['all', 'change'] |
◆ MAX_SPLIT_SIZE
| const MAX_SPLIT_SIZE = 100000 |
◆ MIN_SPLIT_SIZE
| const MIN_SPLIT_SIZE = 10000 |
