lumis.portal.channel
Class ChannelWebResource

java.lang.Object
  lumis.portal.url.WebResource
      lumis.portal.channel.ChannelWebResource

All Implemented Interfaces:

Cloneable

public class ChannelWebResource
extends WebResource

A web resource that corresponds to a link that is directly to a channel.

Since:

5.0.0

Method Summary

String	getChannelId() Returns the identifier of the channel this web resource represents.
String	getFriendlyURLPattern() Returns the pattern to be used to resolve friendly URL for this web resource.
String	getName() Returns the name for this web resource.
Map<String,String[]>	getParameterMap() Returns a map containing all parameters for this web resource.
WebResource	getParent() Returns the web resource of the parent element of this web resource.
protected String	getPath(boolean considerGuestOnlyCache) Returns the path to access this web resource.
Map<String,List<String>>	getProperties() Returns the properties for this web resource.
protected String	getRecommendedFileExtension() Returns the file extension recommended for this web resource, according to its configurations.
String	getTitle() Returns the title for this web resource.
protected boolean	hasSSI() Returns whether this web resource has Server Side Include (requires SSI pos-processing).
boolean	isCacheEnabled(boolean considerGuestOnlyCache) Returns if the cache is enabled for this web resource for the current user.
protected boolean	isFriendlyURLEnabled() Indicates if friendly URL is enabled for this web resource.

Methods inherited from class lumis.portal.url.WebResource

clone, getCreatedDateTime, getDynamicPath, getFriendlyPath, getId, getLocale, getPageCache, getParameter, getParameterValues, getPath, getWebsite, isAvailableForGetRequest, isDynamicRequestValid, localize, mayBePersisted, setDynamicPath, setFriendlyPath, setId, setLocale, setPageCache, setWebsite, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getName

public 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 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()

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 Map<String,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 Map<String,List<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.

getPath

protected String getPath(boolean considerGuestOnlyCache)

Description copied from class: WebResource

Returns the path to access this web resource. The returned value is taken from cache configuration, WebResource.getFriendlyPath() or WebResource.getDynamicPath().

Overrides:

getPath in class WebResource

Parameters:

considerGuestOnlyCache - indicates if the path for the cached file should be used even if the cache is only for guest.

Returns:

the path to access this web resource, starting with '/' and relative to the portal web application root.

isCacheEnabled

public boolean isCacheEnabled(boolean considerGuestOnlyCache)

Description copied from class: WebResource

Returns if the cache is enabled for this web resource for the current user.

Overrides:

isCacheEnabled in class WebResource

Parameters:

considerGuestOnlyCache - indicates if the result should be true even if the cache is only for guest.

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 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 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 String getChannelId()

Returns the identifier of the channel this web resource represents.

Returns:

the channel identifier.

Since:

5.0.0