com.dotmarketing.viewtools
Class CategoriesWebAPI

java.lang.Object
  extended by com.dotmarketing.viewtools.CategoriesWebAPI
All Implemented Interfaces:
org.apache.velocity.tools.view.tools.ViewTool

public class CategoriesWebAPI
extends java.lang.Object
implements org.apache.velocity.tools.view.tools.ViewTool


Constructor Summary
CategoriesWebAPI()
           
 
Method Summary
 java.util.List<java.lang.String> fetchCategoriesInodes(java.util.List<Category> cats)
           
 java.util.List<java.lang.String> fetchCategoriesKeys(java.util.List<Category> cats)
           
 java.util.List<java.lang.String> fetchCategoriesNames(java.util.List<Category> cats)
           
 java.util.List<Category> filterCategoriesByUserPermissions(java.util.List<java.lang.Object> catInodes)
           
 java.util.List<Category> getActiveChildrenCategories(Category cat)
           
 java.util.List<Category> getActiveChildrenCategories(Inode inode)
           
 java.util.List<Category> getActiveChildrenCategories(java.lang.String inode)
           
 java.util.List<Category> getActiveChildrenCategoriesByKey(java.lang.String key)
           
 java.util.List<Category> getActiveChildrenCategoriesByParent(java.util.ArrayList<java.lang.String> o)
           
 java.util.List<Category> getActiveChildrenCategoriesOrderByName(Category cat)
           
 java.util.List<Category> getActiveChildrenCategoriesOrderByName(Inode inode)
           
 java.util.List<Category> getActiveChildrenCategoriesOrderByName(java.lang.String inode)
           
 java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getAllActiveChildrenCategories(Inode inode)
          Retrieves a plain list of all the children categories (any depth) of the given parent inode The list returned is a list of maps, each map has the category and the level of this category belongs E.G.
 java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getAllActiveChildrenCategories(java.lang.String inode)
          Retrieves a plain list of all the children categories (any depth) of the given parent inode The list returned is a list of maps, each map has the category and the level of this category belongs E.G.
 java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getAllActiveChildrenCategoriesByKey(java.lang.String key)
          Retrieves a plain list of all the children categories (any depth) of the given parent category key The list returned is a list of maps, each map has the category and the level of this category belongs E.G.
 java.util.List<Category> getCategoriesByUser(com.liferay.portal.model.User user)
           
 CategoryAPI getCategoryAPI()
           
 Category getCategoryByInode(long inode)
          Deprecated. 
 Category getCategoryByInode(java.lang.String inode)
           
 Category getCategoryByKey(java.lang.String key)
           
 Category getCategoryByName(java.lang.String name)
          Deprecated. Multiple categories can have the same name so this method should be avoid to search a single category
 java.lang.String getCategoryKeyByContentlet(long contentletInode)
          Deprecated. 
 java.lang.String getCategoryKeyByContentlet(java.lang.String contentletInode)
           
 java.util.List<Category> getChildrenCategories(Category cat)
           
 java.util.List<Category> getChildrenCategories(Inode inode)
           
 java.util.List<Category> getChildrenCategories(java.lang.String inode)
           
 java.util.List<Category> getChildrenCategoriesByKey(java.lang.String key)
           
 java.util.List<Category> getInodeCategories(Inode inodeObj)
           
 java.util.List<Category> getInodeCategories(java.lang.String inode)
           
 void init(java.lang.Object obj)
           
 void setCategoryAPI(CategoryAPI categoryAPI)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CategoriesWebAPI

public CategoriesWebAPI()
Method Detail

getCategoryAPI

public CategoryAPI getCategoryAPI()

setCategoryAPI

public void setCategoryAPI(CategoryAPI categoryAPI)

init

public void init(java.lang.Object obj)
Specified by:
init in interface org.apache.velocity.tools.view.tools.ViewTool

getChildrenCategoriesByKey

public java.util.List<Category> getChildrenCategoriesByKey(java.lang.String key)

getCategoryByKey

public Category getCategoryByKey(java.lang.String key)

getCategoryByName

