## Zend_Gdata_Gapps_ServiceException

Description

Gdata Gapps Exception class. This is thrown when an AppsForYourDomainErrors message is received from the Google Apps servers.

Several different errors may be represented by this exception. For a list of error codes available, see getErrorCode.

- copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license: New BSD License

Located in /Gdata/Gapps/ServiceException.php (line 49)

    Exception
       |
       --Zend_Exception
          |
          --Zend_Gdata_Gapps_ServiceException

Variable Summary
array $_errors
mixed $_rootElement
Method Summary
array __construct ([ $errors = null])
void addError (Zend_Gdata_Gapps_Error $error)
Zend_Gdata_Gapps_Error getError ( $errorCode)
array getErrors ()
boolean hasError (integer $errorCode)
Zend_Gdata_Gapps_ServiceException importFromString (string $string)
void setErrors (array $array)
string __toString ()
Variables
array $_errors = array() (line 59)

Array of Zend_Gdata_Error objects indexed by error code.

- access: protected

mixed $_rootElement = "AppsForYourDomainErrors" (line 52)

- access: protected

Methods
Constructor __construct (line 67)

Create a new ServiceException.

- return: An array containing a collection of Zend_Gdata_Gapps_Error objects.
- access: public

array __construct ([ $errors = null])

- $errors

Redefinition of:

Zend_Exception::__construct()
  Construct the exception

addError (line 82)

Add a single Error object to the list of errors received by the server.

- throws: Zend_Gdata_App_Exception
- access: public

void addError (Zend_Gdata_Gapps_Error $error)

- Zend_Gdata_Gapps_Error $error: An instance of an error returned by the server. The error's errorCode must be set.

getError (line 126)

Return the Error object associated with a specific error code.

- return: The Error object requested, or null if not found.
- access: public

Zend_Gdata_Gapps_Error getError ( $errorCode)

- $errorCode

getErrors (line 116)

Get the list of errors as sent by the server inside of an AppsForYourDomainErrors tag.

- return: An associative array containing a collection of Zend_Gdata_Gapps_Error objects, indexed by error code.
- access: public

array getErrors ()
hasError (line 143)

Check whether or not a particular error code was returned by the server.

- return: Whether or not the supplied error code was returned by the server.
- access: public

boolean hasError (integer $errorCode)

- integer $errorCode: The error code to check against.

importFromString (line 154)

Import an AppsForYourDomain error from XML.

- return: Provides a fluent interface.
- throws: Zend_Gdata_App_Exception
- access: public

Zend_Gdata_Gapps_ServiceException importFromString (string $string)

- string $string: The XML data to be imported

setErrors (line 102)

Set the list of errors as sent by the server inside of an AppsForYourDomainErrors tag.

- throws: Zend_Gdata_App_Exception
- access: public

void setErrors (array $array)

- array $array: An associative array containing a collection of Zend_Gdata_Gapps_Error objects. All errors must have their errorCode value set.

__toString (line 201)

Get a human readable version of this exception.

- access: public

string __toString ()

Redefinition of:

Zend_Exception::__toString()
  String representation of the exception

#### Inherited Methods

Inherited From Zend_Exception

> Zend_Exception::__construct()
> Zend_Exception::_getPrevious()
> Zend_Exception::__call()
> Zend_Exception::__toString()

Documentation generated on Tue, 26 Oct 2010 20:09:12 +0400 by phpDocumentor 1.4.2