Liferay 7.0-ce-m3

com.liferay.portlet.shopping.service
Interface ShoppingCategoryLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
ShoppingCategoryLocalServiceBaseImpl, ShoppingCategoryLocalServiceImpl, ShoppingCategoryLocalServiceWrapper

@ProviderType
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface ShoppingCategoryLocalService
extends BaseLocalService, PersistedModelLocalService

Provides the local service interface for ShoppingCategory. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

See Also:
ShoppingCategoryLocalServiceUtil, ShoppingCategoryLocalServiceBaseImpl, ShoppingCategoryLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
 ShoppingCategory addCategory(long userId, long parentCategoryId, String name, String description, ServiceContext serviceContext)
           
 void addCategoryResources(long categoryId, boolean addGroupPermissions, boolean addGuestPermissions)
           
 void addCategoryResources(long categoryId, String[] groupPermissions, String[] guestPermissions)
           
 void addCategoryResources(ShoppingCategory category, boolean addGroupPermissions, boolean addGuestPermissions)
           
 void addCategoryResources(ShoppingCategory category, String[] groupPermissions, String[] guestPermissions)
           
 ShoppingCategory addShoppingCategory(ShoppingCategory shoppingCategory)
          Adds the shopping category to the database.
 ShoppingCategory createShoppingCategory(long categoryId)
          Creates a new shopping category with the primary key.
 void deleteCategories(long groupId)
           
 void deleteCategory(long categoryId)
           
 void deleteCategory(ShoppingCategory category)
           
 PersistedModel deletePersistedModel(PersistedModel persistedModel)
           
 ShoppingCategory deleteShoppingCategory(long categoryId)
          Deletes the shopping category with the primary key from the database.
 ShoppingCategory deleteShoppingCategory(ShoppingCategory shoppingCategory)
          Deletes the shopping category from the database.
 DynamicQuery dynamicQuery()
           
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator)
          Performs a dynamic query on the database and returns an ordered range of the matching rows.
 long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows matching the dynamic query.
 long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows matching the dynamic query.
 ShoppingCategory fetchShoppingCategory(long categoryId)
           
 ActionableDynamicQuery getActionableDynamicQuery()
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 List<ShoppingCategory> getCategories(long groupId)
           
 List<ShoppingCategory> getCategories(long groupId, long parentCategoryId, int start, int end)
           
 int getCategoriesCount(long groupId, long parentCategoryId)
           
 ShoppingCategory getCategory(long categoryId)
           
 ShoppingCategory getCategory(long groupId, String categoryName)
           
 List<ShoppingCategory> getParentCategories(long categoryId)
           
 List<ShoppingCategory> getParentCategories(ShoppingCategory category)
           
 ShoppingCategory getParentCategory(ShoppingCategory category)
           
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 List<ShoppingCategory> getShoppingCategories(int start, int end)
          Returns a range of all the shopping categories.
 int getShoppingCategoriesCount()
          Returns the number of shopping categories.
 ShoppingCategory getShoppingCategory(long categoryId)
          Returns the shopping category with the primary key.
 void getSubcategoryIds(List<Long> categoryIds, long groupId, long categoryId)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 ShoppingCategory updateCategory(long categoryId, long parentCategoryId, String name, String description, boolean mergeWithParentCategory, ServiceContext serviceContext)
           
 ShoppingCategory updateShoppingCategory(ShoppingCategory shoppingCategory)
          Updates the shopping category in the database or adds it if it does not yet exist.
 

Method Detail

addCategory

ShoppingCategory addCategory(long userId,
                             long parentCategoryId,
                             String name,
                             String description,
                             ServiceContext serviceContext)
                             throws PortalException
Throws:
PortalException

addCategoryResources

void addCategoryResources(ShoppingCategory category,
                          boolean addGroupPermissions,
                          boolean addGuestPermissions)
                          throws PortalException
Throws:
PortalException

addCategoryResources

void addCategoryResources(ShoppingCategory category,
                          String[] groupPermissions,
                          String[] guestPermissions)
                          throws PortalException
Throws:
PortalException

addCategoryResources

void addCategoryResources(long categoryId,
                          boolean addGroupPermissions,
                          boolean addGuestPermissions)
                          throws PortalException
Throws:
PortalException

addCategoryResources

void addCategoryResources(long categoryId,
                          String[] groupPermissions,
                          String[] guestPermissions)
                          throws PortalException
Throws:
PortalException

addShoppingCategory

@Indexable(type=REINDEX)
ShoppingCategory addShoppingCategory(ShoppingCategory shoppingCategory)
Adds the shopping category to the database. Also notifies the appropriate model listeners.

Parameters:
shoppingCategory - the shopping category
Returns:
the shopping category that was added

