com.dotmarketing.portlets.categories.ajax
Class CategoryAjax

java.lang.Object
  extended by com.dotmarketing.portlets.categories.ajax.CategoryAjax

public class CategoryAjax
extends java.lang.Object

Author:
David

Constructor Summary
CategoryAjax()
           
 
Method Summary
 java.util.List<java.util.Map<java.lang.String,java.lang.Object>> findChildrenCategories(java.lang.String catInode, java.lang.String filter)
          Returns all sub-categories multiple levels depth of the given parent category, it returns them on a single list adding to each category a property that denotes depth
 CategoryAPI getCategoryAPI()
           
 java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getChildrenCategories(java.lang.String catName)
          Deprecated. use getChildrenCategories(String catName, String filter) instead
 java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getChildrenCategories(java.lang.String categoryInode, java.lang.String filter)
          Returns all the sub-categories multiple levels depth of the given category
 java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getEntityCategories(java.lang.String entityName, java.lang.String filter)
          Returns all the categories and sub-categories of the given entity
 java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getSubCategories(java.lang.String cat, java.lang.String filter)
          Returns all the sub-categories multiple levels depth of the given category
 void setCategoryAPI(CategoryAPI categoryAPI)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CategoryAjax

public CategoryAjax()
Method Detail

getCategoryAPI

public CategoryAPI getCategoryAPI()

setCategoryAPI

public void setCategoryAPI(CategoryAPI categoryAPI)

getEntityCategories

public java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getEntityCategories(java.lang.String entityName,
                                                                                            java.lang.String filter)
                                                                                     throws DotDataException,
                                                                                            com.liferay.portal.PortalException,
                                                                                            com.liferay.portal.SystemException,
                                                                                            DotSecurityException
Returns all the categories and sub-categories of the given entity

Parameters:
entityName - The name of the entity to search over
filter - A regular expression to use as filter if null, then no filter will be applied
Returns:
Throws:
DotDataException
DotSecurityException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

getSubCategories

public java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getSubCategories(java.lang.String cat,
                                                                                         java.lang.String filter)
                                                                                  throws DotDataException,
                                                                                         com.liferay.portal.PortalException,
                                                                                         com.liferay.portal.SystemException,
                                                                                         DotSecurityException
Returns all the sub-categories multiple levels depth of the given category

Parameters:
catName - The inode/key/name of the parent category
Returns:
Throws:
DotDataException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
DotSecurityException

getChildrenCategories

public java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getChildrenCategories(java.lang.String catName)
                                                                                       throws DotDataException,
                                                                                              com.liferay.portal.PortalException,
                                                                                              com.liferay.portal.SystemException,
                                                                                              DotSecurityException
Deprecated. use getChildrenCategories(String catName, String filter) instead

Returns all the sub-categories multiple levels depth of the given category

Parameters:
catName - The name of the parent category
Returns:
Throws:
DotDataException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
DotSecurityException

getChildrenCategories

public java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getChildrenCategories(java.lang.String categoryInode,
                                                                                              java.lang.String filter)
                                                                                       throws DotDataException,
                                                                                              DotSecurityException,
                                                                                              com.liferay.portal.PortalException,
                                                                                              com.liferay.portal.SystemException
Returns all the sub-categories multiple levels depth of the given category

Parameters:
category - tries first to parse by inode, if not tries by key if not tries by name, passing the name of a category is discouraged and could be removed in later versions
filter - A filter regular expression
Returns:
Throws:
DotDataException
com.liferay.portal.SystemException
com.liferay.portal.PortalException
DotSecurityException

findChildrenCategories

public java.util.List<java.util.Map<java.lang.String,java.lang.Object>> findChildrenCategories(java.lang.String catInode,
                                                                                               java.lang.String filter)
                                                                                        throws DotDataException,
                                                                                               DotSecurityException,
                                                                                               com.liferay.portal.PortalException,
                                                                                               com.liferay.portal.SystemException
Returns all sub-categories multiple levels depth of the given parent category, it returns them on a single list adding to each category a property that denotes depth

Parameters:
catName - The name of the parent category
filter - A regular expression to use as filter if null, then no filter will be applied
Returns:
Throws:
DotDataException
DotSecurityException
com.liferay.portal.SystemException
com.liferay.portal.PortalException


Copyright © 2010 dotCMS Inc. All Rights Reserved.