org.opencms.ade.sitemap.shared
Class CmsNewResourceInfo

java.lang.Object
  extended by org.opencms.ade.sitemap.shared.CmsNewResourceInfo
All Implemented Interfaces:
java.io.Serializable

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

A bean representing a resource type for use in the detail page creation menu.

Since:
8.0.0
See Also:
Serialized Form

Field Summary
static java.lang.String NAVIGATION_LEVEL_PARAMETER
          The navigation level create parameter.
 
Constructor Summary
protected CmsNewResourceInfo()
          Empty default constructor for serialization.
  CmsNewResourceInfo(int id, java.lang.String typeName, java.lang.String title, java.lang.String description, CmsUUID copyResourceId, boolean editable, java.lang.String subTitle)
          Instantiates a new resource type information bean.
 
Method Summary
 CmsUUID getCopyResourceId()
          Returns the structure id of the copy resource.
 java.lang.String getCreateParameter()
          Gets the additional parameter for creating new resources.
 java.lang.String getDate()
          Returns the date to display.
 java.lang.String getDescription()
          Returns the description.
 int getId()
          Gets the id.
 java.lang.Float getNavPos()
          Gets the navigation position (used for ordering).
 java.lang.String getSubTitle()
          Gets the subtitle.
 java.lang.String getTitle()
          Gets the title.
 java.lang.String getTypeName()
          Gets the type name.
 java.lang.String getVfsPath()
          Gets the VFS path.
 boolean isEditable()
          Returns true if the model resource is editable.
 boolean isFunction()
          Returns true if this is a resource info bean for a function page.
 void setCreateParameter(java.lang.String createParameter)
          Sets the create parameter used for new pages.
 void setDate(java.lang.String date)
          Sets the modification date string.
 void setIsFunction(boolean isFunction)
          Sets the "function page" flag.
 void setNavPos(java.lang.Float navPos)
          Sets the navigation position.
 void setSubTitle(java.lang.String subtitle)
          Sets the subtitle.
 void setVfsPath(java.lang.String vfsPath)
          Sets the VFS path.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NAVIGATION_LEVEL_PARAMETER

public static final java.lang.String NAVIGATION_LEVEL_PARAMETER
The navigation level create parameter.

See Also:
Constant Field Values
Constructor Detail

CmsNewResourceInfo

public CmsNewResourceInfo(int id,
                          java.lang.String typeName,
                          java.lang.String title,
                          java.lang.String description,
                          CmsUUID copyResourceId,
                          boolean editable,
                          java.lang.String subTitle)
Instantiates a new resource type information bean.

Parameters:
id - the id
typeName - the type name
title - the title
description - the description
copyResourceId - the structure id of the copy resource
editable - true if the model resource is editable
subTitle - the subtitle to display

CmsNewResourceInfo

protected CmsNewResourceInfo()
Empty default constructor for serialization.

Method Detail

getCopyResourceId

public CmsUUID getCopyResourceId()
Returns the structure id of the copy resource.

Returns:
the structure id of the copy resource

getCreateParameter

public java.lang.String getCreateParameter()
Gets the additional parameter for creating new resources.

Returns:
the additional parameter for creating new resources

getDate

public java.lang.String getDate()
Returns the date to display.

Returns:
the date to display

getDescription

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

Returns:
the description

getId

public int getId()
Gets the id.

Returns:
the id

getNavPos

public java.lang.Float getNavPos()
Gets the navigation position (used for ordering).

Returns:
the navigation position

getSubTitle

public java.lang.String getSubTitle()
Gets the subtitle.

Returns:
the subtitle

getTitle

public java.lang.String getTitle()
Gets the title.

Returns:
the title

getTypeName

public java.lang.String getTypeName()
Gets the type name.

Returns:
the type name

getVfsPath

public java.lang.String getVfsPath()
Gets the VFS path.

Returns:
the VFS path

isEditable

public boolean isEditable()
Returns true if the model resource is editable.

Returns:
true if the model resource is editable

isFunction

public boolean isFunction()
Returns true if this is a resource info bean for a function page.

Returns:
true if this is a resource info bean for a function page

setCreateParameter

public void setCreateParameter(java.lang.String createParameter)
Sets the create parameter used for new pages.

Parameters:
createParameter - the create parameter used for new pages

setDate

public void setDate(java.lang.String date)
Sets the modification date string.

Parameters:
date - the modification date string

setIsFunction

public void setIsFunction(boolean isFunction)
Sets the "function page" flag.

Parameters:
isFunction - the new value for the function page flag

setNavPos

public void setNavPos(java.lang.Float navPos)
Sets the navigation position.

Parameters:
navPos - the navigation position

setSubTitle

public void setSubTitle(java.lang.String subtitle)
Sets the subtitle.

Parameters:
subtitle - the subtitle

setVfsPath

public void setVfsPath(java.lang.String vfsPath)
Sets the VFS path.

Parameters:
vfsPath - the VFS path