Nicolas Franck > Catmandu-AlephX-1.06 > Catmandu::AlephX::Response

Download:
Catmandu-AlephX-1.06.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Source   Latest Release: Catmandu-AlephX-1.065

NAME ^

  Catmandu::AlephX::Response - base class for xml-responses from the AlephX-server

SYNOPSIS ^

  All responses from the AlephX-server share the same functionality and keys:
    - expressed in XML
    - name of the parent element is equal to the parameter 'op', except when
      the value in 'op' is not recognized. Then it is set to 'login'.
    - when an internal error occurred, the error is reported in the key 'error'
    - session-id is reported in the key 'session-id'
    - al the other subkeys are be treated as 'data'

  All public methods from Catmandu::AlephX return an object of a subclass of Catmandu::AlepX::Response.
  In case of connection errors, or xml parsing problems, exceptions are thrown.

methods ^

op

  type of 'op'.

error

  internal error that was reported in the xml response.
  These errors only apply to values in your parameters.
  Other errors, like connection errors or problems while parsing the xml response are thrown as exceptions.

session_id

  session-id of the current request

is_success

  This method only checks if there was an internal error in the AlephX-response.
  So it simply tests if the key 'error' was undefined.   

  As said before, other errors are thrown as exceptions  
syntax highlighting: