com.ibm.commerce.pagelayout.facade.client

Class 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

Modifier and Type	Method and Description
com.ibm.commerce.pagelayout.facade.datatypes.RespondLayoutType	changeLayout(com.ibm.commerce.pagelayout.facade.datatypes.ChangeLayoutType aChangeLayout) This method will communicate with the Layout facade and send the specified ChangeLayout request.
com.ibm.commerce.pagelayout.facade.datatypes.RespondPageType	changePage(com.ibm.commerce.pagelayout.facade.datatypes.ChangePageType aChangePage) This method will communicate with the Page facade and send the specified ChangePage request.
com.ibm.commerce.pagelayout.facade.datatypes.ShowLayoutType	getLayout(com.ibm.commerce.pagelayout.facade.datatypes.GetLayoutType aGetLayout) This method will communicate with the PageLayout facade and send the specified GetLayout.
com.ibm.commerce.pagelayout.facade.datatypes.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.
com.ibm.commerce.pagelayout.facade.datatypes.ShowPageType	getPage(com.ibm.commerce.pagelayout.facade.datatypes.GetPageType aGetPage) This method will communicate with the PageLayout facade and send the specified GetPage.
com.ibm.commerce.pagelayout.facade.datatypes.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.
com.ibm.commerce.pagelayout.facade.datatypes.ShowPageDesignType	getPageDesign(com.ibm.commerce.pagelayout.facade.datatypes.GetPageDesignType aGetPageDesign) This method will communicate with the PageLayout facade and send the specified GetPageDesign.
com.ibm.commerce.pagelayout.facade.datatypes.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.
com.ibm.commerce.pagelayout.facade.datatypes.ShowWidgetDefinitionDataAreaType	getWidgetDefinition(GetType getVerb) This method returns the ShowWidgetDefinitionDataArea when issuing the specified get expression to fetch WidgetDefinitions.
com.ibm.commerce.pagelayout.facade.datatypes.ShowWidgetDefinitionType	getWidgetDefinition(com.ibm.commerce.pagelayout.facade.datatypes.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.
com.ibm.commerce.pagelayout.facade.datatypes.AcknowledgeLayoutType	processLayout(com.ibm.commerce.pagelayout.facade.datatypes.ProcessLayoutType aProcessLayout) This method will communicate with the PageLayout facade and send the specified ProcessLayout request.
com.ibm.commerce.pagelayout.facade.datatypes.AcknowledgePageType	processPage(com.ibm.commerce.pagelayout.facade.datatypes.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

Methods inherited from class java.lang.Object

equals, 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

getLayout

public com.ibm.commerce.pagelayout.facade.datatypes.ShowLayoutType getLayout(com.ibm.commerce.pagelayout.facade.datatypes.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 com.ibm.commerce.pagelayout.facade.datatypes.AcknowledgeLayoutType processLayout(com.ibm.commerce.pagelayout.facade.datatypes.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 com.ibm.commerce.pagelayout.facade.datatypes.RespondLayoutType changeLayout(com.ibm.commerce.pagelayout.facade.datatypes.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.

getLayout

public com.ibm.commerce.pagelayout.facade.datatypes.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 com.ibm.commerce.pagelayout.facade.datatypes.ShowPageType getPage(com.ibm.commerce.pagelayout.facade.datatypes.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 com.ibm.commerce.pagelayout.facade.datatypes.AcknowledgePageType processPage(com.ibm.commerce.pagelayout.facade.datatypes.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 com.ibm.commerce.pagelayout.facade.datatypes.RespondPageType changePage(com.ibm.commerce.pagelayout.facade.datatypes.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.

getPage

public com.ibm.commerce.pagelayout.facade.datatypes.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 com.ibm.commerce.pagelayout.facade.datatypes.ShowPageDesignType getPageDesign(com.ibm.commerce.pagelayout.facade.datatypes.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.

getPageDesign

public com.ibm.commerce.pagelayout.facade.datatypes.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 com.ibm.commerce.pagelayout.facade.datatypes.ShowWidgetDefinitionType getWidgetDefinition(com.ibm.commerce.pagelayout.facade.datatypes.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.

getWidgetDefinition

public com.ibm.commerce.pagelayout.facade.datatypes.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.