lumis.portal.serviceinstance
Interface IServiceInstanceDao

Package class diagram package IServiceInstanceDao
All Known Implementing Classes:
ServiceInstanceDaoHib, ServiceInstanceDaoJdbc

public interface IServiceInstanceDao


Method Summary
 void add(ServiceInstanceConfig serviceInstanceConfig, ITransaction transaction)
          Add the service's instance.
 void addServiceInstanceDependency(ServiceInstanceDependencyConfig serviceInstanceDependencyConfig, ITransaction transaction)
          Add the given service instance dependency to the persistence.
 void delete(String serviceInstanceId, ITransaction transaction)
          Delete the service's instance.
 void deleteCustomProperties(String serviceInstanceId, ITransaction daoTransaction)
          Delete all service instance´s custom properties.
 void deleteCustomProperty(String serviceInstanceId, String name, ITransaction daoTransaction)
          Delete a service instance´s custom property.
 ServiceInstanceConfig get(String serviceInstanceId, ITransaction transaction)
          Get the service's instance.
 List<IChannelChild> getChannelsChildren(String parentChannelIds, boolean hideItems, String serviceId, IResource resource, Locale locale, ITransaction transaction)
           
 List<IChannelChild> getChildrenData(String channelId, int hidePages, String serviceId, IResource resource, Locale locale, ITransaction transaction)
           
 HashMap<String,String> getCustomProperties(String serviceInstanceId, ITransaction daoTransaction)
          Get all service instance's custom properties.
 String getCustomProperty(String serviceInstanceId, String name, ITransaction daoTransaction)
          Get service instance´s custom property.
 Collection<String> getDependencyIdsByServiceInstanceId(String serviceInstanceId, ITransaction transaction)
          Get the ids of all the service instances that the given service instance depends on
 Collection<String> getIdsByChannelIdAndServiceId(String channelId, String serviceId, ITransaction transaction)
          Get a list of ids in a given channel and of a given service.
 Collection<String> getIdsByServiceInstanceAndDependencyType(String serviceInstanceId, String dependencyType, ITransaction transaction)
          Get the ids of the service instances that the given service instance depends on by the given dependency type.
 Collection<String> getIdsOfDependentServiceInstances(String serviceInstanceId, ITransaction transaction)
          Get the ids of all service instances that depends on the given service instance.
 ServiceInstanceDependencyConfig getServiceInstanceDependency(String dependencyId, ITransaction transaction)
          Get a ServiceInstanceDependencyConfig by the dependencyId.
 void removeServiceInstanceDependencies(String dependentServiceInstanceId, String dependencyType, ITransaction transaction)
          Remove the service instance dependencies that matches the dependent service instance id and dependency type given.
 void setCustomProperty(String serviceInstanceId, String name, String value, ITransaction daoTransaction)
          Set service instance´s custom property.
 void update(ServiceInstanceConfig serviceInstanceConfig, ITransaction transaction)
          Update the service's instance.
 

Method Detail

get

ServiceInstanceConfig get(String serviceInstanceId,
                          ITransaction transaction)
                          throws DaoException,
                                 PortalException
Get the service's instance.

Parameters:
serviceInstanceId -
transaction -
Returns:
Throws:
DaoException
PortalException

add

void add(ServiceInstanceConfig serviceInstanceConfig,
         ITransaction transaction)
         throws DaoException,
                PortalException
Add the service's instance.

Parameters:
serviceInstanceConfig -
transaction -
Throws:
DaoException
PortalException

update

void update(ServiceInstanceConfig serviceInstanceConfig,
            ITransaction transaction)
            throws DaoException,
                   PortalException
Update the service's instance.

Parameters:
serviceInstanceConfig -
transaction -
Throws:
DaoException
PortalException

delete

void delete(String serviceInstanceId,
            ITransaction transaction)
            throws DaoException,
                   PortalException
Delete the service's instance.

Parameters:
serviceInstanceId -
transaction -
Throws:
DaoException
PortalException

getIdsByChannelIdAndServiceId

Collection<String> getIdsByChannelIdAndServiceId(String channelId,
                                                 String serviceId,
                                                 ITransaction transaction)
                                                 throws DaoException,
                                                        PortalException
Get a list of ids in a given channel and of a given service. The channel or the service may be ommitted. In this case only the other condition will select the returned ids.

Parameters:
channelId -
serviceId -
transaction -
Returns:
Throws:
DaoException
PortalException

getCustomProperty

String getCustomProperty(String serviceInstanceId,
                         String name,
                         ITransaction daoTransaction)
                         throws DaoException,
                                PortalException
Get service instance´s custom property.

