LayoutException

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
  - - com.ibm.commerce.foundation.client.facade.bod.AbstractBusinessObjectDocumentException
    - - com.ibm.commerce.pagelayout.facade.client.LayoutException

All Implemented Interfaces:

java.io.Serializable
```
public class LayoutException
extends AbstractBusinessObjectDocumentException
```
This exception represents a business error describing why the request failed. This exception is thrown when the Layout service returns error information.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT
copyright
- Fields inherited from class com.ibm.commerce.foundation.client.facade.bod.AbstractBusinessObjectDocumentException
  CHANGE_STATUS_CODE_VALUE_FOR_ERROR, ERROR_COUNT, ERROR_COUNT_KEY, MESSAGEKEY_ERRORCODE_SEPARATOR

Constructor Summary

Constructors
Constructor and Description
`LayoutException(ChangeStatusType changeStatus, VerbType verb, java.util.List layouts)` Creates an instance of the Layout exception.
`LayoutException(java.util.List clientErrors)` Creates an instance of the Layout exception.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method and Description

java.util.List getLayout()
Returns the Layout that is associated with the response of the request.
- Methods inherited from class com.ibm.commerce.foundation.client.facade.bod.AbstractBusinessObjectDocumentException
  addClientError, getChangeStatus, getClientErrors, getLocalizedMessage, getMessage, getVerb
- Methods inherited from class java.lang.Throwable
  addSuppressed, fillInStackTrace, getCause, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
- Methods inherited from class java.lang.Object
  equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - COPYRIGHT
```
public static final java.lang.String COPYRIGHT
```
    copyright
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LayoutException
```
public LayoutException(ChangeStatusType changeStatus,
                       VerbType verb,
                       java.util.List layouts)
```
    Creates an instance of the Layout exception.
    
    Parameters:
    
    changeStatus - The error information that is contained in the ChangeStatus element of the respond or acknowledge verb.
    
    verb - The returning verb.
    
    layouts - The list of Layout that is associated with the response.
  - LayoutException
```
public LayoutException(java.util.List clientErrors)
```
    Creates an instance of the Layout exception.
    
    Parameters:
    
    clientErrors - The client errors to associate with the exception. These client error represent client side parameter validation that cause the exception.
- Method Detail
  - getLayout
```
public java.util.List getLayout()
```
    Returns the Layout that is associated with the response of the request.
    
    Returns:
    
    The list of Layout found in the response.