Package lumis.portal.serviceinterface

Interface IServiceInterfaceManager

All Superinterfaces:

IConfigKeyChecker

All Known Subinterfaces:

IServiceInterfaceManagerSPI

All Known Implementing Classes:

ServiceInterfaceManager

@StableMinor(version="16.1",
             sinceVersion="4.0")
public interface IServiceInterfaceManager
extends IConfigKeyChecker

Interface for the Service Interface Manager.

Since:

4.0.0

Version:

$Revision: 26156 $ $Date: 2024-01-13 10:26:46 -0300 (Sat, 13 Jan 2024) $

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	INTERFACE_HOLDER_ID

Method Summary

Modifier and Type	Method	Description
void	addOrUpdateStyle(SessionConfig sessionConfig, ServiceInterfaceStyleConfig serviceInterfaceStyleConfig, ITransaction transaction)	Add or update a Style.
void	deleteStyle(SessionConfig sessionConfig, java.lang.String serviceInterfaceStyleId, java.lang.String serviceInterfaceId, ITransaction transaction)	Delete a Style.
void	deserializeStyle(SessionConfig sessionConfig, org.w3c.dom.Node interfaceStyleNode, ITransaction transaction)	Deserializes a ServiceInterfaceStyleConfig contained in the interfaceStyleNode.
java.util.Collection<java.lang.String>	getIdsByServiceId(java.lang.String serviceId, ITransaction transaction)	Get the service interface ids from a given service.
ServiceInterfaceMenuGroupTypeConfig	getMenuGroupType(SessionConfig sessionConfig, java.lang.String menuGroupTypeId, ITransaction transaction)	Get the menu group type.
ServiceInterfaceMenuItemTypeConfig	getMenuItemType(SessionConfig sessionConfig, java.lang.String menuItemTypeId, ITransaction transaction)	Get the menu item type.
IServiceInterface	getServiceInterface(java.lang.String serviceInterfaceId, ITransaction transaction)	Get the service interface.
ServiceInterfaceConfig	getServiceInterfaceConfig(java.lang.String serviceInterfaceId, ITransaction transaction)	Get the configuration of the service interface.
ServiceInterfaceStyleConfig	getStyle(SessionConfig sessionConfig, java.lang.String serviceInterfaceStyleId, java.lang.String serviceInterfaceId, ITransaction transaction)	Get the style configuration os the service interface.
ServiceInterfaceStyleConfig	getStyleByServiceInterfaceInstanceId(SessionConfig sessionConfig, java.lang.String serviceInterfaceInstanceId, ITransaction transaction)	Get the Style given the ServiceInterfaceInstanceId.
IConfigKeyChecker	getStyleConfigKeyChecker()
java.util.Collection<java.lang.String>	getStyleIds(SessionConfig sessionConfig, java.lang.String serviceInterfaceId, ITransaction transaction)	Get the Id of all styles associated with a service interface.
java.util.Collection<java.lang.String>	getStyleIdsByInterfaceInstance(SessionConfig sessionConfig, java.lang.String interfaceInstanceId, ITransaction transaction, boolean onlyCustomStyles)	Get the Id of all styles available to an interface instance considering the isolation rules.
void	register(SessionConfig sessionConfig, java.lang.String serviceConfigPath, ITransaction transaction)	Register the service interface.
void	registerMenuGroupTypes(SessionConfig sessionConfig, java.lang.String groupTypesConfigPath, ITransaction transaction)	Register the menu group types.
void	registerMenuItemTypes(SessionConfig sessionConfig, java.lang.String itemTypesConfigPath, ITransaction transaction)	Register menu item type.
void	registerServiceInterfaceTypes(SessionConfig sessionConfig, java.lang.String serviceTypesConfigPath, ITransaction transaction)	Register the type of the service interface.
void	serializeStyle(SessionConfig sessionConfig, java.lang.String serviceInterfaceStyleId, java.lang.String serviceInterfaceId, java.io.OutputStream outputStream, ITransaction transaction)	Serializes a ServiceInterfaceStyleConfig to the specified outputStream.
void	unregister(SessionConfig sessionConfig, ServiceInterfaceConfig serviceInterfaceConfig, ITransaction transaction)	Unregister the Service Interface.
void	unregisterMenuGroupType(SessionConfig sessionConfig, java.lang.String typeId, ITransaction transaction)	Unregisters a service menu group type.
void	unregisterMenuItemType(SessionConfig sessionConfig, java.lang.String typeId, ITransaction transaction)	Unregisters a service menu item type.
void	unregisterServiceInterfaceType(java.lang.String typeId, ITransaction transaction)	Unregister the type of service interface.

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

keyExists

Field Detail

INTERFACE_HOLDER_ID

static final java.lang.String INTERFACE_HOLDER_ID

See Also:

Constant Field Values

Method Detail

register

void register(SessionConfig sessionConfig,
              java.lang.String serviceConfigPath,
              ITransaction transaction)
       throws ManagerException,
              PortalException

