Class isp api::OutputFormat

Материал из ISPWiki
Перейти к: навигация, поиск

Класс isp_api::OutputFormat

Данный класс является абстрактным

Класс для описания формата вывода

#include <output.h> 

Описание:

class isp_api::OutputFormat


Открытые члены (кратко)

OutputFormat ( const string &name )

Конструктор


virtual  ~OutputFormat ()

Деструктор


string name () const

Вернуть имя формата заданное в конструкторе


virtual bool IsHtml () const

Является ли этот формат HTML форматом


virtual bool WantMessages () const

Требуется ли загрузка локализованных сообщений


virtual void Write ( Connection &conn , mgr_xml::Xml &xml )

Отправить результат

Конструкторы

OutputFormat ( const string &name )

Конструктор

Создание этого объекта автоматически регистрирует его в списке доступных форматов

Аргументы:
[name] имя формата вывода

virtual ~OutputFormat ()

Деструктор

Методы

string name () const

Вернуть имя формата заданное в конструкторе

virtual bool IsHtml () const

Является ли этот формат HTML форматом

Если запрошенный формат HTML формат - результирующий XML документ проходит дополнительную обработку, чтобы улучшить представление данныхЯвляется ли этот формат HTML форматом

virtual bool WantMessages () const

Требуется ли загрузка локализованных сообщений

При запросах через API сообщения может быть достаточно кода сообщения

virtual void Write ( Connection &conn , mgr_xml::Xml &xml )

Отправить результат

Данный метод должен сформировать выходной поток на основании переданного XML документа и отправить его в conn.Output(). В этом методе conn доступен для записи. Метод может менять параметры запроса. Например, вы можете поменять параметры запроса и потребовать его повторного выполнения.

See also: RestartRequest