public class PageLayoutFacadeClient extends AbstractPageLayoutFacadeClient
This class provides common methods that this and other utility class to the PageLayout facade can use. This class also provides a set of convenient Java API to represent particular PageLayout operations. This set of Java API also include APIs for Web based requests to transform the name value pair request into the appropriate request documents.
Constructor and Description |
---|
PageLayoutFacadeClient()
Creates an instance of the client to communicate with the PageLayout facade.
|
PageLayoutFacadeClient(BusinessContextType businessContext, javax.security.auth.callback.CallbackHandler callbackHandler)
Creates an instance of the client to communicate with the PageLayout facade.
|
Modifier and Type | Method and Description |
---|---|
java.util.List<LayoutType> | createLayouts(java.util.List<LayoutType> layouts)
This method creates a given list of Layouts by invoking the ProcessLayout service.
|
java.util.List<PageType> | createPages(java.util.List<PageType> pages)
This method creates a given list of Pages by invoking the ProcessPage service.
|
java.util.List<LayoutType> | fetchAllLayouts(java.lang.String accessProfile, boolean isTemplate)
This method returns either all Layouts or all Layout Templates for the current store path & site based on the given isTemplate flag.
|
java.util.List<PageType> | fetchAllPages(java.lang.String accessProfile, java.lang.String dataLanguageIDs)
This method fetches all the Pages for the current store path as well as the site.
|
java.util.List<PageType> | fetchAllURLConfigurablePages(java.lang.String isURLConfigurable, java.lang.String accessProfile, java.lang.String dataLanguageIDs)
This method fetches all the URL configurable Pages for the current store path as well as the site.
|
java.util.Map<java.lang.String,java.util.Map<java.lang.String,LayoutType>> | fetchDefaultLayoutsByLayoutGroups(java.util.Set<java.lang.String> layoutGroups, java.util.Set<java.lang.String> deviceClasses, java.lang.String accessProfile)
This method fetches default Layouts by Layout Groups & Device Classes.
|
java.util.List<LayoutType> | fetchLayoutsById(java.util.List<java.lang.String> uniqueIdList, java.lang.String accessProfile)
This method returns the layouts with given Unique Ids in the current store.
|
java.util.Map<java.lang.String,LayoutType> | fetchLayoutsByNamesForStore(java.util.Set<java.lang.String> names, java.lang.String storeId, java.lang.String accessProfile)
This method fetches Layout nouns by names for a given Store ID.
|
java.util.List<LayoutType> | fetchLayoutsByPage(java.lang.String pageGroup, java.lang.String pageId, java.lang.String accessProfile)
This method returns all the applicable layouts for the given Page Group and Page Id in the current store.
|
java.util.List | fetchLayoutTemplatesByDeviceClass(java.lang.String deviceClass, java.lang.String accessProfile)
This method returns the list of Layout templates by device type.
|
PageDesignType | fetchPageDesign(java.lang.String pageGroup, java.lang.String objectIdentifier, java.lang.String deviceClass, java.lang.String accessProfile, java.util.Map<java.lang.String,java.lang.String> controlParams)
This method fetches a Page Design for the given Page Group and the Object Identifier of the Object being rendered in the Store Page.
|
java.util.List<PageType> | fetchPagesById(java.util.List<java.lang.String> uniqueIdList, java.lang.String accessProfile, java.lang.String dataLanguageIDs)
This method returns the pages with given Unique Ids in the current store path.
|
java.util.List<PageType> | fetchPagesByNames(java.util.List<java.lang.String> pageNames, java.lang.String accessProfile)
This method returns the pages with given names for the current store path & site
|
java.util.Map<java.lang.String,PageType> | fetchPagesByNamesForStore(java.util.Set<java.lang.String> names, java.lang.String storeId, java.lang.String accessProfile, java.lang.String dataLanguageIDs)
This method fetches Page nouns by names for a given Store ID.
|
java.util.List<PageType> | fetchPagesByPageGroup(java.lang.String pageGroup, java.lang.String accessProfile, java.lang.String dataLanguageIDs)
This method returns a list of Page nouns fetching by page group.
|
java.util.List | getWidgetDefinitionByIdentifier(java.lang.String widgetIdentifier, java.lang.String accessProfile)
This method returns the widget definition based on the widgets external identifier.
|
java.util.List | getWidgetDefinitionByUniqueId(java.lang.String widgetId, java.lang.String accessProfile)
This method returns the widget definition based on the widgets uniqueId.
|
java.util.List<WidgetDefinitionType> | getWidgetDefinitionByUniqueIds(java.util.List<java.lang.String> widgetId, java.lang.String accessProfile)
This method returns the widget definition based on the widgets uniqueId.
|
java.util.List<LayoutType> | searchLayouts(java.lang.String name, java.lang.String accessProfile, java.util.Map<java.lang.String,java.lang.String> controlParams)
This method returns a list of Layout nouns that satisfies the search criteria.
|
java.util.Map<java.lang.String,PageType> | searchPagesByName(java.lang.String name, java.lang.String accessProfile, java.lang.String dataLanguageIDs)
This method returns a Map of Page nouns with the Page name as the key.
|
public PageLayoutFacadeClient()
public PageLayoutFacadeClient(BusinessContextType businessContext, javax.security.auth.callback.CallbackHandler callbackHandler)
public java.util.List<PageType> fetchPagesById(java.util.List<java.lang.String> uniqueIdList, java.lang.String accessProfile, java.lang.String dataLanguageIDs) throws PageException
public java.util.List<PageType> fetchPagesByNames(java.util.List<java.lang.String> pageNames, java.lang.String accessProfile) throws PageException
public java.util.Map<java.lang.String,PageType> fetchPagesByNamesForStore(java.util.Set<java.lang.String> names, java.lang.String storeId, java.lang.String accessProfile, java.lang.String dataLanguageIDs) throws PageException
public java.util.List<PageType> fetchAllPages(java.lang.String accessProfile, java.lang.String dataLanguageIDs) throws PageException
public java.util.List<PageType> fetchAllURLConfigurablePages(java.lang.String isURLConfigurable, java.lang.String accessProfile, java.lang.String dataLanguageIDs) throws PageException
public java.util.List<PageType> fetchPagesByPageGroup(java.lang.String pageGroup, java.lang.String accessProfile, java.lang.String dataLanguageIDs) throws PageException
public java.util.Map<java.lang.String,PageType> searchPagesByName(java.lang.String name, java.lang.String accessProfile, java.lang.String dataLanguageIDs) throws PageException
public java.util.List<PageType> createPages(java.util.List<PageType> pages) throws PageException
public java.util.List<LayoutType> fetchAllLayouts(java.lang.String accessProfile, boolean isTemplate) throws LayoutException
public java.util.List<LayoutType> fetchLayoutsById(java.util.List<java.lang.String> uniqueIdList, java.lang.String accessProfile) throws LayoutException
public java.util.List<LayoutType> fetchLayoutsByPage(java.lang.String pageGroup, java.lang.String pageId, java.lang.String accessProfile) throws LayoutException
public java.util.List fetchLayoutTemplatesByDeviceClass(java.lang.String deviceClass, java.lang.String accessProfile) throws LayoutException
public java.util.Map<java.lang.String,LayoutType> fetchLayoutsByNamesForStore(java.util.Set<java.lang.String> names, java.lang.String storeId, java.lang.String accessProfile) throws LayoutException
public java.util.Map<java.lang.String,java.util.Map<java.lang.String,LayoutType>> fetchDefaultLayoutsByLayoutGroups(java.util.Set<java.lang.String> layoutGroups, java.util.Set<java.lang.String> deviceClasses, java.lang.String accessProfile) throws LayoutException
public java.util.List<LayoutType> searchLayouts(java.lang.String name, java.lang.String accessProfile, java.util.Map<java.lang.String,java.lang.String> controlParams) throws LayoutException
public java.util.List<LayoutType> createLayouts(java.util.List<LayoutType> layouts) throws LayoutException
public java.util.List getWidgetDefinitionByUniqueId(java.lang.String widgetId, java.lang.String accessProfile) throws WidgetDefinitionException
public java.util.List getWidgetDefinitionByIdentifier(java.lang.String widgetIdentifier, java.lang.String accessProfile) throws WidgetDefinitionException
public java.util.List<WidgetDefinitionType> getWidgetDefinitionByUniqueIds(java.util.List<java.lang.String> widgetId, java.lang.String accessProfile) throws WidgetDefinitionException
public PageDesignType fetchPageDesign(java.lang.String pageGroup, java.lang.String objectIdentifier, java.lang.String deviceClass, java.lang.String accessProfile, java.util.Map<java.lang.String,java.lang.String> controlParams) throws PageDesignException