lumis.portal.serviceinterfaceinstance

Interface IServiceInterfaceInstanceManagerSPI

All Superinterfaces:

IConfigKeyChecker, IServiceInterfaceInstanceManager

All Known Implementing Classes:

ServiceInterfaceInstanceManager

public interface IServiceInterfaceInstanceManagerSPI
extends IServiceInterfaceInstanceManager, IConfigKeyChecker

Service Provider Interface for the ServiceInterfaceInstanceManager. This interface contains methods that should not be accessible to the solutions, restricting its methods solely to the portal.

Since:

7.0.0

Version:

$Revision: 21880 $ $Date: 2018-09-21 20:07:19 +0000 (Fri, 21 Sep 2018) $

Method Summary

Modifier and Type	Method and Description
void	clearHtmlCache(String serviceInterfaceInstanceId) Clears the HTML cache of a service interface instance.
void	clearInterfaceInstanceCacheKeyProviderCache() Clears the cache for interface instance cache key provider classes.
void	clearTimeoutCache(String serviceInterfaceInstanceId, ITransaction transaction) Clears the cache for the timeout cache value.
String	generateMenu(Node menuDefinition, IMenuItemParser menuItemParser, Element defaultMenu) Generates a configuration menu XML definition for use by Portal Studio.
Collection<String>	getIdsByBaseServiceInterfaceInstance(SessionConfig sessionConfig, String serviceInterfaceInstanceId, ITransaction transaction) Returns the identifiers of derived interface instances that derives from the interface instance with the given identifier.
ServiceInterfaceInstanceCacheEntry	getInterfaceInstanceHtmlCache(String serviceInterfaceInstanceId, IServiceInterfaceRenderRequest request, ITransaction transaction) Get the HTML Cache of the Interface Instance.
String	getMenuItemXml(SessionConfig sessionConfig, String serviceInterfaceInstanceId, ServiceInterfaceMenuLevel menuLevel, String menuItemId, ITransaction transaction) Returns the XML for the menu item in the specified service interface instance and menu level.
void	setInterfaceInstanceHtmlCache(String serviceInterfaceInstanceId, IServiceInterfaceRenderRequest request, String serviceInterfaceInstanceHtml, Map<PortalPrintWriter.WritePosition,LinkedHashMap<String,String>> headWrites, ITransaction transaction) Set the HTML Cache of the Interface Instance.

Methods inherited from interface lumis.portal.serviceinterfaceinstance.IServiceInterfaceInstanceManager

add, addOrUpdate, clearCache, clearCache, copy, delete, deleteCustomProperties, deleteCustomProperty, deserialize, deserializeCustomProperties, get, getCacheLevel, getCachePersonalization, getCacheServerSideInclude, getCustomProperties, getCustomProperty, getDisplayName, getEnableCache, getIdsByPageId, getIdsByServiceInstanceId, getIdsByServiceInstanceId, getIdsByServiceInterfaceId, getIdsByServiceInterfaceId, getIdsByServiceInterfaceIdAndServiceInstanceId, getIdsByServiceInterfaceIdAndServiceInstanceId, getIdsByServiceInterfaceStyleId, getInterfaceInstanceHtmlCache, getMenu, getMenuXml, getOrAddServiceInterfaceRunTimeInstance, getPrintable, getRenderAs, getServiceInterfaceInstanceStyleConfigKeyChecker, getTitle, getXmlData, serialize, serializeCustomProperties, setCustomProperties, setCustomProperty, setInterfaceInstanceHtmlCache, update, updateCustomPropertiesFromTemplate, updatePropertiesFromTemplate

Methods inherited from interface lumis.portal.serialization.operation.IConfigKeyChecker

keyExists

Method Detail

setInterfaceInstanceHtmlCache

void setInterfaceInstanceHtmlCache(String serviceInterfaceInstanceId,
                                   IServiceInterfaceRenderRequest request,
                                   String serviceInterfaceInstanceHtml,
                                   Map<PortalPrintWriter.WritePosition,LinkedHashMap<String,String>> headWrites,
                                   ITransaction transaction)
                            throws BusinessContextNotEnabledForCurrentChannelException,
                                   BusinessContextPropertyNotFoundException,
                                   CacheKeyProviderClassNotFoundException,
                                   PortalException

Set the HTML Cache of the Interface Instance.

