|
Liferay 6.2-ce-ga5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.liferay.portlet.shopping.service.ShoppingCategoryLocalServiceUtil
@ProviderType public class ShoppingCategoryLocalServiceUtil
Provides the local service utility for ShoppingCategory. This utility wraps
com.liferay.portlet.shopping.service.impl.ShoppingCategoryLocalServiceImpl
and is the
primary access point for service operations in application layer code running
on the local server. 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.
ShoppingCategoryLocalService
,
com.liferay.portlet.shopping.service.base.ShoppingCategoryLocalServiceBaseImpl
,
com.liferay.portlet.shopping.service.impl.ShoppingCategoryLocalServiceImpl
Constructor Summary | |
---|---|
ShoppingCategoryLocalServiceUtil()
|
Method Summary | |
---|---|
static ShoppingCategory |
addCategory(long userId,
long parentCategoryId,
String name,
String description,
ServiceContext serviceContext)
|
static void |
addCategoryResources(long categoryId,
boolean addGroupPermissions,
boolean addGuestPermissions)
|
static void |
addCategoryResources(long categoryId,
String[] groupPermissions,
String[] guestPermissions)
|
static void |
addCategoryResources(ShoppingCategory category,
boolean addGroupPermissions,
boolean addGuestPermissions)
|
static void |
addCategoryResources(ShoppingCategory category,
String[] groupPermissions,
String[] guestPermissions)
|
static ShoppingCategory |
addShoppingCategory(ShoppingCategory shoppingCategory)
Adds the shopping category to the database. |
static ShoppingCategory |
createShoppingCategory(long categoryId)
Creates a new shopping category with the primary key. |
static void |
deleteCategories(long groupId)
|
static void |
deleteCategory(long categoryId)
|
static void |
deleteCategory(ShoppingCategory category)
|
static ShoppingCategory |
deleteShoppingCategory(long categoryId)
Deletes the shopping category with the primary key from the database. |
static ShoppingCategory |
deleteShoppingCategory(ShoppingCategory shoppingCategory)
Deletes the shopping category from the database. |
static DynamicQuery |
dynamicQuery()
|
static List |
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows. |
static List |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows. |
static List |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator orderByComparator)
Performs a dynamic query on the database and returns an ordered range of the matching rows. |
static long |
dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows that match the dynamic query. |
static long |
dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
Returns the number of rows that match the dynamic query. |
static ShoppingCategory |
fetchShoppingCategory(long categoryId)
|
static String |
getBeanIdentifier()
Returns the Spring bean ID for this bean. |
static List<ShoppingCategory> |
getCategories(long groupId)
|
static List<ShoppingCategory> |
getCategories(long groupId,
long parentCategoryId,
int start,
int end)
|
static int |
getCategoriesCount(long groupId,
long parentCategoryId)
|
static ShoppingCategory |
getCategory(long categoryId)
|
static ShoppingCategory |
getCategory(long groupId,
String categoryName)
|
static List<ShoppingCategory> |
getParentCategories(long categoryId)
|
static List<ShoppingCategory> |
getParentCategories(ShoppingCategory category)
|
static ShoppingCategory |
getParentCategory(ShoppingCategory category)
|
static PersistedModel |
getPersistedModel(Serializable primaryKeyObj)
|
static ShoppingCategoryLocalService |
getService()
|
static List<ShoppingCategory> |
getShoppingCategories(int start,
int end)
Returns a range of all the shopping categories. |
static int |
getShoppingCategoriesCount()
Returns the number of shopping categories. |
static ShoppingCategory |
getShoppingCategory(long categoryId)
Returns the shopping category with the primary key. |
static void |
getSubcategoryIds(List<Long> categoryIds,
long groupId,
long categoryId)
|
static void |
setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean. |
void |
setService(ShoppingCategoryLocalService service)
Deprecated. As of 6.2.0 |
static ShoppingCategory |
updateCategory(long categoryId,
long parentCategoryId,
String name,
String description,
boolean mergeWithParentCategory,
ServiceContext serviceContext)
|
static ShoppingCategory |
updateShoppingCategory(ShoppingCategory shoppingCategory)
Updates the shopping category in the database or adds it if it does not yet exist. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ShoppingCategoryLocalServiceUtil()
Method Detail |
---|
public static ShoppingCategory addShoppingCategory(ShoppingCategory shoppingCategory) throws SystemException
shoppingCategory
- the shopping category
SystemException
- if a system exception occurredpublic static ShoppingCategory createShoppingCategory(long categoryId)
categoryId
- the primary key for the new shopping category
public static ShoppingCategory deleteShoppingCategory(long categoryId) throws PortalException, SystemException
categoryId
- the primary key of the shopping category
PortalException
- if a shopping category with the primary key could not be found
SystemException
- if a system exception occurredpublic static ShoppingCategory deleteShoppingCategory(ShoppingCategory shoppingCategory) throws SystemException
shoppingCategory
- the shopping category
SystemException
- if a system exception occurredpublic static DynamicQuery dynamicQuery()
public static List dynamicQuery(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query
SystemException
- if a system exception occurredpublic static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end) throws SystemException
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.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)
SystemException
- if a system exception occurredpublic static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) throws SystemException
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.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)
SystemException
- if a system exception occurredpublic static long dynamicQueryCount(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query
SystemException
- if a system exception occurredpublic static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) throws SystemException
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query
SystemException
- if a system exception occurredpublic static ShoppingCategory fetchShoppingCategory(long categoryId) throws SystemException
SystemException
public static ShoppingCategory getShoppingCategory(long categoryId) throws PortalException, SystemException
categoryId
- the primary key of the shopping category
PortalException
- if a shopping category with the primary key could not be found
SystemException
- if a system exception occurredpublic static PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException, SystemException
PortalException
SystemException
public static List<ShoppingCategory> getShoppingCategories(int start, int end) throws SystemException
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.
start
- the lower bound of the range of shopping categoriesend
- the upper bound of the range of shopping categories (not inclusive)
SystemException
- if a system exception occurredpublic static int getShoppingCategoriesCount() throws SystemException
SystemException
- if a system exception occurredpublic static ShoppingCategory updateShoppingCategory(ShoppingCategory shoppingCategory) throws SystemException
shoppingCategory
- the shopping category
SystemException
- if a system exception occurredpublic static String getBeanIdentifier()
public static void setBeanIdentifier(String beanIdentifier)
beanIdentifier
- the Spring bean ID for this beanpublic static ShoppingCategory addCategory(long userId, long parentCategoryId, String name, String description, ServiceContext serviceContext) throws PortalException, SystemException
PortalException
SystemException
public static void addCategoryResources(long categoryId, boolean addGroupPermissions, boolean addGuestPermissions) throws PortalException, SystemException
PortalException
SystemException
public static void addCategoryResources(long categoryId, String[] groupPermissions, String[] guestPermissions) throws PortalException, SystemException
PortalException
SystemException
public static void addCategoryResources(ShoppingCategory category, boolean addGroupPermissions, boolean addGuestPermissions) throws PortalException, SystemException
PortalException
SystemException
public static void addCategoryResources(ShoppingCategory category, String[] groupPermissions, String[] guestPermissions) throws PortalException, SystemException
PortalException
SystemException
public static void deleteCategories(long groupId) throws PortalException, SystemException
PortalException
SystemException
public static void deleteCategory(long categoryId) throws PortalException, SystemException
PortalException
SystemException
public static void deleteCategory(ShoppingCategory category) throws PortalException, SystemException
PortalException
SystemException
public static List<ShoppingCategory> getCategories(long groupId) throws SystemException
SystemException
public static List<ShoppingCategory> getCategories(long groupId, long parentCategoryId, int start, int end) throws SystemException
SystemException
public static int getCategoriesCount(long groupId, long parentCategoryId) throws SystemException
SystemException
public static ShoppingCategory getCategory(long categoryId) throws PortalException, SystemException
PortalException
SystemException
public static ShoppingCategory getCategory(long groupId, String categoryName) throws SystemException
SystemException
public static List<ShoppingCategory> getParentCategories(long categoryId) throws PortalException, SystemException
PortalException
SystemException
public static List<ShoppingCategory> getParentCategories(ShoppingCategory category) throws PortalException, SystemException
PortalException
SystemException
public static ShoppingCategory getParentCategory(ShoppingCategory category) throws PortalException, SystemException
PortalException
SystemException
public static void getSubcategoryIds(List<Long> categoryIds, long groupId, long categoryId) throws SystemException
SystemException
public static ShoppingCategory updateCategory(long categoryId, long parentCategoryId, String name, String description, boolean mergeWithParentCategory, ServiceContext serviceContext) throws PortalException, SystemException
PortalException
SystemException
public static ShoppingCategoryLocalService getService()
public void setService(ShoppingCategoryLocalService service)
|
Liferay 6.2-ce-ga5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |