com.liferay.portal.service
Class ResourceLocalServiceUtil

java.lang.Object
  com.liferay.portal.service.ResourceLocalServiceUtil

public class ResourceLocalServiceUtil
extends Object

The utility for the resource local service. This utility wraps ResourceLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

Never modify this class directly. Add custom service methods to ResourceLocalServiceImpl and rerun ServiceBuilder to regenerate this class.

This is a local service. 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:

ResourceLocalService, ResourceLocalServiceBaseImpl, ResourceLocalServiceImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Constructor Summary

ResourceLocalServiceUtil()

Method Summary

static void	addModelResources(long companyId, long groupId, long userId, String name, long primKey, String[] communityPermissions, String[] guestPermissions)
static void	addModelResources(long companyId, long groupId, long userId, String name, String primKey, String[] communityPermissions, String[] guestPermissions)
static Resource	addResource(long companyId, String name, int scope, String primKey)
static Resource	addResource(Resource resource) Adds the resource to the database.
static void	addResources(long companyId, long groupId, long userId, String name, long primKey, boolean portletActions, boolean addCommunityPermissions, boolean addGuestPermissions)
static void	addResources(long companyId, long groupId, long userId, String name, String primKey, boolean portletActions, boolean addCommunityPermissions, boolean addGuestPermissions)
static void	addResources(long companyId, long groupId, String name, boolean portletActions)
static Resource	createResource(long resourceId) Creates a new resource with the primary key.
static void	deleteResource(long resourceId) Deletes the resource with the primary key from the database.
static void	deleteResource(long companyId, String name, int scope, long primKey)
static void	deleteResource(long companyId, String name, int scope, String primKey)
static void	deleteResource(Resource resource) Deletes the resource from the database.
static void	deleteResources(String name)
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) Counts the number of rows that match the dynamic query.
static long	getLatestResourceId()
static Resource	getResource(long resourceId) Gets the resource with the primary key.
static Resource	getResource(long companyId, String name, int scope, String primKey)
static List<Resource>	getResources()
static List<Resource>	getResources(int start, int end) Gets a range of all the resources.
static int	getResourcesCount() Gets the number of resources.
static ResourceLocalService	getService()
void	setService(ResourceLocalService service)
static Resource	updateResource(Resource resource) Updates the resource in the database.
static Resource	updateResource(Resource resource, boolean merge) Updates the resource in the database.
static void	updateResources(long companyId, long groupId, String name, long primKey, String[] communityPermissions, String[] guestPermissions)
static void	updateResources(long companyId, long groupId, String name, String primKey, String[] communityPermissions, String[] guestPermissions)
static void	updateResources(long companyId, String name, int scope, String primKey, String newPrimKey)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ResourceLocalServiceUtil

public ResourceLocalServiceUtil()

Method Detail

addResource

public static Resource addResource(Resource resource)
                            throws SystemException

Adds the resource to the database. Also notifies the appropriate model listeners.

Parameters:

resource - the resource to add

Returns:

the resource that was added

Throws:

SystemException - if a system exception occurred

createResource

public static Resource createResource(long resourceId)

Creates a new resource with the primary key. Does not add the resource to the database.

Parameters:

resourceId - the primary key for the new resource

Returns:

the new resource

deleteResource

public static void deleteResource(long resourceId)
                           throws PortalException,
                                  SystemException

Deletes the resource with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

resourceId - the primary key of the resource to delete

Throws:

PortalException - if a resource with the primary key could not be found

SystemException - if a system exception occurred

deleteResource

public static void deleteResource(Resource resource)
                           throws SystemException

Deletes the resource from the database. Also notifies the appropriate model listeners.

Parameters:

resource - the resource to delete

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery)
                         throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query to search with

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end)
                         throws SystemException

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.

Parameters:

dynamicQuery - the dynamic query to search with

start - the lower bound of the range of model instances to return

end - the upper bound of the range of model instances to return (not inclusive)

Returns:

the range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                         throws SystemException

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.

Parameters:

dynamicQuery - the dynamic query to search with

start - the lower bound of the range of model instances to return

