lumis.portal.serviceinterface
Class ServiceInterfaceManager

Package class diagram package ServiceInterfaceManager
java.lang.Object
  extended by lumis.portal.serviceinterface.ServiceInterfaceManager
All Implemented Interfaces:
IConfigKeyChecker, IServiceInterfaceManager

public class ServiceInterfaceManager
extends Object
implements IServiceInterfaceManager

Service interface manager implementation.

Since:
4.0.0

Field Summary
 
Fields inherited from interface lumis.portal.serviceinterface.IServiceInterfaceManager
INTERFACE_HOLDER_ID
 
Constructor Summary
ServiceInterfaceManager()
           
 
Method Summary
 void addOrUpdateStyle(SessionConfig sessionConfig, ServiceInterfaceStyleConfig serviceInterfaceStyleConfig, ITransaction transaction)
          Add or update a Style.
 void deleteStyle(SessionConfig sessionConfig, String serviceInterfaceStyleId, String serviceInterfaceId, ITransaction transaction)
          Delete a Style.
 void deserializeStyle(SessionConfig sessionConfig, Node interfaceStyleNode, ITransaction transaction)
          Deserializes a ServiceInterfaceStyleConfig contained in the interfaceStyleNode.
 Collection<String> getIdsByServiceId(String serviceId, ITransaction transaction)
          Get the service interface ids from a given service.
 ServiceInterfaceMenuGroupTypeConfig getMenuGroupType(SessionConfig sessionConfig, String menuGroupTypeId, ITransaction transaction)
          Get the menu group type.
 ServiceInterfaceMenuItemTypeConfig getMenuItemType(SessionConfig sessionConfig, String menuItemTypeId, ITransaction transaction)
          Get the menu item type.
 IServiceInterface getServiceInterface(String serviceInterfaceId, ITransaction transaction)
          Get the service interface.
 ServiceInterfaceConfig getServiceInterfaceConfig(String serviceInterfaceId, ITransaction transaction)
          Get the configuration of the service interface.
protected  ServiceInterfaceTypeConfig getServiceInterfaceTypeConfig(String interfaceType, ITransaction transaction)
           
 ServiceInterfaceStyleConfig getStyle(SessionConfig sessionConfig, String serviceInterfaceStyleId, String serviceInterfaceId, ITransaction transaction)
          Get the style configuration os the service interface.
 ServiceInterfaceStyleConfig getStyleByServiceInterfaceInstanceId(SessionConfig sessionConfig, String serviceInterfaceInstanceId, ITransaction transaction)
          Get the Style given the ServiceInterfaceInstanceId.
 IConfigKeyChecker getStyleConfigKeyChecker()
           
 Collection<String> getStyleIds(SessionConfig sessionConfig, String serviceInterfaceId, ITransaction transaction)
          Get the Id of all styles associated with a service interface.
 boolean keyExists(SessionConfig sessionConfig, Object configKey, Object config, ITransaction transaction)
          Checks if configId matches an already persisted object
 void register(SessionConfig sessionConfig, String serviceConfigPath, ITransaction transaction)
          Register the service interface.
 void registerMenuGroupTypes(SessionConfig sessionConfig, String groupTypesConfigPath, ITransaction transaction)
          Register the menu group types.
 void registerMenuItemTypes(SessionConfig sessionConfig, String itemTypesConfigPath, ITransaction transaction)
          Register menu item type.
 void registerServiceInterfaceTypes(SessionConfig sessionConfig, String serviceTypesConfigPath, ITransaction transaction)
          Register the type of the service interface.
 void serializeStyle(SessionConfig sessionConfig, String serviceInterfaceStyleId, String serviceInterfaceId, 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, String typeId, ITransaction transaction)
          Unregisters a service menu group type.
 void unregisterMenuItemType(SessionConfig sessionConfig, String typeId, ITransaction transaction)
          Unregisters a service menu item type.
 void unregisterServiceInterfaceType(String typeId, ITransaction transaction)
          Unregister the type of service interface.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ServiceInterfaceManager

public ServiceInterfaceManager()
Method Detail

getServiceInterfaceConfig

public ServiceInterfaceConfig getServiceInterfaceConfig(String serviceInterfaceId,
                                                        ITransaction transaction)
                                                 throws ManagerException,
                                                        PortalException
Description copied from interface: IServiceInterfaceManager
Get the configuration of the service interface.

Specified by:
getServiceInterfaceConfig in interface IServiceInterfaceManager
Returns:
a ServiceInterfaceConfig.
Throws:
ManagerException
PortalException

getIdsByServiceId