Parameters:

serviceInterfaceInstanceId - the id of the cache that should be used.

request - the request from which the cache key will be extracted.

serviceInterfaceInstanceHtml - html to cache.

headWrites - the head before writes to be cached.

transaction - in which the method should participate.

Throws:

BusinessContextNotEnabledForCurrentChannelException - if the business context has not been enabled/selected in the serviceInterfaceInstance channel.

BusinessContextPropertyNotFoundException - if the property to use as cache was not found in the current BusinessContext.

CacheKeyProviderClassNotFoundException - if IInterfaceInstanceCacheKeyProvider implementation class is not available during runtime.

PortalException

getInterfaceInstanceHtmlCache

ServiceInterfaceInstanceCacheEntry getInterfaceInstanceHtmlCache(String serviceInterfaceInstanceId,
                                                                 IServiceInterfaceRenderRequest request,
                                                                 ITransaction transaction)
                                                          throws BusinessContextNotEnabledForCurrentChannelException,
                                                                 BusinessContextPropertyNotFoundException,
                                                                 CacheKeyProviderClassNotFoundException,
                                                                 PortalException

Get the HTML Cache of the Interface Instance.

Parameters:

serviceInterfaceInstanceId - the id of the cache that should be used.

request - the request from which the cache key will be extracted.

transaction - in which the method should participate.

Returns:

the cached html for the service interface instance.

Throws:

BusinessContextNotEnabledForCurrentChannelException - if the business context has not been enabled/selected in the serviceInterfaceInstance channel.

BusinessContextPropertyNotFoundException - if the property to use as cache was not found in the current BusinessContext.

CacheKeyProviderClassNotFoundException - if IInterfaceInstanceCacheKeyProvider implementation class is not available during runtime.

PortalException

clearTimeoutCache

void clearTimeoutCache(String serviceInterfaceInstanceId,
                       ITransaction transaction)
                throws PortalException

Clears the cache for the timeout cache value.

Parameters:

serviceInterfaceInstanceId - of which the timeout has changed.

transaction - in which the method should participate.

Throws:

PortalException

Since:

7.0.0

clearHtmlCache

void clearHtmlCache(String serviceInterfaceInstanceId)
             throws PortalException

Clears the HTML cache of a service interface instance.

Parameters:

serviceInterfaceInstanceId - the service interface instance identifier.

Throws:

PortalException

Since:

8.0.1

generateMenu

String generateMenu(Node menuDefinition,
                    IMenuItemParser menuItemParser,
                    Element defaultMenu)
             throws PortalException

Generates a configuration menu XML definition for use by Portal Studio.

Parameters:

menuDefinition - the menu to be included.

menuItemParser - the parser is able to process menu items.

defaultMenu - the default menu definition.

Returns:

the menu XML.

Throws:

PortalException - if the menu cannot be generated.

Since:

8.2.0

clearInterfaceInstanceCacheKeyProviderCache

void clearInterfaceInstanceCacheKeyProviderCache()

Clears the cache for interface instance cache key provider classes.

Since:

10.0.0

getMenuItemXml

String getMenuItemXml(SessionConfig sessionConfig,
                      String serviceInterfaceInstanceId,
                      ServiceInterfaceMenuLevel menuLevel,
                      String menuItemId,
                      ITransaction transaction)
               throws PortalException

Returns the XML for the menu item in the specified service interface instance and menu level.

Parameters:

sessionConfig - the user session information.

serviceInterfaceInstanceId - the identifier of the service interface instance.

menuLevel - the menu level.

menuItemId - the menu item identifier.

transaction - transaction for persistence access.

Returns:

a XML with the menu item.

Throws:

PortalException

Since:

10.2.0

getIdsByBaseServiceInterfaceInstance

Collection<String> getIdsByBaseServiceInterfaceInstance(SessionConfig sessionConfig,
                                                        String serviceInterfaceInstanceId,
                                                        ITransaction transaction)
                                                 throws PortalException

Returns the identifiers of derived interface instances that derives from the interface instance with the given identifier.

Parameters:

sessionConfig - the user session.

serviceInterfaceInstanceId - the base interface instance identifier.

transaction - the transaction.

Returns:

the identifiers of derived interface instances that derives from the interface instance with the given identifier.

Throws:

PortalException

Since:

11.0.0