Package lumis.portal.serviceinterfaceinstance

Interface IServiceInterfaceInstanceManager

All Known Subinterfaces:

IServiceInterfaceInstanceManagerSPI

All Known Implementing Classes:

ServiceInterfaceInstanceManager

@StableMinor(version="14.2",
             sinceVersion="4.0")
public interface IServiceInterfaceInstanceManager

Interface definition for manager of service interface instances.

Since:

4.0.0

Version:

$Revision: 24985 $ $Date: 2022-05-02 23:04:30 -0300 (Mon, 02 May 2022) $

Method Summary

Modifier and Type	Method	Description
String	add(SessionConfig sessionConfig, ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig, ITransaction transaction)	Add a service interface instance.
void	addOrUpdate(SessionConfig sessionConfig, ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig, ITransaction transaction)	Add or Update a Service Interface Instance, depending on its previous existence.
void	clearCache(SessionConfig sessionConfig, String serviceInterfaceInstanceId, ITransaction transaction)	Clears the caches of a service interface instance.
void	clearCache(ITransaction transaction)	Clears all cache stored in this manager.
String	copy(SessionConfig sessionConfig, String sourceServiceInterfaceInstanceId, String destinationPageId, boolean destinationInterfaceInstanceIsFromTemplate, ITransaction transaction)	Creates a copy of the given interface instance to the specified page.
void	delete(SessionConfig sessionConfig, String serviceInterfaceInstanceId, ITransaction transaction)	Delete a service interface instance.
void	deleteCustomProperties(SessionConfig sessionConfig, String interfaceInstanceId, ITransaction transaction)	Deletes all the interface instance custom properties
void	deleteCustomProperty(SessionConfig sessionConfig, String interfaceInstanceId, String name, ITransaction transaction)	Deletes the interface instance custom property
String	deserialize(SessionConfig sessionConfig, DeserializationConfig deserializationConfig, Node serviceInterfaceInstanceNode, ITransaction transaction)
void	deserializeCustomProperties(SessionConfig sessionConfig, DeserializationConfig deserializationConfig, Node serviceInterfaceInstanceCustomPropertiesNode, ITransaction transaction)	Deprecated. Since 6.2.0 this method is no longer used and may be removed in a future version.
ServiceInterfaceInstanceConfig	get(SessionConfig sessionConfig, String serviceInterfaceInstanceId, ITransaction transaction)	Get the configuration of the service interface instance.
int	getCacheLevel(SessionConfig sessionConfig, String serviceInterfaceInstanceId, ITransaction transaction)	Returns the cacheLevel property of an interface instance.
int	getCachePersonalization(SessionConfig sessionConfig, String serviceInterfaceInstanceId, ITransaction transaction)	Returns the cachePersonalization property of an interface instance.
boolean	getCacheServerSideInclude(SessionConfig sessionConfig, String serviceInterfaceInstanceId, ITransaction transaction)	Returns the cacheServerSideInclude property of an interface instance.
Map<String,String>	getCustomProperties(SessionConfig sessionConfig, String interfaceInstanceId, ITransaction transaction)	Returns a Map containing all name/value pairs of custom properties from the specified service interface instance.
String	getCustomProperty(SessionConfig sessionConfig, String interfaceInstanceId, String name, ITransaction transaction)	Returns the specified custom property.
String	getDisplayName(ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig, ITransaction transaction)	Returns the display name for a service interface instance.
boolean	getEnableCache(SessionConfig sessionConfig, String serviceInterfaceInstanceId, ITransaction transaction)	Returns the enableCache property of an interface instance.
Collection<String>	getIdsByPageId(SessionConfig sessionConfig, String pageId, ITransaction transaction)	Get a list of ids by passing the page's id.
Collection<String>	getIdsByServiceInstanceId(SessionConfig sessionConfig, String serviceInstanceId, boolean includeRunTimeInterfaces, ITransaction transaction)	Get the Ids given the ServiceInstanceId.
Collection<String>	getIdsByServiceInstanceId(SessionConfig sessionConfig, String serviceInstanceId, ITransaction transaction)	Get a list of ids by passing the id of the service instance.
Collection<String>	getIdsByServiceInterfaceId(SessionConfig sessionConfig, String serviceInterfaceId, boolean ignoreRuntimeInterfaces, boolean ignorePageTemplates, ITransaction transaction)	Get a list of ids by passing the ids of the service interface.
Collection<String>	getIdsByServiceInterfaceId(SessionConfig sessionConfig, String serviceInterfaceId, boolean ignoreRuntimeInterfaces, ITransaction transaction)	Get a list of ids by passing the ids of the service interface.
Collection<String>	getIdsByServiceInterfaceIdAndServiceInstanceId(SessionConfig sessionConfig, String serviceInterfaceId, String serviceInstanceId, boolean ignoreRuntimeInterfaces, boolean ignorePageTemplates, ITransaction transaction)	Get a list of ids by passing the ids of service interface and the service instance.
Collection<String>	getIdsByServiceInterfaceIdAndServiceInstanceId(SessionConfig sessionConfig, String serviceInterfaceId, String serviceInstanceId, boolean ignoreRuntimeInterfaces, ITransaction transaction)	Get a list of ids by passing the ids of service interface and the service instance.
Collection<String>	getIdsByServiceInterfaceStyleId(SessionConfig sessionConfig, String serviceInterfaceStyleId, String serviceInterfaceId, ITransaction transaction)	Get the Ids given the ServiceInterfaceStyleId.
String	getInterfaceInstanceHtmlCache(SessionConfig sessionConfig, String serviceInterfaceInstanceId, Locale locale, ITransaction transaction)	Deprecated. since 7.0.0 deprecated without replacement.
String	getMenu(SessionConfig sessionConfig, String serviceInterfaceInstanceId, ITransaction transaction)	Deprecated. Since 10.2.0 replaced by getMenuXml(SessionConfig, String, ServiceInterfaceMenuLevel, ITransaction).
String	getMenuXml(SessionConfig sessionConfig, String serviceInterfaceInstanceId, ServiceInterfaceMenuLevel menuLevel, ITransaction transaction)	Returns the XML for the menu for the specified service interface instance and menu level.
ServiceInterfaceInstanceConfig	getOrAddServiceInterfaceRunTimeInstance(SessionConfig sessionConfig, String serviceInterfaceId, String serviceInstanceId, String pageId, ITransaction transaction)	Get or Add the ServiceInterfaceRunTimeInstance.
boolean	getPrintable(SessionConfig sessionConfig, String serviceInterfaceInstanceId, ITransaction transaction)	Returns the printable property of an interface instance.
int	getRenderAs(SessionConfig sessionConfig, String serviceInterfaceInstanceId, ITransaction transaction)	Returns the renderAs property of an interface instance.
IConfigKeyChecker	getServiceInterfaceInstanceStyleConfigKeyChecker()
String	getTitle(ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig, ITransaction transaction)	Returns the title for a service interface instance.
String	getXmlData(SessionConfig sessionConfig, String serviceInterfaceInstanceId)	Returns the previously saved XML data for the service interface instance for the given user session
void	serialize(SessionConfig sessionConfig, String serviceInterfaceInstanceId, OutputStream outputStream, ITransaction transaction)
void	serializeCustomProperties(SessionConfig sessionConfig, String serviceInterfaceInstanceId, OutputStream outputStream, ITransaction transaction)
void	setCustomProperties(SessionConfig sessionConfig, String interfaceInstanceId, Map<String,String> propertiesTable, ITransaction transaction)	Receives a Map with one or more properties to be set for the given interface.
void	setCustomProperty(SessionConfig sessionConfig, String interfaceInstanceId, String name, String value, ITransaction transaction)	Set a custom property for the given interface instance.
void	setInterfaceInstanceHtmlCache(SessionConfig sessionConfig, String serviceInterfaceInstanceId, Locale locale, String serviceInterfaceInstanceHtml, ITransaction transaction)	Deprecated. since 7.0.0 deprecated without replacement.
void	update(SessionConfig sessionConfig, ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig, ITransaction transaction)	Update a service interface instance.
void	updateCustomPropertiesFromTemplate(SessionConfig sessionConfig, String interfaceInstanceId, ITransaction transaction)	Update the interface instance custom properties from parent interface instance
void	updatePropertiesFromTemplate(SessionConfig sessionConfig, String interfaceInstanceId, ITransaction transaction)	Update the properties of from the template.

Method Detail

addOrUpdate

void addOrUpdate(SessionConfig sessionConfig,
                 ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig,
                 ITransaction transaction)
          throws ManagerException,
                 PortalException

Add or Update a Service Interface Instance, depending on its previous existence.

Parameters:

sessionConfig -

serviceInterfaceInstanceConfig -

transaction -

Throws:

ManagerException

PortalException

get

ServiceInterfaceInstanceConfig get(SessionConfig sessionConfig,
                                   String serviceInterfaceInstanceId,
                                   ITransaction transaction)
                            throws ManagerException,
                                   PortalException

Get the configuration of the service interface instance.

Parameters:

sessionConfig -

serviceInterfaceInstanceId -

transaction -

Returns:

a ServiceInterfaceInstanceConfig.

Throws:

ManagerException

PortalException

add

String add(SessionConfig sessionConfig,
           ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig,
           ITransaction transaction)
    throws ManagerException,
           PortalException

Add a service interface instance.

Parameters:

sessionConfig -

serviceInterfaceInstanceConfig -

transaction -

Returns:

a String.

Throws:

ManagerException

PortalException

update

void update(SessionConfig sessionConfig,
            ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig,
            ITransaction transaction)
     throws ManagerException,
            PortalException

Update a service interface instance.

Parameters:

