AbstractPageLayoutFacadeClient

java.lang.Object
- com.ibm.commerce.foundation.client.facade.bod.AbstractBusinessObjectDocumentFacadeClient
- - com.ibm.commerce.pagelayout.facade.client.AbstractPageLayoutFacadeClient

Direct Known Subclasses:

AbstractExternalPageLayoutFacadeClient, PageLayoutFacadeClient
```
public abstract class AbstractPageLayoutFacadeClient
extends AbstractBusinessObjectDocumentFacadeClient
```
This class provides a set of methods that can be used to communicate with the PageLayout facade. This class represents a library of PageLayout operations that can be performed. The purpose of this class is to hide the details about constructing the business object document that represents the service request into simple Java methods. The complexity of building the request document and making the request is all managed by this client class of the PageLayout facade.

Field Summary
- Fields inherited from class com.ibm.commerce.foundation.client.facade.bod.AbstractBusinessObjectDocumentFacadeClient
  CHANGE_VERB_ACTION_ADD, CHANGE_VERB_ACTION_CHANGE, CHANGE_VERB_ACTION_CREATE, CHANGE_VERB_ACTION_DELETE, CHANGE_VERB_ACTION_UPDATE

Constructor Summary

Constructors
Constructor and Description
`AbstractPageLayoutFacadeClient()` Creates an instance of the client to communicate with the PageLayout facade.
`AbstractPageLayoutFacadeClient(BusinessContextType businessContext, javax.security.auth.callback.CallbackHandler callbackHandler)` Creates an instance of the client to communicate with the PageLayout facade.

Method Summary

Methods
Modifier and Type	Method and Description
`RespondLayoutType`	`changeLayout(ChangeLayoutType aChangeLayout)` This method will communicate with the Layout facade and send the specified ChangeLayout request.
`RespondPageType`	`changePage(ChangePageType aChangePage)` This method will communicate with the Page facade and send the specified ChangePage request.
`protected AcknowledgeLayoutDataAreaType`	`checkAcknowledgeLayout(AcknowledgeLayoutDataAreaType acknowledgeLayoutDataArea)` This method will examine the AcknowledgeLayoutDataArea to see if there is any error information reported.
`protected AcknowledgePageDataAreaType`	`checkAcknowledgePage(AcknowledgePageDataAreaType acknowledgePageDataArea)` This method will examine the AcknowledgePageDataArea to see if there is any error information reported.
`protected RespondLayoutDataAreaType`	`checkRespondLayout(RespondLayoutDataAreaType respondLayoutDataArea)` This method will examine the RespondLayoutDataArea to see if there is any error information reported.
`protected RespondPageDataAreaType`	`checkRespondPage(RespondPageDataAreaType respondPageDataArea)` This method will examine the RespondPageDataArea to see if there is any error information reported.
`protected ShowLayoutDataAreaType`	`checkShowLayout(ShowLayoutDataAreaType showLayoutDataArea)` This method will examine the ShowLayoutDataArea to see if there is any error information reported.
`protected ShowPageDataAreaType`	`checkShowPage(ShowPageDataAreaType showPageDataArea)` This method will examine the ShowPageDataArea to see if there is any error information reported.
`protected ShowPageDesignDataAreaType`	`checkShowPageDesign(ShowPageDesignDataAreaType showPageDesignDataArea)` This method will examine the ShowPageDesignDataArea to see if there is any error information reported.
`protected ShowWidgetDefinitionDataAreaType`	`checkShowWidgetDefinition(ShowWidgetDefinitionDataAreaType showWidgetDefinitionDataArea)` This method will examine the ShowWidgetDefinitionDataArea to see if there is any error information reported.
`ShowLayoutType`	`getLayout(GetLayoutType aGetLayout)` This method will communicate with the PageLayout facade and send the specified GetLayout.
`ShowLayoutDataAreaType`	`getLayout(GetType getVerb)` This method returns the `ShowLayoutDataArea` when issuing the specified get expression to fetch Layouts.
`java.util.List`	`getLayout(java.lang.String expressionLanguage, java.lang.String expression)` This method returns a list of Layouts based on the expression specified.
`ShowPageType`	`getPage(GetPageType aGetPage)` This method will communicate with the PageLayout facade and send the specified GetPage.
`ShowPageDataAreaType`	`getPage(GetType getVerb)` This method returns the `ShowPageDataArea` when issuing the specified get expression to fetch Pages.
`java.util.List`	`getPage(java.lang.String expressionLanguage, java.lang.String expression)` This method returns a list of Pages based on the expression specified.
`ShowPageDesignType`	`getPageDesign(GetPageDesignType aGetPageDesign)` This method will communicate with the PageLayout facade and send the specified GetPageDesign.
`ShowPageDesignDataAreaType`	`getPageDesign(GetType getVerb)` This method returns the `ShowPageDesignDataArea` when issuing the specified get expression to fetch PageDesigns.
`java.util.List`	`getPageDesign(java.lang.String expressionLanguage, java.lang.String expression)` This method returns a list of PageDesigns based on the expression specified.
`protected PageLayoutFactory`	`getPageLayoutFactory()` This method will return the default instance of the PageLayout Factory.
`ShowWidgetDefinitionDataAreaType`	`getWidgetDefinition(GetType getVerb)` This method returns the `ShowWidgetDefinitionDataArea` when issuing the specified get expression to fetch WidgetDefinitions.
`ShowWidgetDefinitionType`	`getWidgetDefinition(GetWidgetDefinitionType aGetWidgetDefinition)` This method will communicate with the PageLayout facade and send the specified GetWidgetDefinition.
`java.util.List`	`getWidgetDefinition(java.lang.String expressionLanguage, java.lang.String expression)` This method returns a list of WidgetDefinitions based on the expression specified.
`AcknowledgeLayoutType`	`processLayout(ProcessLayoutType aProcessLayout)` This method will communicate with the PageLayout facade and send the specified ProcessLayout request.
`AcknowledgePageType`	`processPage(ProcessPageType aProcessPage)` This method will communicate with the PageLayout facade and send the specified ProcessPage request.

Methods inherited from class com.ibm.commerce.foundation.client.facade.bod.AbstractBusinessObjectDocumentFacadeClient
createActionExpression, createChangeVerb, createGetVerb, createGetVerb, createProcessVerb, createSyncVerb, getApplicationArea, getBusinessContext, getCallbackHandler, getCommerceFoundationFactory, getOagis9Factory, sendBusinessObjectDocument

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractPageLayoutFacadeClient
```
public AbstractPageLayoutFacadeClient()
```
    Creates an instance of the client to communicate with the PageLayout facade.
  - AbstractPageLayoutFacadeClient
```
public AbstractPageLayoutFacadeClient(BusinessContextType businessContext,
                              javax.security.auth.callback.CallbackHandler callbackHandler)
```
    Creates an instance of the client to communicate with the PageLayout facade.
    
    Parameters:
    
    businessContext - The default business context to associate with the messages when making requests.
    
    callbackHandler - Used for authentication purposes so the controller can give the authentication information to the transport when required.
- Method Detail
  - getPageLayoutFactory
```
protected PageLayoutFactory getPageLayoutFactory()
```
    This method will return the default instance of the PageLayout Factory. This factory can be used to create objects defined by the PageLayout.
    
    Returns:
    
    The default PageLayout Factory.
  - getLayout
```
public ShowLayoutType getLayout(GetLayoutType aGetLayout)
```
    This method will communicate with the PageLayout facade and send the specified GetLayout. request.
    
    Parameters:
    
    aGetLayout - The GetLayout request document.
    
    Returns:
    
    The resulting ShowLayout response document.
  - processLayout
```
public AcknowledgeLayoutType processLayout(ProcessLayoutType aProcessLayout)
                                    throws LayoutException
```
    This method will communicate with the PageLayout facade and send the specified ProcessLayout request.
    
    Parameters:
    
    aProcessLayout - The ProcessLayout request document.
    
    Returns:
    
    The resulting AcknowledgeLayout response document.
    
    Throws:
    
    LayoutException - If there are any errors returned in the response.
  - changeLayout
```
public RespondLayoutType changeLayout(ChangeLayoutType aChangeLayout)
                               throws LayoutException
```
    This method will communicate with the Layout facade and send the specified ChangeLayout request.
    
    Parameters:
    
    aChangeLayout - The ChangeLayout request document.
    
    Returns:
    
    The resulting RespondLayout response document.
    
    Throws:
    
    LayoutException - If there are errors in the response.
  - checkAcknowledgeLayout
