com.ibm.commerce.pagelayout.facade.client

Class AbstractExternalPageLayoutFacadeClient

java.lang.Object

com.ibm.commerce.foundation.client.facade.bod.AbstractBusinessObjectDocumentFacadeClient

com.ibm.commerce.pagelayout.facade.client.AbstractPageLayoutFacadeClient

com.ibm.commerce.pagelayout.facade.client.AbstractExternalPageLayoutFacadeClient

Direct Known Subclasses:

ExternalPageLayoutFacadeClient

public abstract class AbstractExternalPageLayoutFacadeClient
extends AbstractPageLayoutFacadeClient

This class provides a set of methods that can be used to communicate with the PageLayout facade running on an external system.

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.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
AbstractExternalPageLayoutFacadeClient() Creates an instance of the client to communicate with the ExternalPageLayout facade.
AbstractExternalPageLayoutFacadeClient(BusinessContextType businessContext, javax.security.auth.callback.CallbackHandler callbackHandler) Creates an instance of the client to communicate with the ExternalPageLayout 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 ExternalLayout 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 ExternalPage 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 ExternalPageLayout facade and send the specified GetLayout.
com.ibm.commerce.pagelayout.facade.datatypes.ShowPageType	getPage(com.ibm.commerce.pagelayout.facade.datatypes.GetPageType aGetPage) This method will communicate with the ExternalPageLayout facade and send the specified GetPage.
com.ibm.commerce.pagelayout.facade.datatypes.ShowPageDesignType	getPageDesign(com.ibm.commerce.pagelayout.facade.datatypes.GetPageDesignType aGetPageDesign) This method will communicate with the ExternalPageLayout facade and send the specified GetPageDesign.
com.ibm.commerce.pagelayout.facade.datatypes.ShowWidgetDefinitionType	getWidgetDefinition(com.ibm.commerce.pagelayout.facade.datatypes.GetWidgetDefinitionType aGetWidgetDefinition) This method will communicate with the ExternalPageLayout facade and send the specified GetWidgetDefinition.
com.ibm.commerce.pagelayout.facade.datatypes.AcknowledgeLayoutType	processLayout(com.ibm.commerce.pagelayout.facade.datatypes.ProcessLayoutType aProcessLayout) This method will communicate with the ExternalPageLayout 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 ExternalPageLayout facade and send the specified ProcessPage request.

Methods inherited from class com.ibm.commerce.pagelayout.facade.client.AbstractPageLayoutFacadeClient

getLayout, getLayout, getPage, getPage, getPageDesign, getPageDesign, getWidgetDefinition, getWidgetDefinition

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

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

copyright

See Also:

Constant Field Values

Constructor Detail

AbstractExternalPageLayoutFacadeClient

public AbstractExternalPageLayoutFacadeClient()

Creates an instance of the client to communicate with the ExternalPageLayout facade.

AbstractExternalPageLayoutFacadeClient

public AbstractExternalPageLayoutFacadeClient(BusinessContextType businessContext,
                                              javax.security.auth.callback.CallbackHandler callbackHandler)

Creates an instance of the client to communicate with the ExternalPageLayout 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 ExternalPageLayout facade and send the specified GetLayout. request.

Overrides:

getLayout in class AbstractPageLayoutFacadeClient

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)

This method will communicate with the ExternalPageLayout facade and send the specified ProcessLayout request.

Overrides:

processLayout in class AbstractPageLayoutFacadeClient

Parameters:

aProcessLayout - The ProcessLayout request document.

Returns:

The resulting AcknowledgeLayout response document.

changeLayout

public com.ibm.commerce.pagelayout.facade.datatypes.RespondLayoutType changeLayout(com.ibm.commerce.pagelayout.facade.datatypes.ChangeLayoutType aChangeLayout)

This method will communicate with the ExternalLayout facade and send the specified ChangeLayout request.

Overrides:

changeLayout in class AbstractPageLayoutFacadeClient

Parameters:

aChangeLayout - The ChangeLayout request document.

Returns:

The resulting RespondLayout response document.

getPage

public com.ibm.commerce.pagelayout.facade.datatypes.ShowPageType getPage(com.ibm.commerce.pagelayout.facade.datatypes.GetPageType aGetPage)

This method will communicate with the ExternalPageLayout facade and send the specified GetPage. request.

Overrides:

getPage in class AbstractPageLayoutFacadeClient

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)

This method will communicate with the ExternalPageLayout facade and send the specified ProcessPage request.

Overrides:

processPage in class AbstractPageLayoutFacadeClient

Parameters:

aProcessPage - The ProcessPage request document.

Returns:

The resulting AcknowledgePage response document.

changePage

public com.ibm.commerce.pagelayout.facade.datatypes.RespondPageType changePage(com.ibm.commerce.pagelayout.facade.datatypes.ChangePageType aChangePage)

This method will communicate with the ExternalPage facade and send the specified ChangePage request.

Overrides:

changePage in class AbstractPageLayoutFacadeClient

Parameters:

aChangePage - The ChangePage request document.

Returns:

The resulting RespondPage response document.

getPageDesign

public com.ibm.commerce.pagelayout.facade.datatypes.ShowPageDesignType getPageDesign(com.ibm.commerce.pagelayout.facade.datatypes.GetPageDesignType aGetPageDesign)

This method will communicate with the ExternalPageLayout facade and send the specified GetPageDesign. request.

Overrides:

getPageDesign in class AbstractPageLayoutFacadeClient

Parameters:

aGetPageDesign - The GetPageDesign request document.

Returns:

The resulting ShowPageDesign response document.

getWidgetDefinition

public com.ibm.commerce.pagelayout.facade.datatypes.ShowWidgetDefinitionType getWidgetDefinition(com.ibm.commerce.pagelayout.facade.datatypes.GetWidgetDefinitionType aGetWidgetDefinition)

This method will communicate with the ExternalPageLayout facade and send the specified GetWidgetDefinition. request.

Overrides:

getWidgetDefinition in class AbstractPageLayoutFacadeClient

Parameters:

aGetWidgetDefinition - The GetWidgetDefinition request document.

Returns:

The resulting ShowWidgetDefinition response document.