end - the upper bound of the range of model instances to return (not inclusive)

orderByComparator - the comparator to order the results by

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException

Counts the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query to search with

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

getResource

public static Resource getResource(long resourceId)
                            throws PortalException,
                                   SystemException

Gets the resource with the primary key.

Parameters:

resourceId - the primary key of the resource to get

Returns:

the resource

Throws:

PortalException - if a resource with the primary key could not be found

SystemException - if a system exception occurred

getResources

public static List<Resource> getResources(int start,
                                          int end)
                                   throws SystemException

Gets a range of all the resources.

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.

Parameters:

start - the lower bound of the range of resources to return

end - the upper bound of the range of resources to return (not inclusive)

Returns:

the range of resources

Throws:

SystemException - if a system exception occurred

getResourcesCount

public static int getResourcesCount()
                             throws SystemException

Gets the number of resources.

Returns:

the number of resources

Throws:

SystemException - if a system exception occurred

updateResource

public static Resource updateResource(Resource resource)
                               throws SystemException

Updates the resource in the database. Also notifies the appropriate model listeners.

Parameters:

resource - the resource to update

Returns:

the resource that was updated

Throws:

SystemException - if a system exception occurred

updateResource

public static Resource updateResource(Resource resource,
                                      boolean merge)
                               throws SystemException

Updates the resource in the database. Also notifies the appropriate model listeners.

Parameters:

resource - the resource to update

merge - whether to merge the resource with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.

Returns:

the resource that was updated

Throws:

SystemException - if a system exception occurred

addModelResources

public static void addModelResources(long companyId,
                                     long groupId,
                                     long userId,
                                     String name,
                                     long primKey,
                                     String[] communityPermissions,
                                     String[] guestPermissions)
                              throws PortalException,
                                     SystemException

Throws:

PortalException

SystemException

addModelResources

public static void addModelResources(long companyId,
                                     long groupId,
                                     long userId,
                                     String name,
                                     String primKey,
                                     String[] communityPermissions,
                                     String[] guestPermissions)
                              throws PortalException,
                                     SystemException

Throws:

PortalException

SystemException

addResource

public static Resource addResource(long companyId,
                                   String name,
                                   int scope,
                                   String primKey)
                            throws SystemException

Throws:

SystemException

addResources

public static void addResources(long companyId,
                                long groupId,
                                String name,
                                boolean portletActions)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

addResources

public static void addResources(long companyId,
                                long groupId,
                                long userId,
                                String name,
                                long primKey,
                                boolean portletActions,
                                boolean addCommunityPermissions,
                                boolean addGuestPermissions)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

addResources

public static void addResources(long companyId,
                                long groupId,
                                long userId,
                                String name,
                                String primKey,
                                boolean portletActions,
                                boolean addCommunityPermissions,
                                boolean addGuestPermissions)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

deleteResource

public static void deleteResource(long companyId,
                                  String name,
                                  int scope,
                                  long primKey)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

deleteResource

public static void deleteResource(long companyId,
                                  String name,
                                  int scope,
                                  String primKey)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

deleteResources

public static void deleteResources(String name)
                            throws SystemException

Throws:

SystemException

getLatestResourceId

public static long getLatestResourceId()
                                throws SystemException

Throws:

SystemException

getResource

public static Resource getResource(long companyId,
                                   String name,
                                   int scope,
                                   String primKey)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

getResources

public static List<Resource> getResources()
                                   throws SystemException

Throws:

SystemException

updateResources

public static void updateResources(long companyId,
                                   String name,
                                   int scope,
                                   String primKey,
                                   String newPrimKey)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

updateResources

public static void updateResources(long companyId,
                                   long groupId,
                                   String name,
                                   long primKey,
                                   String[] communityPermissions,
                                   String[] guestPermissions)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

updateResources

public static void updateResources(long companyId,
                                   long groupId,
                                   String name,
                                   String primKey,
                                   String[] communityPermissions,
                                   String[] guestPermissions)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

getService

public static ResourceLocalService getService()

setService

public void setService(ResourceLocalService service)