Package lumis.portal.channel

Class ChannelWebResource

  • All Implemented Interfaces:
    java.lang.Cloneable, ICacheEntry, ICloneableCacheEntry
    public class ChannelWebResource
extends WebResource
    A web resource that corresponds to a link that is directly to a channel.
    Since:
    5.0.0
    Version:
    $Revision$ $Date$

    • Method Detail

      • getName

        public java.lang.String getName()
        Description copied from class: WebResource
        Returns the name for this web resource. The name is usually used for management display purposes.
        Specified by:
        getName in class WebResource
        Returns:
        this web resource's name, localized according to its locale.
        See Also:
        WebResource.getLocale()

      • getTitle

        public java.lang.String getTitle()
        Description copied from class: WebResource
        Returns the title for this web resource. The title is usually used as an end-user title.
        Specified by:
        getTitle in class WebResource
        Returns:
        this web resource's title, localized according to its locale.
        See Also:
        WebResource.getLocale()

      • getUrlTitle

        public java.lang.String getUrlTitle()
        Description copied from class: WebResource
        Returns the title value meant to be used for friendly URL generation of this web resource.
        Specified by:
        getUrlTitle in class WebResource
        Returns:
        the title value.
        See Also:
        IURLResolver

      • getParent

        public WebResource getParent()
        Description copied from class: WebResource
        Returns the web resource of the parent element of this web resource.
        Specified by:
        getParent in class WebResource
        Returns:
        the parent of this web resource, or null if it has no parent.

      • getParameterMap

        public java.util.Map<java.lang.String,​java.lang.String[]> getParameterMap()
        Description copied from class: WebResource
        Returns a map containing all parameters for this web resource.
        Specified by:
        getParameterMap in class WebResource
        Returns:
        an immutable map containing all parameters for this web resource.

      • getProperties

        public java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getProperties()
        Description copied from class: WebResource
        Returns the properties for this web resource.
        Specified by:
        getProperties in class WebResource
        Returns:
        a immutable map where the key is the property name and the value is a list of the property's values.

      • isCacheEnabled

        public boolean isCacheEnabled()
        Description copied from class: WebResource
        Returns if the cache is enabled for this web resource.
        Overrides:
        isCacheEnabled in class WebResource
        Returns:
        true if the cache is enabled, false otherwise.

      • isFriendlyURLEnabled

        protected boolean isFriendlyURLEnabled()
        Description copied from class: WebResource
        Indicates if friendly URL is enabled for this web resource.
        Overrides:
        isFriendlyURLEnabled in class WebResource
        Returns:
        true if it is enabled, false otherwise.

      • getFriendlyURLPattern

        public java.lang.String getFriendlyURLPattern()
        Description copied from class: WebResource
        Returns the pattern to be used to resolve friendly URL for this web resource.

        The specific syntax or usage of the pattern is up to the IURLResolver configured for this web resource.

        Overrides:
        getFriendlyURLPattern in class WebResource
        Returns:
        the pattern.

      • hasSSI

        protected boolean hasSSI()
        Description copied from class: WebResource
        Returns whether this web resource has Server Side Include (requires SSI pos-processing).
        Overrides:
        hasSSI in class WebResource
        Returns:
        true if this web resource has SSI, false otherwise.

      • getRecommendedFileExtension

        protected java.lang.String getRecommendedFileExtension()
        Description copied from class: WebResource
        Returns the file extension recommended for this web resource, according to its configurations.
        Overrides:
        getRecommendedFileExtension in class WebResource
        Returns:
        the extension, starting with '.'. Example: ".htm"

      • getChannelId

        public java.lang.String getChannelId()
        Returns the identifier of the channel this web resource represents.
        Returns:
        the channel identifier.
        Since:
        5.0.0

      • getProject

        public IProject getProject()
                    throws PortalException
        Description copied from class: WebResource
        Returns the project this web resource belongs to (if any).
        It is important to notice that the relation webresource <-> project is not persisted. Instead, it is calculated at runtime.
        This method may require a current transaction.
        Specified by:
        getProject in class WebResource
        Returns:
        the project this web resource belongs to (if any).
        Throws:
        PortalException