Liferay 6.2-ce-ga5

com.liferay.portal.service
Interface ResourceLocalService

All Superinterfaces:
BaseLocalService
All Known Implementing Classes:
ResourceLocalServiceWrapper

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

Provides the local service interface for Resource. 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:
ResourceLocalServiceUtil, ResourceLocalServiceBaseImpl, com.liferay.portal.service.impl.ResourceLocalServiceImpl

Method Summary
 void addModelResources(AuditedModel auditedModel, ServiceContext serviceContext)
          Adds resources for the model, always creating a resource at the individual scope and only creating resources at the group, group template, and company scope if such resources don't already exist.
 void addModelResources(long companyId, long groupId, long userId, String name, long primKey, String[] groupPermissions, String[] guestPermissions)
          Adds resources for the model with the name and primary key, always creating a resource at the individual scope and only creating resources at the group, group template, and company scope if such resources don't already exist.
 void addModelResources(long companyId, long groupId, long userId, String name, String primKey, String[] groupPermissions, String[] guestPermissions)
          Adds resources for the model with the name and primary key string, always creating a resource at the individual scope and only creating resources at the group, group template, and company scope if such resources don't already exist.
 void addResources(long companyId, long groupId, long userId, String name, long primKey, boolean portletActions, boolean addGroupPermissions, boolean addGuestPermissions)
          Adds resources for the entity with the name and primary key, always creating a resource at the individual scope and only creating resources at the group, group template, and company scope if such resources don't already exist.
 void addResources(long companyId, long groupId, long userId, String name, String primKey, boolean portletActions, boolean addGroupPermissions, boolean addGuestPermissions)
          Adds resources for the entity with the name and primary key string, always creating a resource at the individual scope and only creating resources at the group, group template, and company scope if such resources don't already exist.
 void addResources(long companyId, long groupId, String name, boolean portletActions)
          Adds resources for the entity with the name.
 void deleteResource(AuditedModel auditedModel, int scope)
          Deletes the resource associated with the model at the scope.
 void deleteResource(long companyId, String name, int scope, long primKey)
          Deletes the resource matching the primary key at the scope.
 void deleteResource(long companyId, String name, int scope, String primKey)
          Deletes the resource matching the primary key at the scope.
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 Resource getResource(long companyId, String name, int scope, String primKey)
          Returns a new resource with the name and primary key at the scope.
 boolean hasUserPermissions(long userId, long resourceId, List<Resource> resources, String actionId, long[] roleIds)
          Returns true if the roles have permission to perform the action on the resources.
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void updateModelResources(AuditedModel auditedModel, ServiceContext serviceContext)
          Updates the resources for the model, replacing their group and guest permissions with new ones from the service context.
 void updateResources(long companyId, long groupId, String name, long primKey, String[] groupPermissions, String[] guestPermissions)
          Updates resources matching the group, name, and primary key at the individual scope, setting new group and guest permissions.
 void updateResources(long companyId, long groupId, String name, String primKey, String[] groupPermissions, String[] guestPermissions)
          Updates resources matching the group, name, and primary key string at the individual scope, setting new group and guest permissions.
 void updateResources(long companyId, String name, int scope, String primKey, String newPrimKey)
          Updates resources matching the name, primary key string and scope, replacing the primary key of their resource permissions with the new primary key.
 

Method Detail

getBeanIdentifier

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

Returns:
the Spring bean ID for this bean

setBeanIdentifier

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

Parameters:
beanIdentifier - the Spring bean ID for this bean

addModelResources

void addModelResources(AuditedModel auditedModel,
                       ServiceContext serviceContext)
                       throws PortalException,
                              SystemException
Adds resources for the model, always creating a resource at the individual scope and only creating resources at the group, group template, and company scope if such resources don't already exist.
  1. If the service context specifies that default group or default guest permissions are to be added, then only default permissions are added. See ServiceContext.setAddGroupPermissions( boolean) and ServiceContext.setAddGuestPermissions( boolean).
  2. Else ...
    1. If the service context specifies to derive default permissions, then default group and guest permissions are derived from the model and added. See ServiceContext.setDeriveDefaultPermissions( boolean).
    2. Lastly group and guest permissions from the service context are applied. See ServiceContext.setGroupPermissions(String[]) and ServiceContext.setGuestPermissions(String[]).

Parameters:
auditedModel - the model to associate with the resources
serviceContext - the service context to apply. Can set whether to add the model's default group and guest permissions, set whether to derive default group and guest permissions from the model, set group permissions to apply, and set guest permissions to apply.
Throws:
PortalException - if no portal actions could be found associated with the model or if a portal exception occurred
SystemException - if a system exception occurred