```
protected AcknowledgeLayoutDataAreaType checkAcknowledgeLayout(AcknowledgeLayoutDataAreaType acknowledgeLayoutDataArea)
                                                        throws LayoutException
```
    This method will examine the AcknowledgeLayoutDataArea to see if there is any error information reported. If there is, then the LayoutException will be thrown to represent the error. This method should be used by those methods that are performing a Process operation on a single Layout.
    
    Parameters:
    
    acknowledgeLayoutDataArea - The acknowledge Layout data area to inspect.
    
    Returns:
    
    The specified AcknowledgeLayoutDataArea if no error information is found.
    
    Throws:
    
    LayoutException - The LayoutException is thrown if error information is found in the specified AcknowledgeLayoutDataArea. This will represent that there was a problem when performing the operation.
  - checkRespondLayout
```
protected RespondLayoutDataAreaType checkRespondLayout(RespondLayoutDataAreaType respondLayoutDataArea)
                                                throws LayoutException
```
    This method will examine the RespondLayoutDataArea to see if there is any error information reported. If there is, then the LayoutException will be thrown to represent the error. This method should be used by those methods that are performing a Process operation on a single Layout.
    
    Parameters:
    
    respondLayoutDataArea - The respond Layout data area to inspect.
    
    Returns:
    
    The specified RespondLayoutDataArea if no error information is found.
    
    Throws:
    
    LayoutException - The LayoutException is thrown if error information is found in the specified RespondLayoutDataArea. This will represent that there was a problem when performing the operation.
  - checkShowLayout
```
protected ShowLayoutDataAreaType checkShowLayout(ShowLayoutDataAreaType showLayoutDataArea)
                                          throws LayoutException
```
    This method will examine the ShowLayoutDataArea to see if there is any error information reported. If there is, then the LayoutException will be thrown to represent the error. This method should be used by those methods that are performing a Process operation on a single Layout.
    
    Parameters:
    
    showLayoutDataArea - The show Layout data area to inspect.
    
    Returns:
    
    The specified ShowLayoutDataArea if no error information is found.
    
    Throws:
    
    LayoutException - The LayoutException is thrown if error information is found in the specified ShowLayoutDataArea. This will represent that there was a problem when performing the operation.
  - getLayout
```
public ShowLayoutDataAreaType getLayout(GetType getVerb)
                                 throws LayoutException
```
    This method returns the ShowLayoutDataArea when issuing the specified get expression to fetch Layouts. This method will be used by other framworks or methods that constructs the get expression.
    
    Parameters:
    
    getVerb - The get expression to execute.
    
    Returns:
    
    The ShowLayoutDataArea response when issuing the get expression.
    
    Throws:
    
    LayoutException - The LayoutException is thrown if error information is found in the specified ShowLayoutDataArea. This will represent that there was a problem when performing the operation.
  - getLayout
```
public java.util.List getLayout(java.lang.String expressionLanguage,
                       java.lang.String expression)
                         throws LayoutException
```
    This method returns a list of Layouts based on the expression specified.
    
    Parameters:
    
    expressionLanguage - The expression lanaguage.
    
    expression - The expression to return a list of Layouts.
    
    Returns:
    
    The list of Layouts that matches the expression specified.
    
    Throws:
    
    LayoutException - The LayoutException is thrown if error information is found in the specified ShowLayoutDataArea. This will represent that there was a problem when performing the operation.
  - getPage
```
public ShowPageType getPage(GetPageType aGetPage)
```
    This method will communicate with the PageLayout facade and send the specified GetPage. request.
    
    Parameters:
    
    aGetPage - The GetPage request document.
    
    Returns:
    
    The resulting ShowPage response document.
  - processPage
```
public AcknowledgePageType processPage(ProcessPageType aProcessPage)
                                throws PageException
```
    This method will communicate with the PageLayout facade and send the specified ProcessPage request.
    
    Parameters:
    
    aProcessPage - The ProcessPage request document.
    
    Returns:
    
    The resulting AcknowledgePage response document.
    
    Throws:
    
    PageException - If there are any errors in the response.
  - changePage
```
public RespondPageType changePage(ChangePageType aChangePage)
                           throws PageException
```
    This method will communicate with the Page facade and send the specified ChangePage request.
    
    Parameters:
    
    aChangePage - The ChangePage request document.
    
    Returns:
    
    The resulting RespondPage response document.
    
    Throws:
    
    PageException - If there are any errors in the response.
  - checkAcknowledgePage