Register the service interface.

Parameters:

sessionConfig -

serviceConfigPath -

transaction -

Throws:

ManagerException

PortalException

getServiceInterfaceConfig

ServiceInterfaceConfig getServiceInterfaceConfig(java.lang.String serviceInterfaceId,
                                                 ITransaction transaction)
                                          throws ManagerException,
                                                 PortalException

Get the configuration of the service interface.

Parameters:

serviceInterfaceId -

transaction -

Returns:

a ServiceInterfaceConfig.

Throws:

ManagerException

PortalException

getIdsByServiceId

java.util.Collection<java.lang.String> getIdsByServiceId(java.lang.String serviceId,
                                                         ITransaction transaction)
                                                  throws ManagerException,
                                                         PortalException

Get the service interface ids from a given service.

Parameters:

serviceId -

transaction -

Returns:

a array of Strings.

Throws:

ManagerException

PortalException

getServiceInterface

IServiceInterface getServiceInterface(java.lang.String serviceInterfaceId,
                                      ITransaction transaction)
                               throws ManagerException,
                                      PortalException

Get the service interface.

Parameters:

serviceInterfaceId -

transaction -

Returns:

an IServiceInterface.

Throws:

ManagerException

PortalException

registerServiceInterfaceTypes

void registerServiceInterfaceTypes(SessionConfig sessionConfig,
                                   java.lang.String serviceTypesConfigPath,
                                   ITransaction transaction)
                            throws ManagerException,
                                   PortalException

Register the type of the service interface.

Parameters:

sessionConfig -

serviceTypesConfigPath -

transaction -

Throws:

ManagerException

PortalException

unregisterServiceInterfaceType

void unregisterServiceInterfaceType(java.lang.String typeId,
                                    ITransaction transaction)
                             throws ManagerException,
                                    PortalException

Unregister the type of service interface.

Parameters:

typeId -

transaction -

Throws:

ManagerException

PortalException

getStyle

ServiceInterfaceStyleConfig getStyle(SessionConfig sessionConfig,
                                     java.lang.String serviceInterfaceStyleId,
                                     java.lang.String serviceInterfaceId,
                                     ITransaction transaction)
                              throws ManagerException,
                                     PortalException

Get the style configuration os the service interface.

Parameters:

serviceInterfaceStyleId -

serviceInterfaceId -

transaction -

Returns:

a ServiceInterfaceStyleConfig.

Throws:

ManagerException

PortalException

addOrUpdateStyle

void addOrUpdateStyle(SessionConfig sessionConfig,
                      ServiceInterfaceStyleConfig serviceInterfaceStyleConfig,
                      ITransaction transaction)
               throws ManagerException,
                      PortalException

Add or update a Style. This method consider the rules of Style Isolation level.

The rules considered are:

• The Isolation level of a style from definition service can not has it's level changed.
• A custom style can not refer to a XSL file used by another interface style.

Parameters:

sessionConfig - the sessionConfig object that contains the informations about the user request.

serviceInterfaceStyleConfig - the style object to be persisted.

transaction - used to get informations from database.

Throws:

ManagerException - if any error occurs during the process of communication with database.

PortalException - if any other error occurs during the process.

Since:

6.2.0

deleteStyle

void deleteStyle(SessionConfig sessionConfig,
                 java.lang.String serviceInterfaceStyleId,
                 java.lang.String serviceInterfaceId,
                 ITransaction transaction)
          throws ManagerException,
                 PortalException

Delete a Style.

Parameters:

sessionConfig -

serviceInterfaceStyleId -

serviceInterfaceId -

transaction -

Throws:

ManagerException

PortalException

getStyleByServiceInterfaceInstanceId

ServiceInterfaceStyleConfig getStyleByServiceInterfaceInstanceId(SessionConfig sessionConfig,
                                                                 java.lang.String serviceInterfaceInstanceId,
                                                                 ITransaction transaction)
                                                          throws ManagerException,
                                                                 PortalException

Get the Style given the ServiceInterfaceInstanceId.

Parameters:

sessionConfig -

serviceInterfaceInstanceId -

transaction -

Returns:

a ServiceInterfaceStyleConfig.

Throws:

ManagerException

PortalException

registerMenuGroupTypes

void registerMenuGroupTypes(SessionConfig sessionConfig,
                            java.lang.String groupTypesConfigPath,
                            ITransaction transaction)
                     throws ManagerException,
                            PortalException

Register the menu group types.

Parameters:

sessionConfig -

groupTypesConfigPath -

transaction -

Throws:

ManagerException

PortalException

registerMenuItemTypes

void registerMenuItemTypes(SessionConfig sessionConfig,
                           java.lang.String itemTypesConfigPath,
                           ITransaction transaction)
                    throws ManagerException,
                           PortalException

Register menu item type.

Parameters:

sessionConfig -

itemTypesConfigPath -