createShoppingCategory

ShoppingCategory createShoppingCategory(long categoryId)
Creates a new shopping category with the primary key. Does not add the shopping category to the database.

Parameters:
categoryId - the primary key for the new shopping category
Returns:
the new shopping category

deleteCategories

void deleteCategories(long groupId)
                      throws PortalException
Throws:
PortalException

deleteCategory

void deleteCategory(ShoppingCategory category)
                    throws PortalException
Throws:
PortalException

deleteCategory

void deleteCategory(long categoryId)
                    throws PortalException
Throws:
PortalException

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                    throws PortalException
Specified by:
deletePersistedModel in interface PersistedModelLocalService
Throws:
PortalException

deleteShoppingCategory

@Indexable(type=DELETE)
ShoppingCategory deleteShoppingCategory(long categoryId)
                                        throws PortalException
Deletes the shopping category with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
categoryId - the primary key of the shopping category
Returns:
the shopping category that was removed
Throws:
PortalException - if a shopping category with the primary key could not be found

deleteShoppingCategory

@Indexable(type=DELETE)
ShoppingCategory deleteShoppingCategory(ShoppingCategory shoppingCategory)
Deletes the shopping category from the database. Also notifies the appropriate model listeners.

Parameters:
shoppingCategory - the shopping category
Returns:
the shopping category that was removed

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

<T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows

dynamicQuery

<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                         int start,
                         int end)
Performs a dynamic query on the database and returns a range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ShoppingCategoryModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:
dynamicQuery - the dynamic query
start - the lower bound of the range of model instances
end - the upper bound of the range of model instances (not inclusive)
Returns:
the range of matching rows

dynamicQuery

<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                         int start,
                         int end,
                         OrderByComparator<T> orderByComparator)
Performs a dynamic query on the database and returns an ordered range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ShoppingCategoryModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:
dynamicQuery - the dynamic query
start - the lower bound of the range of model instances
end - the upper bound of the range of model instances (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of matching rows

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows matching the dynamic query

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery,
                       Projection projection)
Returns the number of rows matching the dynamic query.

Parameters:
dynamicQuery - the dynamic query
projection - the projection to apply to the query
Returns:
the number of rows matching the dynamic query

fetchShoppingCategory

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ShoppingCategory fetchShoppingCategory(long categoryId)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

getCategories

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ShoppingCategory> getCategories(long groupId)

getCategories

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ShoppingCategory> getCategories(long groupId,
                                                                              long parentCategoryId,
                                                                              int start,
                                                                              int end)

getCategoriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCategoriesCount(long groupId,
                                                                long parentCategoryId)

getCategory

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ShoppingCategory getCategory(long categoryId)
                             throws PortalException
Throws:
PortalException

getCategory

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ShoppingCategory getCategory(long groupId,
                                                                      String categoryName)

getParentCategories

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ShoppingCategory> getParentCategories(ShoppingCategory category)
                                           throws PortalException
Throws:
PortalException

getParentCategories

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ShoppingCategory> getParentCategories(long categoryId)
                                           throws PortalException
Throws:
PortalException

getParentCategory

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ShoppingCategory getParentCategory(ShoppingCategory category)
                                   throws PortalException
Throws:
PortalException

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException

getShoppingCategories

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<ShoppingCategory> getShoppingCategories(int start,
                                                                                      int end)
Returns a range of all the shopping categories.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from ShoppingCategoryModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:
start - the lower bound of the range of shopping categories
end - the upper bound of the range of shopping categories (not inclusive)
Returns:
the range of shopping categories

getShoppingCategoriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getShoppingCategoriesCount()
Returns the number of shopping categories.

Returns:
the number of shopping categories

getShoppingCategory

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ShoppingCategory getShoppingCategory(long categoryId)
                                     throws PortalException
Returns the shopping category with the primary key.

Parameters:
categoryId - the primary key of the shopping category
Returns:
the shopping category
Throws:
PortalException - if a shopping category with the primary key could not be found

getSubcategoryIds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
void getSubcategoryIds(List<Long> categoryIds,
                                                                long groupId,
                                                                long categoryId)

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

updateCategory

ShoppingCategory updateCategory(long categoryId,
                                long parentCategoryId,
                                String name,
                                String description,
                                boolean mergeWithParentCategory,
                                ServiceContext serviceContext)
                                throws PortalException
Throws:
PortalException

updateShoppingCategory

@Indexable(type=REINDEX)
ShoppingCategory updateShoppingCategory(ShoppingCategory shoppingCategory)
Updates the shopping category in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
shoppingCategory - the shopping category
Returns:
the shopping category that was updated

Liferay 7.0-ce-m3