```
protected AcknowledgePageDataAreaType checkAcknowledgePage(AcknowledgePageDataAreaType acknowledgePageDataArea)
                                                    throws PageException
```
    This method will examine the AcknowledgePageDataArea to see if there is any error information reported. If there is, then the PageException will be thrown to represent the error. This method should be used by those methods that are performing a Process operation on a single Page.
    
    Parameters:
    
    acknowledgePageDataArea - The acknowledge Page data area to inspect.
    
    Returns:
    
    The specified AcknowledgePageDataArea if no error information is found.
    
    Throws:
    
    PageException - The PageException is thrown if error information is found in the specified AcknowledgePageDataArea. This will represent that there was a problem when performing the operation.
  - checkRespondPage
```
protected RespondPageDataAreaType checkRespondPage(RespondPageDataAreaType respondPageDataArea)
                                            throws PageException
```
    This method will examine the RespondPageDataArea to see if there is any error information reported. If there is, then the PageException will be thrown to represent the error. This method should be used by those methods that are performing a Process operation on a single Page.
    
    Parameters:
    
    respondPageDataArea - The respond Page data area to inspect.
    
    Returns:
    
    The specified RespondPageDataArea if no error information is found.
    
    Throws:
    
    PageException - The PageException is thrown if error information is found in the specified RespondPageDataArea. This will represent that there was a problem when performing the operation.
  - checkShowPage
```
protected ShowPageDataAreaType checkShowPage(ShowPageDataAreaType showPageDataArea)
                                      throws PageException
```
    This method will examine the ShowPageDataArea to see if there is any error information reported. If there is, then the PageException will be thrown to represent the error. This method should be used by those methods that are performing a Process operation on a single Page.
    
    Parameters:
    
    showPageDataArea - The show Page data area to inspect.
    
    Returns:
    
    The specified ShowPageDataArea if no error information is found.
    
    Throws:
    
    PageException - The PageException is thrown if error information is found in the specified ShowPageDataArea. This will represent that there was a problem when performing the operation.
  - getPage
```
public ShowPageDataAreaType getPage(GetType getVerb)
                             throws PageException
```
    This method returns the ShowPageDataArea when issuing the specified get expression to fetch Pages. This method will be used by other framworks or methods that constructs the get expression.
    
    Parameters:
    
    getVerb - The get expression to execute.
    
    Returns:
    
    The ShowPageDataArea response when issuing the get expression.
    
    Throws:
    
    PageException - The PageException is thrown if error information is found in the specified ShowPageDataArea. This will represent that there was a problem when performing the operation.
  - getPage
```
public java.util.List getPage(java.lang.String expressionLanguage,
                     java.lang.String expression)
                       throws PageException
```
    This method returns a list of Pages based on the expression specified.
    
    Parameters:
    
    expressionLanguage - The expression lanaguage.
    
    expression - The expression to return a list of Pages.
    
    Returns:
    
    The list of Pages that matches the expression specified.
    
    Throws:
    
    PageException - The PageException is thrown if error information is found in the specified ShowPageDataArea. This will represent that there was a problem when performing the operation.
  - getPageDesign
```
public ShowPageDesignType getPageDesign(GetPageDesignType aGetPageDesign)
```
    This method will communicate with the PageLayout facade and send the specified GetPageDesign. request.
    
    Parameters:
    
    aGetPageDesign - The GetPageDesign request document.
    
    Returns:
    
    The resulting ShowPageDesign response document.
  - checkShowPageDesign
```
protected ShowPageDesignDataAreaType checkShowPageDesign(ShowPageDesignDataAreaType showPageDesignDataArea)
                                                  throws PageDesignException
```
    This method will examine the ShowPageDesignDataArea to see if there is any error information reported. If there is, then the PageDesignException will be thrown to represent the error. This method should be used by those methods that are performing a Process operation on a single PageDesign.
    
    Parameters:
    
    showPageDesignDataArea - The show PageDesign data area to inspect.
    
    Returns:
    
    The specified ShowPageDesignDataArea if no error information is found.
    
    Throws:
    
    PageDesignException - The PageDesignException is thrown if error information is found in the specified ShowPageDesignDataArea. This will represent that there was a problem when performing the operation.
  - getPageDesign
```
public ShowPageDesignDataAreaType getPageDesign(GetType getVerb)
                                         throws PageDesignException
```
    This method returns the ShowPageDesignDataArea when issuing the specified get expression to fetch PageDesigns. This method will be used by other framworks or methods that constructs the get expression.
    
    Parameters:
    
    getVerb - The get expression to execute.
    
    Returns:
    
    The ShowPageDesignDataArea response when issuing the get expression.
    
    Throws:
    
    PageDesignException - The PageDesignException is thrown if error information is found in the specified ShowPageDesignDataArea. This will represent that there was a problem when performing the operation.
  - getPageDesign