sessionConfig -

serviceInterfaceInstanceConfig -

transaction -

Throws:

ManagerException

PortalException

delete

void delete(SessionConfig sessionConfig,
            String serviceInterfaceInstanceId,
            ITransaction transaction)
     throws ManagerException,
            PortalException

Delete a service interface instance.

Parameters:

sessionConfig -

serviceInterfaceInstanceId -

transaction -

Throws:

ManagerException

PortalException

copy

String copy(SessionConfig sessionConfig,
            String sourceServiceInterfaceInstanceId,
            String destinationPageId,
            boolean destinationInterfaceInstanceIsFromTemplate,
            ITransaction transaction)
     throws ManagerException,
            PortalException

Creates a copy of the given interface instance to the specified page. All interface instance custom properties are copied to the new interface instance.

Parameters:

sessionConfig -

sourceServiceInterfaceInstanceId -

destinationPageId -

transaction -

Returns:

a String.

Throws:

ManagerException

PortalException

getOrAddServiceInterfaceRunTimeInstance

ServiceInterfaceInstanceConfig getOrAddServiceInterfaceRunTimeInstance(SessionConfig sessionConfig,
                                                                       String serviceInterfaceId,
                                                                       String serviceInstanceId,
                                                                       String pageId,
                                                                       ITransaction transaction)
                                                                throws ManagerException,
                                                                       PortalException

Get or Add the ServiceInterfaceRunTimeInstance.

Parameters:

sessionConfig -

serviceInterfaceId -

serviceInstanceId -

pageId -

transaction -

Returns:

a ServiceInterfaceInstanceConfig.

Throws:

ManagerException

PortalException

getIdsByServiceInstanceId

Collection<String> getIdsByServiceInstanceId(SessionConfig sessionConfig,
                                             String serviceInstanceId,
                                             ITransaction transaction)
                                      throws ManagerException,
                                             PortalException

Get a list of ids by passing the id of the service instance.

Parameters:

sessionConfig -

serviceInstanceId -

transaction -

Returns:

a array of Strings.

Throws:

ManagerException

PortalException

getIdsByServiceInstanceId

Collection<String> getIdsByServiceInstanceId(SessionConfig sessionConfig,
                                             String serviceInstanceId,
                                             boolean includeRunTimeInterfaces,
                                             ITransaction transaction)
                                      throws ManagerException,
                                             PortalException

