Package lumis.portal.serviceinterfaceinstance

Interface IServiceInterfaceInstanceManager

    • Method Detail

      • copy

        java.lang.String copy​(SessionConfig sessionConfig,
                      java.lang.String sourceServiceInterfaceInstanceId,
                      java.lang.String destinationPageId,
                      boolean destinationInterfaceInstanceIsFromTemplate,
                      ITransaction transaction)
               throws ManagerException,
                      PortalException
        Creates a copy of the given interface instance to the specified page. All interface instance custom properties are copied to the new interface instance.
        Parameters:
        sessionConfig -
        sourceServiceInterfaceInstanceId -
        destinationPageId -
        transaction -
        Returns:
        a String.
        Throws:
        ManagerException
        PortalException

      • getIdsByServiceInstanceId

        java.util.Collection<java.lang.String> getIdsByServiceInstanceId​(SessionConfig sessionConfig,
                                                                 java.lang.String serviceInstanceId,
                                                                 boolean includeRunTimeInterfaces,
                                                                 ITransaction transaction)
                                                          throws ManagerException,
                                                                 PortalException
        Get the Ids given the ServiceInstanceId.
        Parameters:
        sessionConfig -
        serviceInstanceId -
        includeRunTimeInterfaces -
        transaction -
        Returns:
        a array of Strings.
        Throws:
        ManagerException
        PortalException

      • getIdsByServiceInterfaceIdAndServiceInstanceId

        java.util.Collection<java.lang.String> getIdsByServiceInterfaceIdAndServiceInstanceId​(SessionConfig sessionConfig,
                                                                                      java.lang.String serviceInterfaceId,
                                                                                      java.lang.String serviceInstanceId,
                                                                                      boolean ignoreRuntimeInterfaces,
                                                                                      ITransaction transaction)
                                                                               throws ManagerException,
                                                                                      PortalException
        Get a list of ids by passing the ids of service interface and the service instance.
        Parameters:
        sessionConfig -
        serviceInterfaceId -
        serviceInstanceId -
        ignoreRuntimeInterfaces -
        transaction -
        Returns:
        a array of Strings.
        Throws:
        ManagerException
        PortalException

      • getIdsByServiceInterfaceIdAndServiceInstanceId

        java.util.Collection<java.lang.String> getIdsByServiceInterfaceIdAndServiceInstanceId​(SessionConfig sessionConfig,
                                                                                      java.lang.String serviceInterfaceId,
                                                                                      java.lang.String serviceInstanceId,
                                                                                      boolean ignoreRuntimeInterfaces,
                                                                                      boolean ignorePageTemplates,
                                                                                      ITransaction transaction)
                                                                               throws ManagerException,
                                                                                      PortalException
        Get a list of ids by passing the ids of service interface and the service instance.
        Parameters:
        sessionConfig -
        serviceInterfaceId -
        serviceInstanceId -
        ignoreRuntimeInterfaces -
        ignorePageTemplates - TODO
        transaction -
        Returns:
        a array of Strings.
        Throws:
        ManagerException
        PortalException

      • getIdsByServiceInterfaceId

        java.util.Collection<java.lang.String> getIdsByServiceInterfaceId​(SessionConfig sessionConfig,
                                                                  java.lang.String serviceInterfaceId,
                                                                  boolean ignoreRuntimeInterfaces,
                                                                  ITransaction transaction)
                                                           throws ManagerException,
                                                                  PortalException
        Get a list of ids by passing the ids of the service interface.
        Parameters:
        sessionConfig -
        serviceInterfaceId -
        ignoreRuntimeInterfaces -
        transaction -
        Returns:
        a arrays of Strings.
        Throws:
        ManagerException
        PortalException

      • getIdsByServiceInterfaceId

        java.util.Collection<java.lang.String> getIdsByServiceInterfaceId​(SessionConfig sessionConfig,
                                                                  java.lang.String serviceInterfaceId,
                                                                  boolean ignoreRuntimeInterfaces,
                                                                  boolean ignorePageTemplates,
                                                                  ITransaction transaction)
                                                           throws ManagerException,
                                                                  PortalException
        Get a list of ids by passing the ids of the service interface.
        Parameters:
        sessionConfig -
        serviceInterfaceId -
        ignoreRuntimeInterfaces -
        ignorePageTemplates - TODO
        transaction -
        Returns:
        a arrays of Strings.
        Throws:
        ManagerException
        PortalException

      • getIdsByServiceInterfaceStyleId

        java.util.Collection<java.lang.String> getIdsByServiceInterfaceStyleId​(SessionConfig sessionConfig,
                                                                       java.lang.String serviceInterfaceStyleId,
                                                                       java.lang.String serviceInterfaceId,
                                                                       ITransaction transaction)
                                                                throws ManagerException,
                                                                       PortalException
        Get the Ids given the ServiceInterfaceStyleId.
        Parameters:
        sessionConfig -
        serviceInterfaceStyleId -
        serviceInterfaceId -
        transaction -
        Returns:
        a arrays of Strings.
        Throws:
        ManagerException
        PortalException

      • setCustomProperty

        void setCustomProperty​(SessionConfig sessionConfig,
                       java.lang.String interfaceInstanceId,
                       java.lang.String name,
                       java.lang.String value,
                       ITransaction transaction)
                throws ManagerException,
                       PortalException
        Set a custom property for the given interface instance. If the property has been previously set, this method replaces the previous value, else a new property is created for the interface instance. If the property value is null or empty the property is removed.
        Parameters:
        sessionConfig - the user session information.
        interfaceInstanceId - the service interface instance id.
        name - the property name.
        value - the property value.
        transaction - the transaction for persistence access.
        Throws:
        ManagerException
        PortalException

      • setCustomProperties

        void setCustomProperties​(SessionConfig sessionConfig,
                         java.lang.String interfaceInstanceId,
                         java.util.Map<java.lang.String,​java.lang.String> propertiesTable,
                         ITransaction transaction)
                  throws ManagerException,
                         PortalException
        Receives a Map with one or more properties to be set for the given interface. If the property has been previously set, this method replaces the previous value, else a new property is created for the interface instance. If the property value is null or empty the property is removed.
        Parameters:
        sessionConfig - the user session information.
        interfaceInstanceId - the service interface instance id.
        propertiesTable - the map with the properties.
        transaction - the transaction for persistence access.
        Throws:
        ManagerException
        PortalException

      • getCustomProperty

        java.lang.String getCustomProperty​(SessionConfig sessionConfig,
                                   java.lang.String interfaceInstanceId,
                                   java.lang.String name,
                                   ITransaction transaction)
                            throws ManagerException,
                                   PortalException
        Returns the specified custom property. If the property has not been set earlier, null is returned.
        Parameters:
        sessionConfig -
        interfaceInstanceId -
        name -
        transaction -
        Returns:
        a String.
        Throws:
        ManagerException
        PortalException

      • getCustomProperties

        java.util.Map<java.lang.String,​java.lang.String> getCustomProperties​(SessionConfig sessionConfig,
                                                                           java.lang.String interfaceInstanceId,
                                                                           ITransaction transaction)
                                                                    throws ManagerException,
                                                                           PortalException
        Returns a Map containing all name/value pairs of custom properties from the specified service interface instance.
        Parameters:
        sessionConfig - the user session information.
        interfaceInstanceId - the service interface instance id.
        transaction - the transaction for persistence access.
        Returns:
        the map with the properties.
        Throws:
        ManagerException
        PortalException

      • getMenuXml

        java.lang.String getMenuXml​(SessionConfig sessionConfig,
                            java.lang.String serviceInterfaceInstanceId,
                            ServiceInterfaceMenuLevel menuLevel,
                            ITransaction transaction)
                     throws PortalException
        Returns the XML for the menu for the specified service interface instance and menu level.
        Parameters:
        sessionConfig - the user session information.
        serviceInterfaceInstanceId - the identifier of the service interface instance.
        menuLevel - the menu level.
        transaction - transaction for persistence access.
        Returns:
        a XML with the menu items available.
        Throws:
        PortalException
        Since:
        10.2.0

      • getXmlData

        java.lang.String getXmlData​(SessionConfig sessionConfig,
                            java.lang.String serviceInterfaceInstanceId)
                     throws ManagerException,
                            PortalException
        Returns the previously saved XML data for the service interface instance for the given user session
        Parameters:
        sessionConfig -
        serviceInterfaceInstanceId -
        transaction -
        Returns:
        a String.
        Throws:
        ManagerException
        PortalException

      • getPrintable

        boolean getPrintable​(SessionConfig sessionConfig,
                     java.lang.String serviceInterfaceInstanceId,
                     ITransaction transaction)
              throws ManagerException,
                     PortalException
        Returns the printable property of an interface instance. It may be necessary to look at the interface definition
        Parameters:
        sessionConfig -
        serviceInterfaceInstanceId -
        transaction -
        Returns:
        true if ServiceInterface is printable and false otherwise.
        Throws:
        ManagerException
        PortalException

      • getEnableCache

        boolean getEnableCache​(SessionConfig sessionConfig,
                       java.lang.String serviceInterfaceInstanceId,
                       ITransaction transaction)
                throws ManagerException,
                       PortalException
        Returns the enableCache property of an interface instance. It may be necessary to look at the interface definition
        Parameters:
        sessionConfig -
        serviceInterfaceInstanceId -
        transaction -
        Returns:
        true if the Cache is enable.
        Throws:
        ManagerException
        PortalException

      • getCachePersonalization

        int getCachePersonalization​(SessionConfig sessionConfig,
                            java.lang.String serviceInterfaceInstanceId,
                            ITransaction transaction)
                     throws ManagerException,
                            PortalException
        Returns the cachePersonalization property of an interface instance. It may be necessary to look at the interface definition
        Parameters:
        sessionConfig -
        serviceInterfaceInstanceId -
        transaction -
        Returns:
        an integer.
        Throws:
        ManagerException
        PortalException

      • getCacheServerSideInclude

        boolean getCacheServerSideInclude​(SessionConfig sessionConfig,
                                  java.lang.String serviceInterfaceInstanceId,
                                  ITransaction transaction)
                           throws ManagerException,
                                  PortalException
        Returns the cacheServerSideInclude property of an interface instance. It may be necessary to look at the interface definition
        Parameters:
        sessionConfig -
        serviceInterfaceInstanceId -
        transaction -
        Returns:
        true if the ... and false otherwise.
        Throws:
        ManagerException
        PortalException

      • clearCache

        void clearCache​(SessionConfig sessionConfig,
                java.lang.String serviceInterfaceInstanceId,
                ITransaction transaction)
         throws ManagerException,
                PortalException
        Clears the caches of a service interface instance.

        Clears service interface instance related information, cached in this manager, including HTML cache, and its XSL cache.

        Parameters:
        sessionConfig - the user session information.
        serviceInterfaceInstanceId - the service interface instance identifier.
        transaction - the transaction for persistence access.
        Throws:
        ManagerException
        PortalException

      • setInterfaceInstanceHtmlCache

        void setInterfaceInstanceHtmlCache​(SessionConfig sessionConfig,
                                   java.lang.String serviceInterfaceInstanceId,
                                   java.util.Locale locale,
                                   java.lang.String serviceInterfaceInstanceHtml,
                                   ITransaction transaction)
                            throws ManagerException,
                                   PortalException
        Deprecated.
        since 7.0.0 deprecated without replacement. LumisXP manages interface instance caches transparently and solutions should not interfere.
        Get the HTML Cache of the Interface Instance.
        Parameters:
        sessionConfig -
        serviceInterfaceInstanceId -
        locale -
        serviceInterfaceInstanceHtml -
        transaction -
        Throws:
        ManagerException
        PortalException

      • getInterfaceInstanceHtmlCache

        java.lang.String getInterfaceInstanceHtmlCache​(SessionConfig sessionConfig,
                                               java.lang.String serviceInterfaceInstanceId,
                                               java.util.Locale locale,
                                               ITransaction transaction)
                                        throws ManagerException,
                                               PortalException
        Deprecated.
        since 7.0.0 deprecated without replacement. LumisXP manages interface instance caches transparently and solutions should not interfere.
        Get the HTML Cache of the Interface Instance.
        Parameters:
        sessionConfig -
        serviceInterfaceInstanceId -
        locale -
        transaction -
        Returns:
        Throws:
        ManagerException
        PortalException

      • getServiceInterfaceInstanceStyleConfigKeyChecker

        IConfigKeyChecker getServiceInterfaceInstanceStyleConfigKeyChecker()

      • getTitle

        java.lang.String getTitle​(ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig,
                          ITransaction transaction)
                   throws PortalException
        Returns the title for a service interface instance. The title is calculated from the service interface instance and the service interface properties/definitions.
        Parameters:
        serviceInterfaceInstanceConfig - the service interface instance.
        transaction - the transaction for persistence access.
        Returns:
        the title. May be a localizable string.
        Throws:
        PortalException
        Since:
        5.5.0

      • getDisplayName

        java.lang.String getDisplayName​(ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig,
                                ITransaction transaction)
                         throws PortalException
        Returns the display name for a service interface instance. The display name is calculated from the service interface instance and the service interface properties/definitions.
        Parameters:
        serviceInterfaceInstanceConfig - the service interface instance.
        transaction - the transaction for persistence access.
        Returns:
        the display name. May be a localizable string.
        Throws:
        PortalException
        Since:
        5.5.0