public Category getCategoryByName(java.lang.String name)
Deprecated. Multiple categories can have the same name so this method should be avoid to search a single category

Parameters:
name -
Returns:

getChildrenCategories

public java.util.List<Category> getChildrenCategories(Category cat)

getChildrenCategories

public java.util.List<Category> getChildrenCategories(Inode inode)

getChildrenCategories

public java.util.List<Category> getChildrenCategories(java.lang.String inode)

getActiveChildrenCategories

public java.util.List<Category> getActiveChildrenCategories(Category cat)

getActiveChildrenCategoriesByKey

public java.util.List<Category> getActiveChildrenCategoriesByKey(java.lang.String key)

getActiveChildrenCategories

public java.util.List<Category> getActiveChildrenCategories(Inode inode)

getActiveChildrenCategories

public java.util.List<Category> getActiveChildrenCategories(java.lang.String inode)

getActiveChildrenCategoriesOrderByName

public java.util.List<Category> getActiveChildrenCategoriesOrderByName(Category cat)

getActiveChildrenCategoriesOrderByName

public java.util.List<Category> getActiveChildrenCategoriesOrderByName(Inode inode)

getActiveChildrenCategoriesOrderByName

public java.util.List<Category> getActiveChildrenCategoriesOrderByName(java.lang.String inode)

getActiveChildrenCategoriesByParent

public java.util.List<Category> getActiveChildrenCategoriesByParent(java.util.ArrayList<java.lang.String> o)

getAllActiveChildrenCategoriesByKey

public java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getAllActiveChildrenCategoriesByKey(java.lang.String key)
Retrieves a plain list of all the children categories (any depth) of the given parent category key The list returned is a list of maps, each map has the category and the level of this category belongs E.G. level: 1 cat: Best Practices level: 1 cat: Conferences & Presentations level: 2 cat: second level level: 1 cat: Marketing

Parameters:
key - parent category key
Returns:

getAllActiveChildrenCategories

public java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getAllActiveChildrenCategories(Inode inode)
Retrieves a plain list of all the children categories (any depth) of the given parent inode The list returned is a list of maps, each map has the category and the level of this category belongs E.G. level: 1 cat: Best Practices level: 1 cat: Conferences & Presentations level: 2 cat: second level level: 1 cat: Marketing

Parameters:
inode - parent inode
Returns:

getAllActiveChildrenCategories

public java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getAllActiveChildrenCategories(java.lang.String inode)
Retrieves a plain list of all the children categories (any depth) of the given parent inode The list returned is a list of maps, each map has the category and the level of this category belongs E.G. level: 1 cat: Best Practices level: 1 cat: Conferences & Presentations level: 2 cat: second level level: 1 cat: Marketing

Parameters:
inode - parent inode
Returns:

getInodeCategories

public java.util.List<Category> getInodeCategories(java.lang.String inode)

getInodeCategories

public java.util.List<Category> getInodeCategories(Inode inodeObj)

getCategoryByInode

public Category getCategoryByInode(java.lang.String inode)

getCategoryByInode

@Deprecated
public Category getCategoryByInode(long inode)
Deprecated. 


getCategoryKeyByContentlet

@Deprecated
public java.lang.String getCategoryKeyByContentlet(long contentletInode)
Deprecated. 


getCategoryKeyByContentlet

public java.lang.String getCategoryKeyByContentlet(java.lang.String contentletInode)

getCategoriesByUser

public java.util.List<Category> getCategoriesByUser(com.liferay.portal.model.User user)

filterCategoriesByUserPermissions

public java.util.List<Category> filterCategoriesByUserPermissions(java.util.List<java.lang.Object> catInodes)

fetchCategoriesInodes

public java.util.List<java.lang.String> fetchCategoriesInodes(java.util.List<Category> cats)

fetchCategoriesNames

public java.util.List<java.lang.String> fetchCategoriesNames(java.util.List<Category> cats)

fetchCategoriesKeys

public java.util.List<java.lang.String> fetchCategoriesKeys(java.util.List<Category> cats)


Copyright © 2013 dotCMS Inc. All Rights Reserved.