org.opencms.workplace

Class CmsWorkplaceView

java.lang.Object

org.opencms.workplace.CmsWorkplaceView

All Implemented Interfaces:

java.lang.Comparable<CmsWorkplaceView>

public class CmsWorkplaceView
extends java.lang.Object
implements java.lang.Comparable<CmsWorkplaceView>

Contains the data of a single workplace view.

Since:

6.0.0

Constructor Summary

Constructors

Constructor and Description
CmsWorkplaceView(java.lang.String key, java.lang.String uri, java.lang.Float order) Creates a new workplace view.

Method Summary

Modifier and Type	Method and Description
int	compareTo(CmsWorkplaceView obj)
boolean	equals(java.lang.Object obj)
java.lang.String	getKey() Returns the localization key for the display name of this view .
java.lang.Float	getOrder() Returns the sort order of this view.
java.lang.String	getUri() Returns the OpenCms VFS uri of this view.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsWorkplaceView

public CmsWorkplaceView(java.lang.String key,
                        java.lang.String uri,
                        java.lang.Float order)

Creates a new workplace view.

Parameters:

key - the localization key for the display name of the view

uri - of the view page in the OpenCms VFS

order - the sort order of the view

Method Detail

compareTo

public int compareTo(CmsWorkplaceView obj)

Specified by:

compareTo in interface java.lang.Comparable<CmsWorkplaceView>

See Also:

Comparable.compareTo(java.lang.Object)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(java.lang.Object)

getKey

public java.lang.String getKey()

Returns the localization key for the display name of this view .

Returns:

the localization key

getOrder

public java.lang.Float getOrder()

Returns the sort order of this view.

Returns:

the sort order of this view

getUri

public java.lang.String getUri()

Returns the OpenCms VFS uri of this view.

Returns:

the uri

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()