public Collection<String> getIdsByServiceId(String serviceId,
                                            ITransaction transaction)
                                     throws ManagerException,
                                            PortalException
Description copied from interface: IServiceInterfaceManager
Get the service interface ids from a given service.

Specified by:
getIdsByServiceId in interface IServiceInterfaceManager
Returns:
a array of Strings.
Throws:
ManagerException
PortalException

getServiceInterface

public IServiceInterface getServiceInterface(String serviceInterfaceId,
                                             ITransaction transaction)
                                      throws ManagerException,
                                             PortalException
Description copied from interface: IServiceInterfaceManager
Get the service interface.

Specified by:
getServiceInterface in interface IServiceInterfaceManager
Returns:
an IServiceInterface.
Throws:
ManagerException
PortalException

register

public void register(SessionConfig sessionConfig,
                     String serviceConfigPath,
                     ITransaction transaction)
              throws ManagerException,
                     PortalException
Description copied from interface: IServiceInterfaceManager
Register the service interface.

Specified by:
register in interface IServiceInterfaceManager
Throws:
ManagerException
PortalException

registerServiceInterfaceTypes

public void registerServiceInterfaceTypes(SessionConfig sessionConfig,
                                          String serviceTypesConfigPath,
                                          ITransaction transaction)
                                   throws ManagerException,
                                          PortalException
Description copied from interface: IServiceInterfaceManager
Register the type of the service interface.

Specified by:
registerServiceInterfaceTypes in interface IServiceInterfaceManager
Throws:
ManagerException
PortalException

getServiceInterfaceTypeConfig

protected ServiceInterfaceTypeConfig getServiceInterfaceTypeConfig(String interfaceType,
                                                                   ITransaction transaction)
                                                            throws ManagerException,
                                                                   PortalException
Throws:
ManagerException
PortalException

unregisterServiceInterfaceType

public void unregisterServiceInterfaceType(String typeId,
                                           ITransaction transaction)
                                    throws ManagerException,
                                           PortalException
Description copied from interface: IServiceInterfaceManager
Unregister the type of service interface.

Specified by:
unregisterServiceInterfaceType in interface IServiceInterfaceManager
Throws:
ManagerException
PortalException

getStyleByServiceInterfaceInstanceId

public ServiceInterfaceStyleConfig getStyleByServiceInterfaceInstanceId(SessionConfig sessionConfig,
                                                                        String serviceInterfaceInstanceId,
                                                                        ITransaction transaction)
                                                                 throws ManagerException,
                                                                        PortalException
Description copied from interface: IServiceInterfaceManager
Get the Style given the ServiceInterfaceInstanceId.

Specified by:
getStyleByServiceInterfaceInstanceId in interface IServiceInterfaceManager
Returns:
a ServiceInterfaceStyleConfig.
Throws:
ManagerException
PortalException

getStyle

public ServiceInterfaceStyleConfig getStyle(SessionConfig sessionConfig,
                                            String serviceInterfaceStyleId,
                                            String serviceInterfaceId,
                                            ITransaction transaction)
                                     throws ManagerException,
                                            PortalException
Description copied from interface: IServiceInterfaceManager
Get the style configuration os the service interface.

Specified by:
getStyle in interface IServiceInterfaceManager
Returns:
a ServiceInterfaceStyleConfig.
Throws:
ManagerException
PortalException

deleteStyle

public void deleteStyle(SessionConfig sessionConfig,
                        String serviceInterfaceStyleId,
                        String serviceInterfaceId,
                        ITransaction transaction)
                 throws ManagerException,
                        PortalException
Description copied from interface: IServiceInterfaceManager
Delete a Style.

Specified by:
deleteStyle in interface IServiceInterfaceManager
Throws:
ManagerException
PortalException

addOrUpdateStyle

public void addOrUpdateStyle(SessionConfig sessionConfig,
                             ServiceInterfaceStyleConfig serviceInterfaceStyleConfig,
                             ITransaction transaction)
                      throws ManagerException,
                             PortalException
Description copied from interface: IServiceInterfaceManager
Add or update a Style.

Specified by:
addOrUpdateStyle in interface IServiceInterfaceManager
Throws:
ManagerException
PortalException

registerMenuItemTypes

public void registerMenuItemTypes(SessionConfig sessionConfig,
                                  String itemTypesConfigPath,
                                  ITransaction transaction)
                           throws ManagerException,
                                  PortalException
Description copied from interface: IServiceInterfaceManager
Register menu item type.

Specified by:
registerMenuItemTypes in interface IServiceInterfaceManager
Throws:
ManagerException
PortalException

registerMenuGroupTypes

