Anfragen

OMC_Inquiry

Die Klasse OMC_Inquiry repräsentiert im OMC Connector (PHP) die im Online Marketing Cockpit gespeicherten Anfragen. Die Instanzmethoden dieser Klasse, die Beschreibung von Tagebucheinträgen und die Beschreibung von Links finden Sie weiter unten in diesem Dokument.

Klassenmethoden

`OMC_Inquiry __construct([array $fields = array()])`
Aufgabe: Erstellt eine neue lokale Instanz einer Anfrage. Zugriff: `$neue_anfrage = new OMC_Inquiry();` Rückgabewert: Die Instanz der Anfrage. Exceptions: –

`OMC_Inquiry create([array $properties = array()])`
Aufgabe: Erstellt im OMC eine Anfrage mit den angegebenen Feldern. Entweder das Feld `email_cc` oder das Feld `contact_id` muss gesetzt sein. Rückgabewert: Die Instanz der Anfrage. Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceInvalidException`

`OMC_Inquiry find(integer $scope, [array $params = array()])`
Aufgabe: Findet eine Anfrage anhand der gegebenen ID (`$scope`) im OMC. Rückgabewert: Die Instanz der Anfrage. Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceNotFoundException`

Instanzmethoden

`OMC_Diary createDiary(array $params)`
Aufgabe: Erstellt einen Tagebucheintrag für diese Anfrage. Rückgabewert: Die Instanz des Tagebucheintrags. Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceInvalidException`

`OMC_InquiryLink createLink(array $params)`
Aufgabe: Erstellt einen Link für diese Anfrage. Rückgabewert: Die Instanz des Links. Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceInvalidException`

`OMC_InquiryLink findLink(integer $linkId)`
Aufgabe: Findet den Link mit der ID (`$linkId`), wenn der Link mit dieser Anfrage verknüpft ist. Rückgabewert: Die Instanz des Links. Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceNotFoundException`

`array<OMC_Diary> getDiaries()`
Aufgabe: Listet alle Tagebucheinträge zu dieser Anfrage auf. Zugriff: `$anfrage->diaries` Rückgabewert: Ein Array von Instanzen der Tagebucheinträge Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceNotFoundException`

`array<OMC_InquiryLink> getLinks()`
Aufgabe: Listet alle Links auf, die zu dieser Anfrage gehören. Zugriff: `$anfrage->links` Rückgabewert: Ein Array von Instanzen der Links Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceNotFoundException`

`array getFields()`
Aufgabe: Listet alle nicht leeren Felder dieser Anfrage auf. Rückgabewert: Ein Array mit Name/Wert-Paaren verschiedenen Typs (String, Integer, Boolean usw.) Exceptions: –

`boolean isNewRecord()`
Aufgabe: Überprüft, ob diese Anfrage bereits im OMC existiert. Rückgabewert: `true`, wenn es sich um eine bisher noch nicht gespeicherte Anfrage handelt. Exceptions: –

`boolean save()`
Aufgabe: Speichert die lokalen Änderungen dieser Anfrage im OMC, oder erstellt eine neue Anfrage. Rückgabewert: Meldet, ob das Speichern erfolgreich war. Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceInvalidException`

`boolean updateAttributes(array $attributes)`
Aufgabe: Ändert die Felder dieser Anfrage und speichert sie im OMC. Rückgabewert: Meldet, ob die Änderungen erfolgreich waren. Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceInvalidException`

`void updateFields(array $fields)`
Aufgabe: Überschreibt die angegebenen Felder aus `$fields` der Anfrage lokal. Felder, die diese Anfrage hat, die jedoch nicht in `$fields` angegeben sind, werden nicht gelöscht oder überschrieben. Rückgabewert: – Exceptions: –

OMC_Diary

Die Klasse OMC_Diary repräsentiert im OMC Connector (PHP) die im Online Marketing Cockpit gespeicherten Tagebucheinträge zu Anfragen. Diese Klasse dient lediglich dem Zweck, Name/Wert-Paare auszulesen.

Instanzmethoden

`array getFields()`
Aufgabe: Listet alle nicht leeren Felder dieses Tgebucheintrages auf. Rückgabewert: Ein Array mit Name/Wert-Paaren verschiedenen Typs (String, Integer, Boolean usw.) Exceptions: –

OMC_InquiryLink

Die Klasse OMC_InquiryLink repräsentiert im OMC Connector (PHP) die im Online Marketing Cockpit gespeicherten Links zu Anfragen.

Instanzmethoden

`void destroy()`
Aufgabe: Löscht diesen Link im OMC. Rückgabewert: – Exceptions: `OMC_UnauthorizedAccessException`

`array getFields()`
Aufgabe: Listet alle nicht leeren Felder dieses Links auf. Rückgabewert: Ein Array mit Name/Wert-Paaren verschiedenen Typs (String, Integer, Boolean usw.) Exceptions: –

`boolean isNewRecord()`
Aufgabe: Überprüft, ob dieser Link bereits im OMC existiert. Rückgabewert: `true`, wenn es sich um eine bisher noch nicht gespeicherten Link handelt. Exceptions: –

`boolean save()`
Aufgabe: Speichert die lokalen Änderungen dieses Links im OMC. Rückgabewert: Meldet, ob das Speichern erfolgreich war. Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceInvalidException`

`boolean updateAttributes(array $attributes)`
Aufgabe: Ändert die Felder dieses Links und speichert sie im OMC. Rückgabewert: Meldet, ob die Änderungen erfolgreich waren. Exceptions: `OMC_UnauthorizedAccessException`, `OMC_ResourceInvalidException`

`void updateFields(array $fields)`
Aufgabe: Überschreibt die angegebenen Felder aus `$fields` dieses Links lokal. Felder, die diese Anfrage hat, die jedoch nicht in `$fields` angegeben sind, werden nicht gelöscht oder überschrieben. Rückgabewert: – Exceptions: –