transaction -

Throws:

ManagerException

PortalException

getMenuGroupType

ServiceInterfaceMenuGroupTypeConfig getMenuGroupType(SessionConfig sessionConfig,
                                                     java.lang.String menuGroupTypeId,
                                                     ITransaction transaction)
                                              throws ManagerException,
                                                     PortalException

Get the menu group type.

Parameters:

sessionConfig -

menuGroupTypeId -

transaction -

Returns:

a ServiceInterfaceMenuGroupTypeConfig.

Throws:

ManagerException

PortalException

getMenuItemType

ServiceInterfaceMenuItemTypeConfig getMenuItemType(SessionConfig sessionConfig,
                                                   java.lang.String menuItemTypeId,
                                                   ITransaction transaction)
                                            throws ManagerException,
                                                   PortalException

Get the menu item type.

Parameters:

sessionConfig -

menuItemTypeId -

transaction -

Returns:

a ServiceInterfaceMenuItemConfig.

Throws:

ManagerException

PortalException

unregister

void unregister(SessionConfig sessionConfig,
                ServiceInterfaceConfig serviceInterfaceConfig,
                ITransaction transaction)
         throws ManagerException,
                PortalException

Unregister the Service Interface.

Parameters:

sessionConfig -

serviceInterfaceConfig -

transaction -

Throws:

ManagerException

PortalException

getStyleIds

java.util.Collection<java.lang.String> getStyleIds(SessionConfig sessionConfig,
                                                   java.lang.String serviceInterfaceId,
                                                   ITransaction transaction)
                                            throws ManagerException,
                                                   PortalException

Get the Id of all styles associated with a service interface.

Parameters:

sessionConfig - the sessionConfig object that contains the informations about the user request.

serviceInterfaceId - Service Interface target.

transaction - used to get informations from database.

Returns:

list of interface styles according with the isolation rules.

Throws:

ManagerException - if any error occurs during the process of communication with database.

PortalException - if any other error occurs during the process.

Since:

4.0.3

getStyleIdsByInterfaceInstance

java.util.Collection<java.lang.String> getStyleIdsByInterfaceInstance(SessionConfig sessionConfig,
                                                                      java.lang.String interfaceInstanceId,
                                                                      ITransaction transaction,
                                                                      boolean onlyCustomStyles)
                                                               throws ManagerException,
                                                                      PortalException

Get the Id of all styles available to an interface instance considering the isolation rules.

The isolation rules are:

• Interface Style with isolation level Isolated - Can be used only by one interface instance.
• Interface Style with isolation level: Non-Isolated - Can be used for any the interface instance. This level is the default for new styles.
• Interface Style with isolation level: Shared - Can be used just by service instances indicated by the user during the add or update custom interface style process.

Parameters:

sessionConfig - the sessionConfig object that contains the informations about the user request.

interfaceInstanceId - Interface instance target.

transaction - used to get informations from database.

onlyCustomStyles - determine if is to return only custom styles.

Returns:

list of interface styles according with the isolation rules.

Throws:

ManagerException - if any error occurs during the process of communication with database.

PortalException - if any other error occurs during the process.

Since:

6.2.0

serializeStyle

void serializeStyle(SessionConfig sessionConfig,
                    java.lang.String serviceInterfaceStyleId,
                    java.lang.String serviceInterfaceId,
                    java.io.OutputStream outputStream,
                    ITransaction transaction)
             throws ManagerException,
                    PortalException

Serializes a ServiceInterfaceStyleConfig to the specified outputStream.

Parameters:

sessionConfig -

serviceInterfaceStyleId -

serviceInterfaceId -

transaction -

Throws:

ManagerException

PortalException

Since:

4.0.3

deserializeStyle

void deserializeStyle(SessionConfig sessionConfig,
                      org.w3c.dom.Node interfaceStyleNode,
                      ITransaction transaction)
               throws ManagerException,
                      PortalException

Deserializes a ServiceInterfaceStyleConfig contained in the interfaceStyleNode.

Parameters:

sessionConfig -

interfaceStyleNode -

transaction -

Throws:

ManagerException

PortalException

unregisterMenuItemType

void unregisterMenuItemType(SessionConfig sessionConfig,
                            java.lang.String typeId,
                            ITransaction transaction)
                     throws ManagerException,
                            PortalException

Unregisters a service menu item type.

Parameters:

sessionConfig -

typeId -

transaction -

Throws:

ManagerException

PortalException

Since:

4.0.6

unregisterMenuGroupType

void unregisterMenuGroupType(SessionConfig sessionConfig,
                             java.lang.String typeId,
                             ITransaction transaction)
                      throws ManagerException,
                             PortalException

Unregisters a service menu group type.

Parameters:

sessionConfig -

typeId -

transaction -

Throws:

ManagerException

PortalException

Since:

4.0.6

getStyleConfigKeyChecker

IConfigKeyChecker getStyleConfigKeyChecker()