public void registerMenuGroupTypes(SessionConfig sessionConfig,
                                   String groupTypesConfigPath,
                                   ITransaction transaction)
                            throws ManagerException,
                                   PortalException
Description copied from interface: IServiceInterfaceManager
Register the menu group types.

Specified by:
registerMenuGroupTypes in interface IServiceInterfaceManager
Throws:
ManagerException
PortalException

unregisterMenuItemType

public void unregisterMenuItemType(SessionConfig sessionConfig,
                                   String typeId,
                                   ITransaction transaction)
                            throws ManagerException,
                                   PortalException
Description copied from interface: IServiceInterfaceManager
Unregisters a service menu item type.

Specified by:
unregisterMenuItemType in interface IServiceInterfaceManager
Throws:
ManagerException
PortalException

unregisterMenuGroupType

public void unregisterMenuGroupType(SessionConfig sessionConfig,
                                    String typeId,
                                    ITransaction transaction)
                             throws ManagerException,
                                    PortalException
Description copied from interface: IServiceInterfaceManager
Unregisters a service menu group type.

Specified by:
unregisterMenuGroupType in interface IServiceInterfaceManager
Throws:
ManagerException
PortalException

getMenuGroupType

public ServiceInterfaceMenuGroupTypeConfig getMenuGroupType(SessionConfig sessionConfig,
                                                            String menuGroupTypeId,
                                                            ITransaction transaction)
                                                     throws ManagerException,
                                                            PortalException
Description copied from interface: IServiceInterfaceManager
Get the menu group type.

Specified by:
getMenuGroupType in interface IServiceInterfaceManager
Returns:
a ServiceInterfaceMenuGroupTypeConfig.
Throws:
ManagerException
PortalException

getMenuItemType

public ServiceInterfaceMenuItemTypeConfig getMenuItemType(SessionConfig sessionConfig,
                                                          String menuItemTypeId,
                                                          ITransaction transaction)
                                                   throws ManagerException,
                                                          PortalException
Description copied from interface: IServiceInterfaceManager
Get the menu item type.

Specified by:
getMenuItemType in interface IServiceInterfaceManager
Returns:
a ServiceInterfaceMenuItemConfig.
Throws:
ManagerException
PortalException

unregister

public void unregister(SessionConfig sessionConfig,
                       ServiceInterfaceConfig serviceInterfaceConfig,
                       ITransaction transaction)
                throws ManagerException,
                       PortalException
Description copied from interface: IServiceInterfaceManager
Unregister the Service Interface.

Specified by:
unregister in interface IServiceInterfaceManager
Throws:
ManagerException
PortalException

getStyleIds

public Collection<String> getStyleIds(SessionConfig sessionConfig,
                                      String serviceInterfaceId,
                                      ITransaction transaction)
                               throws ManagerException,
                                      PortalException
Description copied from interface: IServiceInterfaceManager
Get the Id of all styles associated with a service interface.

Specified by:
getStyleIds in interface IServiceInterfaceManager
Returns:
Throws:
ManagerException
PortalException

serializeStyle

public void serializeStyle(SessionConfig sessionConfig,
                           String serviceInterfaceStyleId,
                           String serviceInterfaceId,
                           OutputStream outputStream,
                           ITransaction transaction)
                    throws ManagerException,
                           PortalException
Description copied from interface: IServiceInterfaceManager
Serializes a ServiceInterfaceStyleConfig to the specified outputStream.

Specified by:
serializeStyle in interface IServiceInterfaceManager
Throws:
ManagerException
PortalException

deserializeStyle

public void deserializeStyle(SessionConfig sessionConfig,
                             Node interfaceStyleNode,
                             ITransaction transaction)
                      throws ManagerException,
                             PortalException
Description copied from interface: IServiceInterfaceManager
Deserializes a ServiceInterfaceStyleConfig contained in the interfaceStyleNode.

Specified by:
deserializeStyle in interface IServiceInterfaceManager
Throws:
ManagerException
PortalException

keyExists

public boolean keyExists(SessionConfig sessionConfig,
                         Object configKey,
                         Object config,
                         ITransaction transaction)
Description copied from interface: IConfigKeyChecker
Checks if configId matches an already persisted object

Specified by:
keyExists in interface IConfigKeyChecker
config - Optional, allows a checker to read aditional fields to check composed keys
Returns:
true if configId matches an already persisted object

getStyleConfigKeyChecker

public IConfigKeyChecker getStyleConfigKeyChecker()
Specified by:
getStyleConfigKeyChecker in interface IServiceInterfaceManager


Lumisportal  4.1.0.071221 - Copyright © 2001-2007, Lumis. All Rights Reserved.