addModelResources

void addModelResources(long companyId,
                       long groupId,
                       long userId,
                       String name,
                       long primKey,
                       String[] groupPermissions,
                       String[] guestPermissions)
                       throws PortalException,
                              SystemException
Adds resources for the model with the name and primary key, always creating a resource at the individual scope and only creating resources at the group, group template, and company scope if such resources don't already exist.

Parameters:
companyId - the primary key of the portal instance
groupId - the primary key of the group
userId - the primary key of the user adding the resources
name - a name for the resource, typically the model's class name
primKey - the primary key of the model instance, optionally 0 if no instance exists
groupPermissions - the group permissions to be applied
guestPermissions - the guest permissions to be applied
Throws:
PortalException - if no portal actions could be found associated with the model or if a portal exception occurred
SystemException - if a system exception occurred

addModelResources

void addModelResources(long companyId,
                       long groupId,
                       long userId,
                       String name,
                       String primKey,
                       String[] groupPermissions,
                       String[] guestPermissions)
                       throws PortalException,
                              SystemException
Adds resources for the model with the name and primary key string, always creating a resource at the individual scope and only creating resources at the group, group template, and company scope if such resources don't already exist.

Parameters:
companyId - the primary key of the portal instance
groupId - the primary key of the group
userId - the primary key of the user adding the resources
name - a name for the resource, typically the model's class name
primKey - the primary key string of the model instance, optionally an empty string if no instance exists
groupPermissions - the group permissions to be applied
guestPermissions - the guest permissions to be applied
Throws:
PortalException - if no portal actions could be found associated with the model or if a portal exception occurred
SystemException - if a system exception occurred

addResources

void addResources(long companyId,
                  long groupId,
                  long userId,
                  String name,
                  long primKey,
                  boolean portletActions,
                  boolean addGroupPermissions,
                  boolean addGuestPermissions)
                  throws PortalException,
                         SystemException
Adds resources for the entity with the name and primary key, always creating a resource at the individual scope and only creating resources at the group, group template, and company scope if such resources don't already exist.

Parameters:
companyId - the primary key of the portal instance
groupId - the primary key of the group
userId - the primary key of the user adding the resources
name - a name for the resource, which should be a portlet ID if the resource is a portlet or the resource's class name otherwise
primKey - the primary key of the resource instance, optionally 0 if no instance exists
portletActions - whether to associate portlet actions with the resource
addGroupPermissions - whether to add group permissions
addGuestPermissions - whether to add guest permissions
Throws:
PortalException - if no portal actions could be found associated with the resource or if a portal exception occurred
SystemException - if a system exception occurred

addResources

void addResources(long companyId,
                  long groupId,
                  long userId,
                  String name,
                  String primKey,
                  boolean portletActions,
                  boolean addGroupPermissions,
                  boolean addGuestPermissions)
                  throws PortalException,
                         SystemException
Adds resources for the entity with the name and primary key string, always creating a resource at the individual scope and only creating resources at the group, group template, and company scope if such resources don't already exist.

Parameters:
companyId - the primary key of the portal instance
groupId - the primary key of the group
userId - the primary key of the user adding the resources
name - a name for the resource, which should be a portlet ID if the resource is a portlet or the resource's class name otherwise
primKey - the primary key string of the resource instance, optionally an empty string if no instance exists
portletActions - whether to associate portlet actions with the resource
addGroupPermissions - whether to add group permissions
addGuestPermissions - whether to add guest permissions
Throws:
PortalException - if no portal actions could be found associated with the resource or if a portal exception occurred
SystemException - if a system exception occurred

addResources

void addResources(long companyId,
                  long groupId,
                  String name,
                  boolean portletActions)
                  throws PortalException,
                         SystemException
Adds resources for the entity with the name. Use this method if the user is unknown or irrelevant and there is no current entity instance.

Parameters:
companyId - the primary key of the portal instance
groupId - the primary key of the group
name - a name for the resource, which should be a portlet ID if the resource is a portlet or the resource's class name otherwise
portletActions - whether to associate portlet actions with the resource
Throws:
PortalException - if no portal actions could be found associated with the resource or if a portal exception occurred
SystemException - if a system exception occurred

deleteResource

void deleteResource(AuditedModel auditedModel,
                    int scope)
                    throws PortalException,
                           SystemException
Deletes the resource associated with the model at the scope.

Parameters:
auditedModel - the model associated with the resource
scope - the scope of the resource. For more information see ResourceConstants.
Throws:
PortalException - if a portal exception occurred
SystemException - if a system exception occurred

deleteResource

