com.dotmarketing.viewtools
Class CategoriesWebAPI

java.lang.Object
  com.dotmarketing.viewtools.CategoriesWebAPI

public class CategoriesWebAPI
extends java.lang.Object

Constructor Summary

CategoriesWebAPI()

Method Summary

java.lang.String	getCategoriesByEntityName(java.lang.String parameterName, java.lang.String entityName, boolean displayTitle, boolean multipleValues, int size)
java.lang.String	getCategoriesByEntityName(java.lang.String parameterName, java.lang.String entityName, long[] selectedCategories, boolean displayTitle, boolean multipleValues, int size, boolean readonly)
java.lang.String	getCategoriesByEntityName(java.lang.String parameterName, java.lang.String entityName, long childInode, boolean displayTitle, boolean multipleValues, int size, boolean readonly)
java.lang.String	getCategoriesByEntityName(java.lang.String parameterName, java.lang.String entityName, java.lang.String[] selectCatsString, boolean displayTitle, boolean multipleValues, int size, boolean readonly) This methods return the selects required for the categories of an entity
java.lang.String	getCategoriesByEntityNameTextMode(java.lang.String parameterName, java.lang.String entityName, long[] selectedCats, boolean displayTitle, boolean multipleValues, int size, boolean readonly)
java.lang.String	getCategoriesByEntityNameTextMode(java.lang.String parameterName, java.lang.String entityName, long childInode, boolean displayTitle, boolean multipleValues, int size, boolean readonly)
java.lang.String	getCategoriesByEntityNameTextMode(java.lang.String parameterName, java.lang.String entityName, java.lang.String[] selectCatsString, boolean displayTitle, boolean multipleValues, int size, boolean readonly)
java.util.List<Category>	getCategoriesListByEntityName(java.lang.String entityName)
Category	getCategoryByInode(long inode)
Category	getCategoryByInode(java.lang.String inode)
Category	getCategoryByKey(java.lang.String key)
java.util.List	getChildrenCategories(Category cat)
java.util.List<Category>	getChildrenCategories(Inode inode)
java.util.List<Category>	getChildrenCategories(java.lang.String inode)
java.util.List	getChildrenCategoriesByKey(java.lang.String key)
java.util.List<Category>	getInodeCategories(Inode inodeObj)
java.util.List<Category>	getInodeCategories(java.lang.String inode)
java.lang.String	getSimpleCategoriesByEntityName(java.lang.String parameterName, java.lang.String entityName, long selectedCategory)
java.lang.String	getSimpleComboByEntityName(java.lang.String parameterName, java.lang.String entityName, long selectedCategory)
void	init(java.lang.Object obj)

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

init

public void init(java.lang.Object obj)

getCategoriesByEntityName

public java.lang.String getCategoriesByEntityName(java.lang.String parameterName,
                                                  java.lang.String entityName,
                                                  boolean displayTitle,
                                                  boolean multipleValues,
                                                  int size)

getCategoriesListByEntityName

public java.util.List<Category> getCategoriesListByEntityName(java.lang.String entityName)

getChildrenCategoriesByKey

public java.util.List getChildrenCategoriesByKey(java.lang.String key)

getCategoryByKey

public Category getCategoryByKey(java.lang.String key)

getChildrenCategories

public java.util.List getChildrenCategories(Category cat)

getChildrenCategories

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

getChildrenCategories

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

getInodeCategories

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

getInodeCategories

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

getCategoriesByEntityName

public java.lang.String getCategoriesByEntityName(java.lang.String parameterName,
                                                  java.lang.String entityName,
                                                  long childInode,
                                                  boolean displayTitle,
                                                  boolean multipleValues,
                                                  int size,
                                                  boolean readonly)

Parameters:

parameterName - value of the "name" attribute for the html tag

entityName - name of the entity that have the categories

childInode - Inode value to obtain the selected categories

displayTitle - if do you want that the title display or not (Entity Name)

multipleValues - if the user could select multiple values

size - the height in entries that could be displayed

readonly - if the select is disable

Returns:

getCategoriesByEntityName

public java.lang.String getCategoriesByEntityName(java.lang.String parameterName,
                                                  java.lang.String entityName,
                                                  long[] selectedCategories,
                                                  boolean displayTitle,
                                                  boolean multipleValues,
                                                  int size,
                                                  boolean readonly)

Parameters:

parameterName - value of the "name" attribute for the

html tag

entityName - name of the entity that have the categories

selectedCategories - Selected categories inodes

displayTitle - if do you want that the title display or not (Entity Name)

multipleValues - if the user could select multiple values

size - the height in entries that could be displayed

readonly - if the select is disable

Returns:

getCategoriesByEntityName

public java.lang.String getCategoriesByEntityName(java.lang.String parameterName,
                                                  java.lang.String entityName,
                                                  java.lang.String[] selectCatsString,
                                                  boolean displayTitle,
                                                  boolean multipleValues,
                                                  int size,
                                                  boolean readonly)

This methods return the selects required for the categories of an entity

Parameters:

parameterName - value of the "name" attribute for the html tag

entityName - name of the entity that have the categories

selectCatsString - Selected categories inodes

displayTitle - if do you want that the title display or not (Entity Name)

multipleValues - if the user could select multiple values

size - the height in entries that could be displayed

readonly - if the select is disable

Returns:

the the HTML that render the selects

getCategoriesByEntityNameTextMode

public java.lang.String getCategoriesByEntityNameTextMode(java.lang.String parameterName,
                                                          java.lang.String entityName,
                                                          long[] selectedCats,
                                                          boolean displayTitle,
                                                          boolean multipleValues,
                                                          int size,
                                                          boolean readonly)

getCategoriesByEntityNameTextMode

public java.lang.String getCategoriesByEntityNameTextMode(java.lang.String parameterName,
                                                          java.lang.String entityName,
                                                          long childInode,
                                                          boolean displayTitle,
                                                          boolean multipleValues,
                                                          int size,
                                                          boolean readonly)

getCategoriesByEntityNameTextMode

public java.lang.String getCategoriesByEntityNameTextMode(java.lang.String parameterName,
                                                          java.lang.String entityName,
                                                          java.lang.String[] selectCatsString,
                                                          boolean displayTitle,
                                                          boolean multipleValues,
                                                          int size,
                                                          boolean readonly)

getSimpleComboByEntityName

public java.lang.String getSimpleComboByEntityName(java.lang.String parameterName,
                                                   java.lang.String entityName,
                                                   long selectedCategory)

Parameters:

parameterName - value of the "name" attribute for the

html tag

entityName - name of the entity that have the categories

selectedCategories - Selected categories inodes

displayTitle - if do you want that the title display or not (Entity Name)

multipleValues - if the user could select multiple values

size - the height in entries that could be displayed

readonly - if the select is disable

Returns:

getSimpleCategoriesByEntityName

public java.lang.String getSimpleCategoriesByEntityName(java.lang.String parameterName,
                                                        java.lang.String entityName,
                                                        long selectedCategory)

getCategoryByInode

public Category getCategoryByInode(java.lang.String inode)

getCategoryByInode

public Category getCategoryByInode(long inode)