lumis.portal.serviceinterfaceinstance

Interface IServiceInterfaceInstanceDao

All Known Implementing Classes:

ServiceInterfaceInstanceDaoJdbc

public interface IServiceInterfaceInstanceDao

DAO for service interface instance

Since:

4.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	add(ServiceInterfaceInstanceConfig serviceInterfaceInstance, ITransaction daoTransaction) Add the service's interface's instance.
void	delete(String serviceInterfaceInstanceId, ITransaction daoTransaction) Delete the service's interface's instance.
void	deleteCustomProperties(String interfaceInstanceId, ITransaction daoTransaction) Delete the custom propertires of the service's interface's instance.
boolean	deleteCustomProperty(String interfaceInstanceId, String name, ITransaction daoTransaction) Delete a custom property of the service's interface's instance.
ServiceInterfaceInstanceConfig	get(String interfaceInstanceId, ITransaction daoTransaction) Get the service's interface's instance.
HashMap<String,String>	getCustomProperties(String interfaceInstanceId, ITransaction daoTransaction) Get all custom properties of the specified service insterface instance.
String	getCustomProperty(String interfaceInstanceId, String name, ITransaction daoTransaction) Get the custom property of the service's interface's instance.
List<String>	getIdsByBaseInterfaceInstanceId(String interfaceInstanceId, ITransaction daoTransaction) Returns a list of ids of interface instances that have the given base interface instance id.
List<String>	getIdsByInterfaceStyleId(String interfaceStyleId, ITransaction daoTransaction) Returns a list of ids of interface instances that uses the given interface style id.
Collection<String>	getIdsByServiceInstanceId(String serviceInstanceId, boolean ignoreRuntimeInterfaces, ITransaction transaction) Get a list of ids given the id of the id of the service's instance.
Collection<String>	getIdsByServiceInterfaceId(String serviceInterfaceId, boolean ignoreRuntimeInterfaces, boolean ignorePageTemplates, ITransaction transaction) Get a list of ids given the id of the service's interface.
Collection<String>	getIdsByServiceInterfaceId(String serviceInterfaceId, boolean ignoreRuntimeInterfaces, ITransaction transaction) Get a list of ids given the id of the service's interface.
Collection<String>	getIdsByServiceInterfaceIdAndServiceInstanceId(String serviceInterfaceId, String serviceInstanceId, boolean ignoreRuntimeInterfaces, boolean ignorePageTemplates, ITransaction transaction) Get a list of ids given the id of the service's interface and the id of the service's instance.
Collection<String>	getIdsByServiceInterfaceIdAndServiceInstanceId(String serviceInterfaceId, String serviceInstanceId, boolean ignoreRuntimeInterfaces, ITransaction transaction) Get a list of ids given the id of the service's interface and the id of the service's instance.
Collection<String>	getIdsByServiceInterfaceStyleId(String serviceInterfaceStyleId, String serviceInterfaceId, ITransaction daoTransaction) Get the id given the id of the service's interface's style.
Collection<String>	getPageInterfaceInstanceIds(String pageId, ITransaction daoTransaction) Get the ids of the page's interface's instance.
ServiceInterfaceInstanceConfig	getRunTimeInstance(String serviceInterfaceId, String serviceInstanceId, String pagetId, ITransaction daoTransaction) Get the runtime instance.
boolean	setCustomProperty(String interfaceInstanceId, String name, String value, ITransaction daoTransaction) Set the custom property of the service's interface's instance.
void	update(ServiceInterfaceInstanceConfig serviceInterfaceInstance, ITransaction daoTransaction) Update the service's interface's instance.

Method Detail

get

ServiceInterfaceInstanceConfig get(String interfaceInstanceId,
                                   ITransaction daoTransaction)
                            throws DaoException,
                                   PortalException

Get the service's interface's instance.

Parameters:

interfaceInstanceId -

daoTransaction -

Returns:

Throws:

DaoException

PortalException

add

void add(ServiceInterfaceInstanceConfig serviceInterfaceInstance,
         ITransaction daoTransaction)
  throws DaoException,
         PortalException

Add the service's interface's instance.

Parameters:

serviceInterfaceInstance -

daoTransaction -

Throws:

DaoException

PortalException

update

void update(ServiceInterfaceInstanceConfig serviceInterfaceInstance,
            ITransaction daoTransaction)
     throws DaoException,
            PortalException

Update the service's interface's instance.

Parameters:

serviceInterfaceInstance -

daoTransaction -

Throws:

DaoException

PortalException

delete

void delete(String serviceInterfaceInstanceId,
            ITransaction daoTransaction)
     throws DaoException,
            PortalException

Delete the service's interface's instance.

Parameters:

serviceInterfaceInstanceId -

daoTransaction -

Throws:

DaoException

PortalException

getRunTimeInstance

ServiceInterfaceInstanceConfig getRunTimeInstance(String serviceInterfaceId,
                                                  String serviceInstanceId,
                                                  String pagetId,
                                                  ITransaction daoTransaction)
                                           throws DaoException,
                                                  PortalException

Get the runtime instance.

Parameters:

serviceInterfaceId -

serviceInstanceId -

pagetId -

daoTransaction -