Get the Ids given the ServiceInstanceId.

Parameters:

sessionConfig -

serviceInstanceId -

includeRunTimeInterfaces -

transaction -

Returns:

a array of Strings.

Throws:

ManagerException

PortalException

getIdsByServiceInterfaceIdAndServiceInstanceId

Collection<String> getIdsByServiceInterfaceIdAndServiceInstanceId(SessionConfig sessionConfig,
                                                                  String serviceInterfaceId,
                                                                  String serviceInstanceId,
                                                                  boolean ignoreRuntimeInterfaces,
                                                                  ITransaction transaction)
                                                           throws ManagerException,
                                                                  PortalException

Get a list of ids by passing the ids of service interface and the service instance.

Parameters:

sessionConfig -

serviceInterfaceId -

serviceInstanceId -

ignoreRuntimeInterfaces -

transaction -

Returns:

a array of Strings.

Throws:

ManagerException

PortalException

getIdsByServiceInterfaceIdAndServiceInstanceId

Collection<String> getIdsByServiceInterfaceIdAndServiceInstanceId(SessionConfig sessionConfig,
                                                                  String serviceInterfaceId,
                                                                  String serviceInstanceId,
                                                                  boolean ignoreRuntimeInterfaces,
                                                                  boolean ignorePageTemplates,
                                                                  ITransaction transaction)
                                                           throws ManagerException,
                                                                  PortalException

Get a list of ids by passing the ids of service interface and the service instance.

Parameters:

sessionConfig -

serviceInterfaceId -

serviceInstanceId -

ignoreRuntimeInterfaces -

ignorePageTemplates - TODO

transaction -

Returns:

a array of Strings.

Throws:

ManagerException

PortalException

getIdsByServiceInterfaceId

Collection<String> getIdsByServiceInterfaceId(SessionConfig sessionConfig,
                                              String serviceInterfaceId,
                                              boolean ignoreRuntimeInterfaces,
                                              ITransaction transaction)
                                       throws ManagerException,
                                              PortalException

Get a list of ids by passing the ids of the service interface.

Parameters:

sessionConfig -

serviceInterfaceId -

ignoreRuntimeInterfaces -

transaction -

Returns:

a arrays of Strings.

Throws:

ManagerException

PortalException

getIdsByServiceInterfaceId

Collection<String> getIdsByServiceInterfaceId(SessionConfig sessionConfig,
                                              String serviceInterfaceId,
                                              boolean ignoreRuntimeInterfaces,
                                              boolean ignorePageTemplates,
                                              ITransaction transaction)
                                       throws ManagerException,
                                              PortalException

Get a list of ids by passing the ids of the service interface.

Parameters:

sessionConfig -

serviceInterfaceId -

ignoreRuntimeInterfaces -

ignorePageTemplates - TODO

transaction -

Returns:

a arrays of Strings.

Throws:

ManagerException

PortalException

getIdsByPageId

Collection<String> getIdsByPageId(SessionConfig sessionConfig,
                                  String pageId,
                                  ITransaction transaction)
                           throws ManagerException,
                                  PortalException

Get a list of ids by passing the page's id.

Parameters:

sessionConfig -

pageId -

transaction -

Returns:

a array of strings.

Throws:

ManagerException

PortalException

getIdsByServiceInterfaceStyleId

Collection<String> getIdsByServiceInterfaceStyleId(SessionConfig sessionConfig,
                                                   String serviceInterfaceStyleId,
                                                   String serviceInterfaceId,
                                                   ITransaction transaction)
                                            throws ManagerException,
                                                   PortalException

Get the Ids given the ServiceInterfaceStyleId.

Parameters:

sessionConfig -

serviceInterfaceStyleId -

serviceInterfaceId -

transaction -

Returns:

a arrays of Strings.

Throws:

ManagerException

PortalException

setCustomProperty

