lumis.portal.serviceinterface.style

Interface IServiceInterfaceStyleDao

All Known Implementing Classes:

ServiceInterfaceStyleDaoJdbc

public interface IServiceInterfaceStyleDao

Since:

6.0.0

Version:

$Revision: 14187 $ $Date: 2012-04-02 11:44:41 -0300 (Mon, 02 Apr 2012) $

Method Summary

Methods

Modifier and Type	Method and Description
void	addOrUpdate(ServiceInterfaceStyleConfig serviceInterfaceStyleConfig, ITransaction transaction) Add or update the style of the service's interface.
void	delete(String serviceInterfaceStyleId, String serviceInterfaceId, ITransaction transaction) Delete the style of the service's interface.
ServiceInterfaceStyleConfig	get(String serviceInterfaceStyleId, String serviceInterfaceId, ITransaction transaction) Get the style of the service's interface.
Collection<String>	getIdsByInterfaceInstanceId(String interfaceId, String serviceInterfaceId, String interfaceInstanceId, boolean onlyCustomStyles, ITransaction daoTransaction) Get the list of Ids of all styles available to an interface instance considering the isolation rules.
Collection<String>	getIdsByServiceInterfaceId(String serviceInterfaceId, ITransaction transaction) Get a list of ids given the id of the service's interface.
Collection<String>	getIdsByXslFilePath(String xslFilePath, ITransaction daoTransaction) Returns a list of interface style ids that use the given XSL file.
ServiceInterfaceStyleConfig	getWidgetStyle(String serviceInterfaceId, ITransaction transaction) Get the widget style of the service's interface.

Method Detail

addOrUpdate

void addOrUpdate(ServiceInterfaceStyleConfig serviceInterfaceStyleConfig,
               ITransaction transaction)
                 throws DaoException,
                        PortalException

Add or update the style of the service's interface. Add the style if it don't exist.

Parameters:

serviceInterfaceStyleConfig -

transaction -

Throws:

DaoException

PortalException

delete

void delete(String serviceInterfaceStyleId,
          String serviceInterfaceId,
          ITransaction transaction)
            throws DaoException,
                   PortalException

Delete the style of the service's interface.

Parameters:

serviceInterfaceStyleId -

serviceInterfaceId -

transaction -

Throws:

DaoException

PortalException

get

ServiceInterfaceStyleConfig get(String serviceInterfaceStyleId,
                              String serviceInterfaceId,
                              ITransaction transaction)
                                throws DaoException,
                                       PortalException

Get the style of the service's interface.

Parameters:

serviceInterfaceStyleId -

serviceInterfaceId -

transaction -

Returns:

Throws:

DaoException

PortalException

getIdsByServiceInterfaceId

Collection<String> getIdsByServiceInterfaceId(String serviceInterfaceId,
                                            ITransaction transaction)
                                              throws DaoException,
                                                     PortalException

Get a list of ids given the id of the service's interface. This method don't consider isolation rules.

Parameters:

serviceInterfaceId - service interface identifier.

transaction - transaction used to perform the query on database.

Returns:

a list of ids given the id of the service's interface.

Throws:

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

PortalException - if any other error occurs during the process.

getIdsByInterfaceInstanceId

Collection<String> getIdsByInterfaceInstanceId(String interfaceId,
                                             String serviceInterfaceId,
                                             String interfaceInstanceId,
                                             boolean onlyCustomStyles,
                                             ITransaction daoTransaction)
                                               throws DaoException,
                                                      PortalException

Get the list of Ids 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 custom interface style process.

Parameters:

interfaceId - identifier of the interface target.

serviceInterfaceId - service interface identifier.

interfaceInstanceId - interface instance identifier.

onlyCustomStyles - determine if is to return only custom styles.

daoTransaction - transaction used to perform the query on database.

Returns:

list of interface styles according with the isolation rules.

Throws:

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

PortalException - if any other error occurs during the process.

Since:

6.2.0

getWidgetStyle

ServiceInterfaceStyleConfig getWidgetStyle(String serviceInterfaceId,
                                         ITransaction transaction)
                                           throws DaoException,
                                                  PortalException

Get the widget style of the service's interface.

Parameters:

serviceInterfaceId - id of interface.

transaction - transaction used to get information from database.

Returns:

the Interface Style entity.

Throws:

DaoException - if any error occurs during the process on database.

PortalException - if any error occurs during the process.

getIdsByXslFilePath

Collection<String> getIdsByXslFilePath(String xslFilePath,
                                     ITransaction daoTransaction)
                                       throws DaoException,
                                              PortalException

Returns a list of interface style ids that use the given XSL file.

Parameters:

xslFilePath - the XSL file path.

daoTransaction - transaction used to get information from database.

Returns:

a list of interface style ids that use the given XSL file.

Throws:

DaoException - if any error occurs during the process on database.

PortalException - if any error occurs during the process.

Since:

6.2.0