Returns:

Throws:

DaoException

PortalException

getPageInterfaceInstanceIds

Collection<String> getPageInterfaceInstanceIds(String pageId,
                                               ITransaction daoTransaction)
                                        throws DaoException,
                                               PortalException

Get the ids of the page's interface's instance.

Parameters:

pageId -

daoTransaction -

Returns:

Throws:

DaoException

PortalException

getIdsByServiceInterfaceId

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

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

Parameters:

serviceInterfaceId -

ignoreRuntimeInterfaces -

transaction -

Returns:

Throws:

DaoException

PortalException

getIdsByServiceInterfaceId

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

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

Parameters:

serviceInterfaceId -

ignoreRuntimeInterfaces -

ignorePageTemplates - TODO

transaction -

Returns:

Throws:

DaoException

PortalException

getIdsByServiceInstanceId

Collection<String> getIdsByServiceInstanceId(String serviceInstanceId,
                                             boolean ignoreRuntimeInterfaces,
                                             ITransaction transaction)
                                      throws DaoException,
                                             PortalException

Get a list of ids given the id of the id of the service's instance.

Parameters:

serviceInstanceId -

ignoreRuntimeInterfaces -

transaction -

Returns:

Throws:

DaoException

PortalException

getIdsByServiceInterfaceIdAndServiceInstanceId

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

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

Parameters:

serviceInterfaceId -

serviceInstanceId -

ignoreRuntimeInterfaces - TODO

transaction -

Returns:

Throws:

DaoException

PortalException

getIdsByServiceInterfaceIdAndServiceInstanceId

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

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

Parameters:

serviceInterfaceId -

serviceInstanceId -

ignoreRuntimeInterfaces - TODO

ignorePageTemplates - TODO

transaction -

Returns:

Throws:

DaoException

PortalException

getIdsByServiceInterfaceStyleId

Collection<String> getIdsByServiceInterfaceStyleId(String serviceInterfaceStyleId,
                                                   String serviceInterfaceId,
                                                   ITransaction daoTransaction)
                                            throws DaoException,
                                                   PortalException

Get the id given the id of the service's interface's style.

Parameters:

serviceInterfaceStyleId -

daoTransaction -

Returns:

Throws:

DaoException

PortalException

getCustomProperty

String getCustomProperty(String interfaceInstanceId,
                         String name,
                         ITransaction daoTransaction)
                  throws DaoException,
                         PortalException

Get the custom property of the service's interface's instance.

Parameters:

interfaceInstanceId -

name -

daoTransaction -

Returns:

Throws:

DaoException

PortalException

getCustomProperties

HashMap<String,String> getCustomProperties(String interfaceInstanceId,
                                           ITransaction daoTransaction)
                                    throws DaoException,
                                           PortalException

Get all custom properties of the specified service insterface instance.

Parameters:

interfaceInstanceId -

daoTransaction -

Returns:

Throws:

DaoException

PortalException

setCustomProperty

boolean setCustomProperty(String interfaceInstanceId,
                          String name,
                          String value,
                          ITransaction daoTransaction)
                   throws DaoException,
                          PortalException

Set the custom property of the service's interface's instance.

Parameters:

interfaceInstanceId -

name -

value -

daoTransaction -

Returns:

true if a modification was done by this method in the persistence, false if the value was already set.

Throws:

DaoException

PortalException

deleteCustomProperties

void deleteCustomProperties(String interfaceInstanceId,
                            ITransaction daoTransaction)
                     throws DaoException,
                            PortalException

Delete the custom propertires of the service's interface's instance.

Parameters:

interfaceInstanceId -

daoTransaction -

Throws:

DaoException

PortalException

deleteCustomProperty

boolean deleteCustomProperty(String interfaceInstanceId,
                             String name,
                             ITransaction daoTransaction)
                      throws DaoException,
                             PortalException

Delete a custom property of the service's interface's instance.

Parameters:

interfaceInstanceId -

name -

daoTransaction -

Returns:

true if the property was deleted, false if the property was not found.

Throws:

DaoException

PortalException

getIdsByInterfaceStyleId

List<String> getIdsByInterfaceStyleId(String interfaceStyleId,
                                      ITransaction daoTransaction)
                               throws DaoException,
                                      PortalException

Returns a list of ids of interface instances that uses the given interface style id.

Parameters:

interfaceStyleId - identifier of the style to be used on the search to filter the interface instances.

daoTransaction - the transaction for persistence access.

Returns:

a list of ids of interface instances that uses the given interface style id.

Throws:

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

PortalException - if any error occurs during the process.

Since:

6.2.0

getIdsByBaseInterfaceInstanceId

List<String> getIdsByBaseInterfaceInstanceId(String interfaceInstanceId,
                                             ITransaction daoTransaction)
                                      throws DaoException,
                                             PortalException

Returns a list of ids of interface instances that have the given base interface instance id.

Parameters:

interfaceInstanceId - identifier of the interface instance to be used on the search to filter the interface instances.

daoTransaction - the transaction for persistence access.

Returns:

a list of ids of interface instances that uses the givenbase interface instance id.

Throws:

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

PortalException - if any error occurs during the process.

Since:

11.0.0