void setCustomProperty(SessionConfig sessionConfig,
                       String interfaceInstanceId,
                       String name,
                       String value,
                       ITransaction transaction)
                throws ManagerException,
                       PortalException

Set a custom property for the given interface instance. If the property has been previously set, this method replaces the previous value, else a new property is created for the interface instance. If the property value is null or empty the property is removed.

Parameters:

sessionConfig - the user session information.

interfaceInstanceId - the service interface instance id.

name - the property name.

value - the property value.

transaction - the transaction for persistence access.

Throws:

ManagerException

PortalException

setCustomProperties

void setCustomProperties(SessionConfig sessionConfig,
                         String interfaceInstanceId,
                         Map<String,String> propertiesTable,
                         ITransaction transaction)
                  throws ManagerException,
                         PortalException

Receives a Map with one or more properties to be set for the given interface. If the property has been previously set, this method replaces the previous value, else a new property is created for the interface instance. If the property value is null or empty the property is removed.

Parameters:

sessionConfig - the user session information.

interfaceInstanceId - the service interface instance id.

propertiesTable - the map with the properties.

transaction - the transaction for persistence access.

Throws:

ManagerException

PortalException

getCustomProperty

String getCustomProperty(SessionConfig sessionConfig,
                         String interfaceInstanceId,
                         String name,
                         ITransaction transaction)
                  throws ManagerException,
                         PortalException

Returns the specified custom property. If the property has not been set earlier, null is returned.

Parameters:

sessionConfig -

interfaceInstanceId -

name -

transaction -

Returns:

a String.

Throws:

ManagerException

PortalException

getCustomProperties

Map<String,String> getCustomProperties(SessionConfig sessionConfig,
                                             String interfaceInstanceId,
                                             ITransaction transaction)
                                      throws ManagerException,
                                             PortalException

Returns a Map containing all name/value pairs of custom properties from the specified service interface instance.

Parameters:

sessionConfig - the user session information.

interfaceInstanceId - the service interface instance id.

transaction - the transaction for persistence access.

Returns:

the map with the properties.

Throws:

ManagerException

PortalException

getMenu

@Deprecated
String getMenu(SessionConfig sessionConfig,
               String serviceInterfaceInstanceId,
               ITransaction transaction)
        throws ManagerException,
               PortalException

Deprecated.

Since 10.2.0 replaced by getMenuXml(SessionConfig, String, ServiceInterfaceMenuLevel, ITransaction).

Returns the XML for the administration menu of the specified interface instance

Parameters:

sessionConfig -

serviceInterfaceInstanceId -

transaction -

Returns:

a String.

Throws:

ManagerException

PortalException

getMenuXml

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

Returns the XML for the menu for 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.

transaction - transaction for persistence access.

Returns:

a XML with the menu items available.

Throws:

PortalException

Since:

10.2.0

getXmlData

String getXmlData(SessionConfig sessionConfig,
                  String serviceInterfaceInstanceId)
           throws ManagerException,
                  PortalException

Returns the previously saved XML data for the service interface instance for the given user session

Parameters:

sessionConfig -

serviceInterfaceInstanceId -

transaction -

Returns:

a String.

Throws:

ManagerException

PortalException

deleteCustomProperty

void deleteCustomProperty(SessionConfig sessionConfig,
                          String interfaceInstanceId,
                          String name,
                          ITransaction transaction)
                   throws ManagerException,
                          PortalException

Deletes the interface instance custom property

Parameters:

sessionConfig -

interfaceInstanceId -

name -

transaction -

Throws:

ManagerException

PortalException

deleteCustomProperties

void deleteCustomProperties(SessionConfig sessionConfig,
                            String interfaceInstanceId,
                            ITransaction transaction)
                     throws ManagerException,
                            PortalException

Deletes all the interface instance custom properties

Parameters:

sessionConfig -

interfaceInstanceId -

transaction -

Throws:

ManagerException

PortalException

updateCustomPropertiesFromTemplate

void updateCustomPropertiesFromTemplate(SessionConfig sessionConfig,
                                        String interfaceInstanceId,
                                        ITransaction transaction)
                                 throws ManagerException,
                                        PortalException

