Package lumis.portal.serviceinstance

Class ServiceInstanceConfig

    • Constructor Detail

      • ServiceInstanceConfig

        public ServiceInstanceConfig()

    • Method Detail

      • getDescription

        public java.lang.String getDescription()
        Returns:
        Returns the description.

      • setDescription

        public void setDescription​(java.lang.String description)
        Parameters:
        description - The description to set.

      • getId

        public java.lang.String getId()
        Returns:
        Returns the id.

      • setId

        public void setId​(java.lang.String id)
        Parameters:
        id - The id to set.

      • getName

        public java.lang.String getName()
        Returns:
        Returns the name.

      • setName

        public void setName​(java.lang.String name)
        Parameters:
        name - The name to set.

      • getChannelId

        public java.lang.String getChannelId()
        Returns:
        Returns the channelId.

      • setChannelId

        public void setChannelId​(java.lang.String channelId)
        Parameters:
        channelId - The channelId to set.

      • getServiceId

        public java.lang.String getServiceId()
        Returns:
        Returns the serviceId.

      • setServiceId

        public void setServiceId​(java.lang.String serviceId)
        Parameters:
        serviceId - The serviceId to set.

      • getUsesPublicFileStorage

        @Deprecated
public boolean getUsesPublicFileStorage()
        Deprecated.
        Since 12.2.0 replaced by usesPublicFileStorage().

      • usesPublicFileStorage

        public java.lang.Boolean usesPublicFileStorage()
        Returns whether this service instance uses public file storage.
        Returns:
        true if it uses, false if it does not use the public file storage or null if unspecified and will be configured with the default for its service when added.
        Since:
        12.2.0

      • setUsesPublicFileStorage

        public void setUsesPublicFileStorage​(boolean filePublic)

      • isInContextEditDisabled

        public boolean isInContextEditDisabled()

      • setDisableInContextEdit

        public void setDisableInContextEdit​(boolean disableInContextEdit)

      • getProperty

        public java.lang.String getProperty​(java.lang.String name)

      • getProperties

        public java.util.Enumeration getProperties​(java.lang.String name)

      • getPropertyNames

        public java.util.Enumeration getPropertyNames()

      • getExtendedProperty

        public java.lang.String getExtendedProperty​(java.lang.String name)

      • getExtendedProperties

        public java.util.Enumeration getExtendedProperties​(java.lang.String name)

      • getExtendedPropertyNames

        public java.util.Enumeration getExtendedPropertyNames()

      • getAccessControlListId

        public java.lang.String getAccessControlListId()

      • setAccessControlListId

        public void setAccessControlListId​(java.lang.String accessControlListId)

      • setUsesFileTransformation

        public void setUsesFileTransformation​(boolean usesFileTransformation)
        Sets the usesFileTransformation.
        Parameters:
        usesFileTransformation - the usesFileTransformation value to set.
        Since:
        6.1.0

      • getUsesFileTransformation

        public boolean getUsesFileTransformation()
        Returns the usesFileTransformation.
        Returns:
        the usesFileTransformation
        Since:
        6.1.0

      • setFriendlyId

        public void setFriendlyId​(java.lang.String friendlyId)
        Sets the service instance's friendly identifier. This value must be unique among the service instances contained in the same channel this service instance is contained.
        Parameters:
        friendlyId - the service instance's friendly identifier.
        Since:
        6.0.0

      • setAutoGeneratedFriendlyId

        public void setAutoGeneratedFriendlyId()
        Generates a new friendly identifier and sets it as the friendly identifier of this service instance. The friendly identifier is generated based on this service instance's current name.

        This method requires an active transaction.

        Since:
        6.0.0
        See Also:
        setFriendlyId(String)

      • getFriendlyId

        public java.lang.String getFriendlyId()
        Returns the service instance's friendly identifier.
        Returns:
        the service instance's friendly identifier.
        Since:
        6.0.0

      • setAutomaticFriendlyId

        public void setAutomaticFriendlyId​(boolean automaticFriendlyId)
        Indicates whether the service instance is going to use automatic generated friendly identifier or not.
        Parameters:
        automaticFriendlyId - indicates whether the service instance is going to use automatic generated friendly identifier or not.
        Since:
        6.0.0

      • isAutomaticFriendlyId

        public boolean isAutomaticFriendlyId()
        Returns whether the service instance is going to use automatic generated friendly identifier or not.
        Returns:
        whether the service instance is going to use automatic generated friendly identifier or not.
        Since:
        6.0.0

      • getManagedPropertiesPattern

        protected java.util.regex.Pattern getManagedPropertiesPattern()
        Description copied from class: StructureElement
        Returns the property name spaces. Used to decides if a property can be updated.
        Specified by:
        getManagedPropertiesPattern in class StructureElement
        Returns:
        property name spaces

      • mayUseFriendlyId

        protected boolean mayUseFriendlyId​(java.lang.String friendlyId)
                            throws PortalException
        Description copied from class: StructureElement
        Indicates if the element may use the given friendly identifier.
        Specified by:
        mayUseFriendlyId in class StructureElement
        Parameters:
        friendlyId - the friendly identifier.
        Returns:
        true if the element may use the given friendly identifier, false otherwise.
        Throws:
        PortalException

      • setRestShortName

        public void setRestShortName​(java.lang.String shortName)
        Sets the shortName.
        Parameters:
        shortName - the shortName value to set.
        Since:
        6.1.0

      • getRestShortName

        public java.lang.String getRestShortName()
        Returns the Rest shortName.
        Returns:
        the shortName
        Since:
        6.1.0

      • setRestEnabled

        public void setRestEnabled​(boolean restEnabled)
        Sets the restEnabled.
        Parameters:
        restEnabled - the restEnabled value to set.
        Since:
        6.1.0

      • isRestEnabled

        public boolean isRestEnabled()
        Returns the restEnabled.
        Returns:
        the restEnabled
        Since:
        6.1.0

      • getHtmlProcessorsPriority

        public int getHtmlProcessorsPriority()
        Returns the HTML processors priority.
        Returns:
        the HTML processors priority
        Since:
        8.2.0

      • setHtmlProcessorsPriority

        public void setHtmlProcessorsPriority​(int htmlProcessorsPriority)
        Sets the HTML processors priority.
        Parameters:
        htmlProcessorsPriority - the HTML processors priority value to set.
        Since:
        8.2.0