Parameters:
serviceInstanceId -
name -
transaction -
Returns:
Throws:
DaoException
PortalException

getCustomProperties

HashMap<String,String> getCustomProperties(String serviceInstanceId,
                                           ITransaction daoTransaction)
                                           throws DaoException,
                                                  PortalException
Get all service instance's custom properties.

Parameters:
serviceInstanceId -
daoTransaction -
Returns:
Throws:
DaoException
PortalException
Since:
4.0.3

setCustomProperty

void setCustomProperty(String serviceInstanceId,
                       String name,
                       String value,
                       ITransaction daoTransaction)
                       throws DaoException,
                              PortalException
Set service instance´s custom property.

Parameters:
serviceInstanceId -
name -
value -
transaction -
Throws:
DaoException
PortalException

deleteCustomProperty

void deleteCustomProperty(String serviceInstanceId,
                          String name,
                          ITransaction daoTransaction)
                          throws DaoException,
                                 PortalException
Delete a service instance´s custom property.

Parameters:
serviceInstanceId -
name -
transaction -
Throws:
DaoException
PortalException

deleteCustomProperties

void deleteCustomProperties(String serviceInstanceId,
                            ITransaction daoTransaction)
                            throws DaoException,
                                   PortalException
Delete all service instance´s custom properties.

Parameters:
serviceInstanceId -
transaction -
Throws:
DaoException
PortalException

getIdsOfDependentServiceInstances

Collection<String> getIdsOfDependentServiceInstances(String serviceInstanceId,
                                                     ITransaction transaction)
                                                     throws PortalException
Get the ids of all service instances that depends on the given service instance.

Parameters:
serviceInstanceId - the service instance the returned service instances depend on.
transaction - the transaction for persistence access.
Returns:
the dependent service instances.
Throws:
PortalException

getIdsByServiceInstanceAndDependencyType

Collection<String> getIdsByServiceInstanceAndDependencyType(String serviceInstanceId,
                                                            String dependencyType,
                                                            ITransaction transaction)
                                                            throws DaoException,
                                                                   PortalException
Get the ids of the service instances that the given service instance depends on by the given dependency type.

Parameters:
serviceInstanceId - the id of the service instance that depends on the returned service instances.
dependencyType - the type of dependency.
transaction - the transaction for persistence access.
Returns:
the ids of the service instances that the given service instance depends on by the given dependency type.
Throws:
ManagerException
PortalException
DaoException

addServiceInstanceDependency

void addServiceInstanceDependency(ServiceInstanceDependencyConfig serviceInstanceDependencyConfig,
                                  ITransaction transaction)
                                  throws PortalException
Add the given service instance dependency to the persistence.

Parameters:
serviceInstanceDependencyConfig - the information about the dependency to be added.
transaction - the transaction for persistence access.
Throws:
PortalException

removeServiceInstanceDependencies

void removeServiceInstanceDependencies(String dependentServiceInstanceId,
                                       String dependencyType,
                                       ITransaction transaction)
                                       throws PortalException
Remove the service instance dependencies that matches the dependent service instance id and dependency type given.

Parameters:
dependentServiceInstanceId -
dependencyType -
transaction -
Throws:
PortalException

getChildrenData

List<IChannelChild> getChildrenData(String channelId,
                                    int hidePages,
                                    String serviceId,
                                    IResource resource,
                                    Locale locale,
                                    ITransaction transaction)
                                    throws DaoException,
                                           PortalException
Throws:
DaoException
PortalException

getChannelsChildren

List<IChannelChild> getChannelsChildren(String parentChannelIds,
                                        boolean hideItems,
                                        String serviceId,
                                        IResource resource,
                                        Locale locale,
                                        ITransaction transaction)
                                        throws PortalException
Throws:
PortalException

getDependencyIdsByServiceInstanceId

Collection<String> getDependencyIdsByServiceInstanceId(String serviceInstanceId,
                                                       ITransaction transaction)
                                                       throws DaoException,
                                                              PortalException
Get the ids of all the service instances that the given service instance depends on

Parameters:
serviceInstanceId -
transaction -
Returns:
the ids of the service instances that the given service instance depends on.
Throws:
DaoException
PortalException

getServiceInstanceDependency

ServiceInstanceDependencyConfig getServiceInstanceDependency(String dependencyId,
                                                             ITransaction transaction)
                                                             throws DaoException,
                                                                    PortalException
Get a ServiceInstanceDependencyConfig by the dependencyId.

Parameters:
dependencyId -
transaction -
Returns:
The ServiceInstanceDependencyConfig
Throws:
DaoException
PortalException


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