Update the interface instance custom properties from parent interface instance

Parameters:

sessionConfig -

interfaceInstanceId -

transaction -

Throws:

ManagerException

PortalException

getPrintable

boolean getPrintable(SessionConfig sessionConfig,
                     String serviceInterfaceInstanceId,
                     ITransaction transaction)
              throws ManagerException,
                     PortalException

Returns the printable property of an interface instance. It may be necessary to look at the interface definition

Parameters:

sessionConfig -

serviceInterfaceInstanceId -

transaction -

Returns:

true if ServiceInterface is printable and false otherwise.

Throws:

ManagerException

PortalException

getRenderAs

int getRenderAs(SessionConfig sessionConfig,
                String serviceInterfaceInstanceId,
                ITransaction transaction)
         throws ManagerException,
                PortalException

Returns the renderAs property of an interface instance. It may be necessary to look at the interface definition

Parameters:

sessionConfig -

serviceInterfaceInstanceId -

transaction -

Returns:

a integer.

Throws:

ManagerException

PortalException

getEnableCache

boolean getEnableCache(SessionConfig sessionConfig,
                       String serviceInterfaceInstanceId,
                       ITransaction transaction)
                throws ManagerException,
                       PortalException

Returns the enableCache property of an interface instance. It may be necessary to look at the interface definition

Parameters:

sessionConfig -

serviceInterfaceInstanceId -

transaction -

Returns:

true if the Cache is enable.

Throws:

ManagerException

PortalException

getCacheLevel

int getCacheLevel(SessionConfig sessionConfig,
                  String serviceInterfaceInstanceId,
                  ITransaction transaction)
           throws ManagerException,
                  PortalException

Returns the cacheLevel property of an interface instance. It may be necessary to look at the interface definition

Parameters:

sessionConfig -

serviceInterfaceInstanceId -

transaction -

Returns:

an integer.

Throws:

ManagerException

PortalException

getCachePersonalization

int getCachePersonalization(SessionConfig sessionConfig,
                            String serviceInterfaceInstanceId,
                            ITransaction transaction)
                     throws ManagerException,
                            PortalException

Returns the cachePersonalization property of an interface instance. It may be necessary to look at the interface definition

Parameters:

sessionConfig -

serviceInterfaceInstanceId -

transaction -

Returns:

an integer.

Throws:

ManagerException

PortalException

getCacheServerSideInclude

boolean getCacheServerSideInclude(SessionConfig sessionConfig,
                                  String serviceInterfaceInstanceId,
                                  ITransaction transaction)
                           throws ManagerException,
                                  PortalException

Returns the cacheServerSideInclude property of an interface instance. It may be necessary to look at the interface definition

Parameters:

sessionConfig -

serviceInterfaceInstanceId -

transaction -

Returns:

true if the ... and false otherwise.

Throws:

ManagerException

PortalException

serialize

void serialize(SessionConfig sessionConfig,
               String serviceInterfaceInstanceId,
               OutputStream outputStream,
               ITransaction transaction)
        throws ManagerException,
               PortalException

Parameters:

sessionConfig -

serviceInterfaceInstanceId -

outputStream -

transaction -

Throws:

ManagerException

PortalException

deserialize

String deserialize(SessionConfig sessionConfig,
                   DeserializationConfig deserializationConfig,
                   Node serviceInterfaceInstanceNode,
                   ITransaction transaction)
            throws ManagerException,
                   PortalException

Parameters:

sessionConfig -

deserializationConfig -

serviceInterfaceInstanceNode -

transaction -

Returns:

a String.

Throws:

ManagerException

PortalException

serializeCustomProperties

void serializeCustomProperties(SessionConfig sessionConfig,
                               String serviceInterfaceInstanceId,
                               OutputStream outputStream,
                               ITransaction transaction)
                        throws ManagerException,
                               PortalException

Parameters:

sessionConfig -

serviceInterfaceInstanceId -

outputStream -

transaction -

Throws:

ManagerException

