org.opencms.ade.detailpage
Class CmsDetailPageInfo

java.lang.Object
  org.opencms.ade.detailpage.CmsDetailPageInfo

All Implemented Interfaces:

java.io.Serializable

public class CmsDetailPageInfo
extends java.lang.Object
implements java.io.Serializable

Data bean containing the information for a detail page.

Since:

8.0.0

See Also:

Serialized Form

Field Summary

static java.lang.String

FUNCTION_PREFIX The prefix for dynamic function detail page types.

Constructor Summary

protected	CmsDetailPageInfo() Empty default constructor for serialization.
	CmsDetailPageInfo(CmsUUID id, java.lang.String uri, java.lang.String type) Creates a new detail page info bean.

Method Summary

java.lang.String	getDisplayType() Gets the type name to display to the user.
java.lang.String	getIconType() Returns the resource type name for the icon to display.
CmsUUID	getId() Returns the id of the detail page.
java.lang.String	getType() Returns the type for which the detail page is used.
java.lang.String	getUri() The original URI for the detail page.
static java.lang.String	removeFunctionPrefix(java.lang.String name) Removes the prefix for dynamic functions from a detail page type name.

Methods inherited from class java.lang.Object

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

Field Detail

FUNCTION_PREFIX

public static final java.lang.String FUNCTION_PREFIX

The prefix for dynamic function detail page types.

See Also:

Constant Field Values

Constructor Detail

CmsDetailPageInfo

public CmsDetailPageInfo(CmsUUID id,
                         java.lang.String uri,
                         java.lang.String type)

Creates a new detail page info bean.

Parameters:

id - the id of the detail page

uri - the original URI of the page

type - the resource type for which the detail page is used

CmsDetailPageInfo

protected CmsDetailPageInfo()

Empty default constructor for serialization.

Method Detail

removeFunctionPrefix

public static java.lang.String removeFunctionPrefix(java.lang.String name)

Removes the prefix for dynamic functions from a detail page type name.

Parameters:

name - the detail page type name

Returns:

the detail page type name withotu the function prefix

getDisplayType

public java.lang.String getDisplayType()

Gets the type name to display to the user.

Returns:

the type name to display

getIconType

public java.lang.String getIconType()

Returns the resource type name for the icon to display.

Returns:

the icon resource type

getId

public CmsUUID getId()

Returns the id of the detail page.

Returns:

the id of the detail page

getType

public java.lang.String getType()

Returns the type for which the detail page is used.

Returns:

the type for which the detail page is used

getUri

public java.lang.String getUri()

The original URI for the detail page.

Returns:

the original URI for the detail page