```
public java.util.List getPageDesign(java.lang.String expressionLanguage,
                           java.lang.String expression)
                             throws PageDesignException
```
    This method returns a list of PageDesigns based on the expression specified.
    
    Parameters:
    
    expressionLanguage - The expression lanaguage.
    
    expression - The expression to return a list of PageDesigns.
    
    Returns:
    
    The list of PageDesigns that matches the expression specified.
    
    Throws:
    
    PageDesignException - The PageDesignException is thrown if error information is found in the specified ShowPageDesignDataArea. This will represent that there was a problem when performing the operation.
  - getWidgetDefinition
```
public ShowWidgetDefinitionType getWidgetDefinition(GetWidgetDefinitionType aGetWidgetDefinition)
```
    This method will communicate with the PageLayout facade and send the specified GetWidgetDefinition. request.
    
    Parameters:
    
    aGetWidgetDefinition - The GetWidgetDefinition request document.
    
    Returns:
    
    The resulting ShowWidgetDefinition response document.
  - checkShowWidgetDefinition
```
protected ShowWidgetDefinitionDataAreaType checkShowWidgetDefinition(ShowWidgetDefinitionDataAreaType showWidgetDefinitionDataArea)
                                                              throws WidgetDefinitionException
```
    This method will examine the ShowWidgetDefinitionDataArea to see if there is any error information reported. If there is, then the WidgetDefinitionException will be thrown to represent the error. This method should be used by those methods that are performing a Process operation on a single WidgetDefinition.
    
    Parameters:
    
    showWidgetDefinitionDataArea - The show WidgetDefinition data area to inspect.
    
    Returns:
    
    The specified ShowWidgetDefinitionDataArea if no error information is found.
    
    Throws:
    
    WidgetDefinitionException - The WidgetDefinitionException is thrown if error information is found in the specified ShowWidgetDefinitionDataArea. This will represent that there was a problem when performing the operation.
  - getWidgetDefinition
```
public ShowWidgetDefinitionDataAreaType getWidgetDefinition(GetType getVerb)
                                                     throws WidgetDefinitionException
```
    This method returns the ShowWidgetDefinitionDataArea when issuing the specified get expression to fetch WidgetDefinitions. This method will be used by other framworks or methods that constructs the get expression.
    
    Parameters:
    
    getVerb - The get expression to execute.
    
    Returns:
    
    The ShowWidgetDefinitionDataArea response when issuing the get expression.
    
    Throws:
    
    WidgetDefinitionException - The WidgetDefinitionException is thrown if error information is found in the specified ShowWidgetDefinitionDataArea. This will represent that there was a problem when performing the operation.
  - getWidgetDefinition
```
public java.util.List getWidgetDefinition(java.lang.String expressionLanguage,
                                 java.lang.String expression)
                                   throws WidgetDefinitionException
```
    This method returns a list of WidgetDefinitions based on the expression specified.
    
    Parameters:
    
    expressionLanguage - The expression language.
    
    expression - The expression to return a list of WidgetDefinitions.
    
    Returns:
    
    The list of WidgetDefinitions that matches the expression specified.
    
    Throws:
    
    WidgetDefinitionException - The WidgetDefinitionException is thrown if error information is found in the specified ShowWidgetDefinitionDataArea. This will represent that there was a problem when performing the operation.

Class AbstractPageLayoutFacadeClient

Field Summary

Fields inherited from class com.ibm.commerce.foundation.client.facade.bod.AbstractBusinessObjectDocumentFacadeClient

Constructor Summary

Method Summary

Methods inherited from class com.ibm.commerce.foundation.client.facade.bod.AbstractBusinessObjectDocumentFacadeClient

Methods inherited from class java.lang.Object

Constructor Detail

AbstractPageLayoutFacadeClient

AbstractPageLayoutFacadeClient

Method Detail

getPageLayoutFactory

getLayout

processLayout

changeLayout

checkAcknowledgeLayout

checkRespondLayout

checkShowLayout

getLayout

getLayout

getPage

processPage

changePage

checkAcknowledgePage

checkRespondPage

checkShowPage

getPage

getPage

getPageDesign

checkShowPageDesign

getPageDesign

getPageDesign

getWidgetDefinition

checkShowWidgetDefinition

getWidgetDefinition

getWidgetDefinition