PortalException

deserializeCustomProperties

@Deprecated
void deserializeCustomProperties(SessionConfig sessionConfig,
                                 DeserializationConfig deserializationConfig,
                                 Node serviceInterfaceInstanceCustomPropertiesNode,
                                 ITransaction transaction)
                          throws ManagerException,
                                 PortalException

Deprecated.

Since 6.2.0 this method is no longer used and may be removed in a future version.

Parameters:

sessionConfig -

deserializationConfig -

serviceInterfaceInstanceCustomPropertiesNode -

transaction -

Throws:

ManagerException

PortalException

clearCache

void clearCache(SessionConfig sessionConfig,
                String serviceInterfaceInstanceId,
                ITransaction transaction)
         throws ManagerException,
                PortalException

Clears the caches of a service interface instance.

Clears service interface instance related information, cached in this manager, including HTML cache, and its XSL cache.

Parameters:

sessionConfig - the user session information.

serviceInterfaceInstanceId - the service interface instance identifier.

transaction - the transaction for persistence access.

Throws:

ManagerException

PortalException

clearCache

void clearCache(ITransaction transaction)
         throws PortalException

Clears all cache stored in this manager.

Parameters:

transaction - the transaction for persistence access. If null, the cache is just cleared, else it is cleared as a transactional operation as specified in PortalCache.clear(ITransaction).

Throws:

PortalException

Since:

4.1.0

setInterfaceInstanceHtmlCache

void setInterfaceInstanceHtmlCache(SessionConfig sessionConfig,
                                   String serviceInterfaceInstanceId,
                                   Locale locale,
                                   String serviceInterfaceInstanceHtml,
                                   ITransaction transaction)
                            throws ManagerException,
                                   PortalException

Deprecated.

since 7.0.0 deprecated without replacement. LumisXP manages interface instance caches transparently and solutions should not interfere.

Get the HTML Cache of the Interface Instance.

Parameters:

sessionConfig -

serviceInterfaceInstanceId -

locale -

serviceInterfaceInstanceHtml -

transaction -

Throws:

ManagerException

PortalException

getInterfaceInstanceHtmlCache

String getInterfaceInstanceHtmlCache(SessionConfig sessionConfig,
                                     String serviceInterfaceInstanceId,
                                     Locale locale,
                                     ITransaction transaction)
                              throws ManagerException,
                                     PortalException

Deprecated.

since 7.0.0 deprecated without replacement. LumisXP manages interface instance caches transparently and solutions should not interfere.

Get the HTML Cache of the Interface Instance.

Parameters:

sessionConfig -

serviceInterfaceInstanceId -

locale -

transaction -

Returns:

Throws:

ManagerException

PortalException

updatePropertiesFromTemplate

void updatePropertiesFromTemplate(SessionConfig sessionConfig,
                                  String interfaceInstanceId,
                                  ITransaction transaction)
                           throws ManagerException,
                                  PortalException

Update the properties of from the template.

Parameters:

sessionConfig -

interfaceInstanceId -

transaction -

Throws:

ManagerException

PortalException

getServiceInterfaceInstanceStyleConfigKeyChecker

IConfigKeyChecker getServiceInterfaceInstanceStyleConfigKeyChecker()

getTitle

String getTitle(ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig,
                ITransaction transaction)
         throws PortalException

Returns the title for a service interface instance. The title is calculated from the service interface instance and the service interface properties/definitions.

Parameters:

serviceInterfaceInstanceConfig - the service interface instance.

transaction - the transaction for persistence access.

Returns:

the title. May be a localizable string.

Throws:

PortalException

Since:

5.5.0

getDisplayName

String getDisplayName(ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig,
                      ITransaction transaction)
               throws PortalException

Returns the display name for a service interface instance. The display name is calculated from the service interface instance and the service interface properties/definitions.

Parameters:

serviceInterfaceInstanceConfig - the service interface instance.

transaction - the transaction for persistence access.

Returns:

the display name. May be a localizable string.

Throws:

PortalException

Since:

5.5.0