Class ServiceInterfaceConfig


  • @StableMinor(version="14.1",
                 sinceVersion="4.0")
    public class ServiceInterfaceConfig
    extends Object
    Holds information about a service interface.
    Since:
    4.0.0
    Version:
    $Revision: 24683 $ $Date: 2021-08-23 18:55:58 -0300 (Mon, 23 Aug 2021) $
    • Field Detail

      • RENDER_AS_CLIENT_SIDE_SCRIPT_DEFINITION_VALUE

        public static final String RENDER_AS_CLIENT_SIDE_SCRIPT_DEFINITION_VALUE
        See Also:
        Constant Field Values
      • RENDER_AS_CLIENT_SIDE_SCRIPT_VALUE

        public static final int RENDER_AS_CLIENT_SIDE_SCRIPT_VALUE
        See Also:
        Constant Field Values
      • CACHE_LEVEL_LOCAL_VALUE

        public static final int CACHE_LEVEL_LOCAL_VALUE
        See Also:
        Constant Field Values
      • CACHE_LEVEL_PAGE_TEMPLATE_DEFINITION_VALUE

        public static final String CACHE_LEVEL_PAGE_TEMPLATE_DEFINITION_VALUE
        See Also:
        Constant Field Values
      • CACHE_LEVEL_PAGE_TEMPLATE_VALUE

        public static final int CACHE_LEVEL_PAGE_TEMPLATE_VALUE
        See Also:
        Constant Field Values
      • CACHE_PERSONALIZATION_NONE_DEFINITION_VALUE

        public static final String CACHE_PERSONALIZATION_NONE_DEFINITION_VALUE
        See Also:
        Constant Field Values
      • CACHE_PERSONALIZATION_NONE_VALUE

        public static final int CACHE_PERSONALIZATION_NONE_VALUE
        See Also:
        Constant Field Values
      • CACHE_PERSONALIZATION_GUEST_ONLY_DEFINITION_VALUE

        public static final String CACHE_PERSONALIZATION_GUEST_ONLY_DEFINITION_VALUE
        See Also:
        Constant Field Values
      • CACHE_PERSONALIZATION_GUEST_ONLY_VALUE

        public static final int CACHE_PERSONALIZATION_GUEST_ONLY_VALUE
        See Also:
        Constant Field Values
      • CACHE_PERSONALIZATION_PER_USER_DEFINITION_VALUE

        public static final String CACHE_PERSONALIZATION_PER_USER_DEFINITION_VALUE
        See Also:
        Constant Field Values
      • CACHE_PERSONALIZATION_PER_USER_VALUE

        public static final int CACHE_PERSONALIZATION_PER_USER_VALUE
        See Also:
        Constant Field Values
    • Constructor Detail

      • ServiceInterfaceConfig

        public ServiceInterfaceConfig()
    • Method Detail

      • setDefinitionNode

        public void setDefinitionNode​(Node interfaceXmlNode)
                               throws PortalException
        Parameters:
        definition - The definition to set.
        Throws:
        PortalException
      • getId

        public String getId()
        Returns:
        Returns the id.
      • setId

        public void setId​(String id)
      • getRelativeId

        public String getRelativeId()
      • getBaseUrl

        public String getBaseUrl()
        Returns:
        Returns the id.
      • setBaseUrl

        public void setBaseUrl​(String baseUrl)
      • getStringsUrlPrefixes

        public List<String> getStringsUrlPrefixes()
        Returns:
        Returns the stringsUrlPrefix array.
      • getStringsUrlPrefix

        public String getStringsUrlPrefix()
        Returns:
        Returns the first (main) stringsUrlPrefix.
      • setStringsUrlPrefix

        public void setStringsUrlPrefix​(String stringsUrlPrefix)
      • getName

        public String getName()
        Returns:
        Returns the name.
      • setName

        public void setName​(String name)
      • getDescription

        public String getDescription()
        Returns:
        Returns the description.
      • setDescription

        public void setDescription​(String description)
      • getServiceId

        public String getServiceId()
        Returns:
        Returns the serviceId.
      • setServiceId

        public void setServiceId​(String serviceId)
      • getPropertyNames

        public Enumeration getPropertyNames()
      • getExtendedProperty

        public String getExtendedProperty​(String name)
      • getExtendedPropertyNames

        public Enumeration getExtendedPropertyNames()
      • getImplementationClass

        public String getImplementationClass()
      • getInterfaceType

        public String getInterfaceType()
      • isRuntimeOnly

        public boolean isRuntimeOnly()
        Returns:
        Returns the isRuntimeOnly.
      • setRuntimeOnly

        public void setRuntimeOnly​(boolean isRuntimeOnly)
        Parameters:
        isRuntimeOnly - The isRuntimeOnly to set.
      • isAdministration

        public boolean isAdministration()
        Returns:
        Returns the isAdministration.
      • setAdministration

        public void setAdministration​(boolean isAdministration)
        Parameters:
        isAdministration - The isAdministration to set.
      • isDetails

        public boolean isDetails()
      • setDetails

        public void setDetails​(boolean isDetails)
      • isList

        public boolean isList()
      • isSummary

        public boolean isSummary()
        Indicates whether the interface represents a summary interface. Typically summary interfaces are placed in home/landing pages.
        Returns:
        true if this interface represents a summary interface.
      • isPrintable

        public boolean isPrintable()
        Returns:
        Returns the isPrintable.
      • setPrintable

        public void setPrintable​(boolean isPrintable)
        Parameters:
        isPrintable - The isPrintable to set.
      • getRenderAs

        public int getRenderAs()
        Returns:
        Returns the renderAs.
      • setRenderAs

        public void setRenderAs​(int renderAs)
        Parameters:
        renderAs - The renderAs to set.
      • isEnableCache

        public boolean isEnableCache()
        Returns:
        Returns the enableCache.
      • setEnableCache

        public void setEnableCache​(boolean enableCache)
        Parameters:
        enableCache - The enableCache to set.
      • getCacheLevel

        public int getCacheLevel()
        Returns:
        Returns the cacheLevel.
      • setCacheLevel

        public void setCacheLevel​(int cacheLevel)
        Parameters:
        cacheLevel - The cacheLevel to set.
      • getCachePersonalization

        public int getCachePersonalization()
        Returns:
        Returns the cachePersonalization.
      • setCachePersonalization

        public void setCachePersonalization​(int cachePersonalization)
        Parameters:
        cachePersonalization - The cachePersonalization to set.
      • isCacheServerSideInclude

        public boolean isCacheServerSideInclude()
        Returns:
        Returns the cacheServerSideInclude.
      • setCacheServerSideInclude

        public void setCacheServerSideInclude​(boolean cacheServerSideInclude)
        Parameters:
        cacheServerSideInclude - The cacheServerSideInclude to set.
      • getTitle

        public String getTitle()
      • setTitle

        public void setTitle​(String title)
      • isPreviewSupported

        public boolean isPreviewSupported()
      • setPreviewSupported

        public void setPreviewSupported​(boolean previewSupported)
      • isInContextEditSupported

        public boolean isInContextEditSupported()
      • setServiceInstanceRequired

        public void setServiceInstanceRequired​(boolean serviceInstanceRequired)
        Indicates whether this interface requires or not a service instance to be executed.
        Parameters:
        serviceInstanceRequired - Indicates whether this interface requires or not a service instance to be executed.
        Since:
        5.6.0
      • isServiceInstanceRequired

        public boolean isServiceInstanceRequired()
        Returns whether this interface requires or not a service instance to be executed.
        Returns:
        whether this interface requires or not a service instance to be executed.
        Since:
        5.6.0
      • isCallerServiceInterfaceMenuItemRequired

        public boolean isCallerServiceInterfaceMenuItemRequired()
        Returns whether this interface requires or not a caller service Interface menu item
        Returns:
        whether this interface requires or not a caller service Interface menu item
        Since:
        10.2.0
      • getSupportedModes

        public List<PortletMode> getSupportedModes()
        Returns a unmodifiable list with the supported modes for this interface. The list contains the modes in the same order they were defined in the interface definition.
        Returns:
        a unmodifiable list with the supported modes for this interface.
        Since:
        4.0.7
      • setIsWidget

        public void setIsWidget​(boolean isWidget)
        Sets the isWidget.
        Parameters:
        isWidget - the isWidget value to set.
        Since:
        6.0.0
      • getIsWidget

        public boolean getIsWidget()
        Returns the isWidget.
        Returns:
        the isWidget
        Since:
        6.0.0
      • isOpenerWindowRequired

        public boolean isOpenerWindowRequired()
        Returns if this interface requires an opener window.
        Returns:
        if this interface requires an opener window.
        Since:
        7.0.0
      • setOpenerWindowRequired

        public void setOpenerWindowRequired​(boolean isOpenerWindowRequired)
        Sets whether this interface requires an opener window.
        Parameters:
        isOpenerWindowRequired - indicates whether this interface requires an opener window.
        Since:
        7.0.0
      • getUsesSocialProfileInformation

        public boolean getUsesSocialProfileInformation()
        Returns whether this interface uses social profile information.
        Returns:
        whether this interface uses social profile information.
        Since:
        6.1.0
      • setUsesSocialProfileInformation

        public void setUsesSocialProfileInformation​(boolean usesSocialProfileInformation)
        Sets whether this interface uses social profile information.
        Parameters:
        usesSocialProfileInformation - whether this interface uses social profile information.
        Since:
        6.1.0
      • isRestEnabled

        public boolean isRestEnabled()
                              throws PortalException
        Returns whether Rest API is enabled for the interface.
        Returns:
        true if enabled.
        Throws:
        PortalException
      • isAutomaticAdministration

        public boolean isAutomaticAdministration()
        Returns if this interface is displayed in an auto administration service page.
        Returns:
        true if the interface is displayed, false otherwise.
        Since:
        7.0.0
      • getCacheExpiration

        public Integer getCacheExpiration()
        Returns the cacheExpiration.
        Returns:
        the cacheExpiration
        Since:
        7.0.0
      • getCacheKeyBusinessContextProperties

        public List<String> getCacheKeyBusinessContextProperties()
        Returns the cacheKeyBusinessContextProperties.
        Returns:
        the cacheKeyBusinessContextProperties
        Since:
        7.0.0
      • getCacheKeyProviderClassName

        public String getCacheKeyProviderClassName()
        Returns the cacheKeyProvider.
        Returns:
        the cacheKeyProvider
        Since:
        7.0.0