com.dotmarketing.portlets.categories.model
Class Category

java.lang.Object
  extended by com.dotmarketing.beans.Inode
      extended by com.dotmarketing.portlets.categories.model.Category
All Implemented Interfaces:
UUIDable, Permissionable, Versionable, Categorizable, java.io.Serializable, java.lang.Comparable

public class Category
extends Inode
implements java.io.Serializable

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.dotmarketing.beans.Inode
identifier, inode, owner
 
Constructor Summary
Category()
          default constructor
Category(java.lang.String categoryName)
          minimal constructor
 
Method Summary
 java.util.List<PermissionSummary> acceptedPermissions()
          Returns the list of accepted permission of this permissionable (I.E.
 java.lang.String getCategoryName()
           
 java.lang.String getCategoryVelocityVarName()
           
 java.lang.String getDescription()
          Returns the description.
 java.lang.String getInode()
          gets the inode (specific version id) of the versionable
 java.lang.String getKey()
           
 java.lang.String getKeywords()
           
 java.util.Map<java.lang.String,java.lang.Object> getMap()
          Returns a hashmap with all the inode fields
 Permissionable getParentPermissionable()
          Retrieves the parent permissionable in the chain of permissions inheritance
 java.lang.Integer getSortOrder()
           
 boolean hasActiveChildren()
           
 boolean isActive()
           
 boolean isParentPermissionable()
          Returns true if other asset could inherit permissions from it
 void setActive(boolean active)
           
 void setCategoryName(java.lang.String categoryName)
           
 void setCategoryVelocityVarName(java.lang.String categoryVelocityVarName)
           
 void setDescription(java.lang.String description)
          Sets the description.
 void setInode(java.lang.String inode)
          Sets the inode.
 void setKey(java.lang.String key)
           
 void setKeywords(java.lang.String keywords)
           
 void setSortOrder(java.lang.Integer sortOrder)
           
 void setSortOrder(java.lang.String sortOrder)
           
 java.lang.String toString()
           
 
Methods inherited from class com.dotmarketing.beans.Inode
addChild, addChild, addChild, addChild, addChild, addParent, addParent, addParent, compareTo, deleteChild, deleteChild, deleteChild, deleteChild, deleteParent, deleteParent, equals, getCategoryId, getiDate, getIDate, getIdentifier, getModDate, getModUser, getOwner, getPermissionId, getPermissionType, getTitle, getType, getVersionId, getVersionType, hasChildren, hashCode, hasParents, isArchived, isLive, isLocked, isNew, isWorking, permissionDependencies, setiDate, setIDate, setIDate, setIdentifier, setOwner, setParents, setType, setVersionId
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Category

public Category()
default constructor


Category

public Category(java.lang.String categoryName)
minimal constructor

Method Detail

isActive

public boolean isActive()
Returns:
Returns the active.

setActive

public void setActive(boolean active)
Parameters:
active - The active to set.

getInode

public java.lang.String getInode()
Description copied from interface: Versionable
gets the inode (specific version id) of the versionable

Specified by:
getInode in interface UUIDable
Specified by:
getInode in interface Versionable
Overrides:
getInode in class Inode

setInode

public void setInode(java.lang.String inode)
Description copied from class: Inode
Sets the inode.

Specified by:
setInode in interface UUIDable
Overrides:
setInode in class Inode
Parameters:
inode - The inode to set

getCategoryName

public java.lang.String getCategoryName()

setCategoryName

public void setCategoryName(java.lang.String categoryName)

getSortOrder

public java.lang.Integer getSortOrder()

setSortOrder

public void setSortOrder(java.lang.Integer sortOrder)

setSortOrder

public void setSortOrder(java.lang.String sortOrder)

getDescription

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

Returns:
String

setDescription

public void setDescription(java.lang.String description)
Sets the description.

Parameters:
description - The description to set

getKey

public java.lang.String getKey()
Returns:
Returns the key.

setKey

public void setKey(java.lang.String key)
Parameters:
key - The key to set.

getKeywords

public java.lang.String getKeywords()

setKeywords

public void setKeywords(java.lang.String keywords)

hasActiveChildren

public boolean hasActiveChildren()

getMap

public java.util.Map<java.lang.String,java.lang.Object> getMap()
Description copied from class: Inode
Returns a hashmap with all the inode fields

Overrides:
getMap in class Inode
Returns:
the map

setCategoryVelocityVarName

public void setCategoryVelocityVarName(java.lang.String categoryVelocityVarName)

getCategoryVelocityVarName

public java.lang.String getCategoryVelocityVarName()

acceptedPermissions

public java.util.List<PermissionSummary> acceptedPermissions()
Description copied from interface: Permissionable
Returns the list of accepted permission of this permissionable (I.E. content accepts permissions to view, edit, publish, and edit permissions)

Specified by:
acceptedPermissions in interface Permissionable
Overrides:
acceptedPermissions in class Inode
Returns:

getParentPermissionable

public Permissionable getParentPermissionable()
                                       throws DotDataException
Description copied from interface: Permissionable
Retrieves the parent permissionable in the chain of permissions inheritance

Specified by:
getParentPermissionable in interface Permissionable
Overrides:
getParentPermissionable in class Inode
Returns:
Throws:
DotDataException

isParentPermissionable

public boolean isParentPermissionable()
Description copied from interface: Permissionable
Returns true if other asset could inherit permissions from it

Specified by:
isParentPermissionable in interface Permissionable
Overrides:
isParentPermissionable in class Inode
Returns:

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object


Copyright © 2013 dotCMS Inc. All Rights Reserved.