Package lumis.portal.serviceinterfaceinstance

Interface IServiceInterfaceInstanceDao

  • All Known Implementing Classes:
    ServiceInterfaceInstanceDaoJdbc
    public interface IServiceInterfaceInstanceDao
    DAO for service interface instance
    Since:
    4.0.0
    Version:
    $Revision$ $Date$

    • Method Summary

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

      • getIdsByServiceInterfaceId

        java.util.Collection<java.lang.String> getIdsByServiceInterfaceId​(java.lang.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

        java.util.Collection<java.lang.String> getIdsByServiceInterfaceId​(java.lang.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

        java.util.Collection<java.lang.String> getIdsByServiceInstanceId​(java.lang.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

        java.util.Collection<java.lang.String> getIdsByServiceInterfaceIdAndServiceInstanceId​(java.lang.String serviceInterfaceId,
                                                                                      java.lang.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

        java.util.Collection<java.lang.String> getIdsByServiceInterfaceIdAndServiceInstanceId​(java.lang.String serviceInterfaceId,
                                                                                      java.lang.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

        java.util.Collection<java.lang.String> getIdsByServiceInterfaceStyleId​(java.lang.String serviceInterfaceStyleId,
                                                                       java.lang.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

        java.lang.String getCustomProperty​(java.lang.String interfaceInstanceId,
                                   java.lang.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

        java.util.HashMap<java.lang.String,​java.lang.String> getCustomProperties​(java.lang.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​(java.lang.String interfaceInstanceId,
                          java.lang.String name,
                          java.lang.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

      • deleteCustomProperty

        boolean deleteCustomProperty​(java.lang.String interfaceInstanceId,
                             java.lang.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

        java.util.List<java.lang.String> getIdsByInterfaceStyleId​(java.lang.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

        java.util.List<java.lang.String> getIdsByBaseInterfaceInstanceId​(java.lang.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