void deleteResource(long companyId,
                    String name,
                    int scope,
                    long primKey)
                    throws PortalException,
                           SystemException
Deletes the resource matching the primary key at the scope.

Parameters:
companyId - the primary key of the portal instance
name - the resource's name, which should be a portlet ID if the resource is a portlet or the resource's class name otherwise
scope - the scope of the resource. For more information see ResourceConstants.
primKey - the primary key of the resource instance
Throws:
PortalException - if a portal exception occurred
SystemException - if a system exception occurred

deleteResource

void deleteResource(long companyId,
                    String name,
                    int scope,
                    String primKey)
                    throws PortalException,
                           SystemException
Deletes the resource matching the primary key at the scope.

Parameters:
companyId - the primary key of the portal instance
name - the resource's name, which should be a portlet ID if the resource is a portlet or the resource's class name otherwise
scope - the scope of the resource. For more information see ResourceConstants.
primKey - the primary key string of the resource instance
Throws:
PortalException - if a portal exception occurred
SystemException - if a system exception occurred

getResource

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Resource getResource(long companyId,
                                                              String name,
                                                              int scope,
                                                              String primKey)
Returns a new resource with the name and primary key at the scope.

Parameters:
companyId - the primary key of the portal instance
name - a name for the resource, which should be a portlet ID if the resource is a portlet or the resource's class name otherwise
scope - the scope of the resource. For more information see ResourceConstants.
primKey - the primary key string of the resource
Returns:
the new resource

hasUserPermissions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasUserPermissions(long userId,
                                                                    long resourceId,
                                                                    List<Resource> resources,
                                                                    String actionId,
                                                                    long[] roleIds)
                           throws PortalException,
                                  SystemException
Returns true if the roles have permission to perform the action on the resources.

Parameters:
userId - the primary key of the user performing the permission check
resourceId - the primary key of the resource, typically the scope group ID representing the scope in which the permission check is being performed
resources - the resources for which permissions are to be checked
actionId - the primary key of the action to be performed on the resources
roleIds - the primary keys of the roles
Returns:
true if the roles have permission to perform the action on the resources;false otherwise
Throws:
PortalException - if any one of the roles with the primary keys could not be found or if a resource action with the action ID could not be found
SystemException - if a system exception occurred

updateModelResources

void updateModelResources(AuditedModel auditedModel,
                          ServiceContext serviceContext)
                          throws PortalException,
                                 SystemException
Updates the resources for the model, replacing their group and guest permissions with new ones from the service context.

Parameters:
auditedModel - the model associated with the resources
serviceContext - the service context to be applied. Can set group and guest permissions.
Throws:
PortalException - if a portal exception occurred
SystemException - if a system exception occurred

updateResources

void updateResources(long companyId,
                     long groupId,
                     String name,
                     long primKey,
                     String[] groupPermissions,
                     String[] guestPermissions)
                     throws PortalException,
                            SystemException
Updates resources matching the group, name, and primary key at the individual scope, setting new group and guest permissions.

Parameters:
companyId - the primary key of the portal instance
groupId - the primary key of the group
name - the resource's name, which should be a portlet ID if the resource is a portlet or the resource's class name otherwise
primKey - the primary key of the resource instance
groupPermissions - the group permissions to be applied
guestPermissions - the guest permissions to be applied
Throws:
PortalException - if a portal exception occurred
SystemException - if a system exception occurred

updateResources

void updateResources(long companyId,
                     long groupId,
                     String name,
                     String primKey,
                     String[] groupPermissions,
                     String[] guestPermissions)
                     throws PortalException,
                            SystemException
Updates resources matching the group, name, and primary key string at the individual scope, setting new group and guest permissions.

Parameters:
companyId - the primary key of the portal instance
groupId - the primary key of the group
name - the resource's name, which should be a portlet ID if the resource is a portlet or the resource's class name otherwise
primKey - the primary key string of the resource instance
groupPermissions - the group permissions to be applied
guestPermissions - the guest permissions to be applied
Throws:
PortalException - if a portal exception occurred
SystemException - if a system exception occurred

updateResources

void updateResources(long companyId,
                     String name,
                     int scope,
                     String primKey,
                     String newPrimKey)
                     throws SystemException
Updates resources matching the name, primary key string and scope, replacing the primary key of their resource permissions with the new primary key.

Parameters:
companyId - the primary key of the portal instance
name - the resource's name, which should be a portlet ID if the resource is a portlet or the resource's class name otherwise
scope - the scope of the resource. For more information see ResourceConstants.
primKey - the primary key string of the resource instance
newPrimKey - the new primary key string of the resource
Throws:
SystemException - if a system exception occurred

Liferay 6.2-ce-ga5