|
Liferay 6.1.2-ce-ga3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.liferay.portal.service.ResourceLocalServiceUtil
public class ResourceLocalServiceUtil
The utility for the resource local service. This utility wraps com.liferay.portal.service.impl.ResourceLocalServiceImpl
and is the primary access point for service operations in application layer code running on the local server.
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.
ResourceLocalService
,
ResourceLocalServiceBaseImpl
,
com.liferay.portal.service.impl.ResourceLocalServiceImpl
Constructor Summary | |
---|---|
ResourceLocalServiceUtil()
|
Method Summary | |
---|---|
static 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. |
static 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. |
static 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. |
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 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. |
static 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. |
static void |
addResources(long companyId,
long groupId,
String name,
boolean portletActions)
Adds resources for the entity with the name. |
static Resource |
createResource(long resourceId)
Creates a new resource with the primary key. |
static void |
deleteResource(AuditedModel auditedModel,
int scope)
Deletes the resource associated with the model at the scope. |
static Resource |
deleteResource(long resourceId)
Deletes the resource with the primary key from the database. |
static void |
deleteResource(long companyId,
String name,
int scope,
long primKey)
Deletes the resource matching the primary key at the scope. |
static void |
deleteResource(long companyId,
String name,
int scope,
String primKey)
Deletes the resource matching the primary key at the scope. |
static Resource |
deleteResource(Resource resource)
Deletes the resource from the database. |
static void |
deleteResources(String name)
|
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 Resource |
fetchResource(long resourceId)
|
static Resource |
fetchResource(long companyId,
String name,
int scope,
String primKey)
|
static String |
getBeanIdentifier()
Returns the Spring bean ID for this bean. |
static long |
getLatestResourceId()
|
static PersistedModel |
getPersistedModel(Serializable primaryKeyObj)
|
static Resource |
getResource(long resourceId)
Returns the resource with the primary key. |
static Resource |
getResource(long companyId,
String name,
int scope,
String primKey)
Returns a new resource with the name and primary key at the scope. |
static List<Resource> |
getResources()
|
static List<Resource> |
getResources(int start,
int end)
Returns a range of all the resources. |
static int |
getResourcesCount()
Returns the number of resources. |
static ResourceLocalService |
getService()
|
static void |
setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean. |
void |
setService(ResourceLocalService service)
Deprecated. |
static 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. |
static Resource |
updateResource(Resource resource)
Updates the resource in the database or adds it if it does not yet exist. |
static Resource |
updateResource(Resource resource,
boolean merge)
Updates the resource in the database or adds it if it does not yet exist. |
static 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. |
static 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. |
static 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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ResourceLocalServiceUtil()
Method Detail |
---|
public static Resource addResource(Resource resource) throws SystemException
resource
- the resource
SystemException
- if a system exception occurredpublic static Resource createResource(long resourceId)
resourceId
- the primary key for the new resource
public static Resource deleteResource(long resourceId) throws PortalException, SystemException
resourceId
- the primary key of the resource
PortalException
- if a resource with the primary key could not be found
SystemException
- if a system exception occurredpublic static Resource deleteResource(Resource resource) throws SystemException
resource
- the resource
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.
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.
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 Resource fetchResource(long resourceId) throws SystemException
SystemException
public static Resource getResource(long resourceId) throws PortalException, SystemException
resourceId
- the primary key of the resource
PortalException
- if a resource 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<Resource> getResources(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.
start
- the lower bound of the range of resourcesend
- the upper bound of the range of resources (not inclusive)
SystemException
- if a system exception occurredpublic static int getResourcesCount() throws SystemException
SystemException
- if a system exception occurredpublic static Resource updateResource(Resource resource) throws SystemException
resource
- the resource
SystemException
- if a system exception occurredpublic static Resource updateResource(Resource resource, boolean merge) throws SystemException
resource
- the resourcemerge
- 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.
SystemException
- if a system exception occurredpublic static String getBeanIdentifier()
public static void setBeanIdentifier(String beanIdentifier)
beanIdentifier
- the Spring bean ID for this beanpublic static void addModelResources(AuditedModel auditedModel, ServiceContext serviceContext) throws PortalException, SystemException
ServiceContext.setAddGroupPermissions(
boolean)
and ServiceContext.setAddGuestPermissions(
boolean)
.
ServiceContext.setDeriveDefaultPermissions(
boolean)
.
ServiceContext.setGroupPermissions(String[])
and com.liferay.portal.service.ServiceContext#setGuesPermissions(String[])
.
auditedModel
- the model to associate with the resourcesserviceContext
- 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.
PortalException
- if no portal actions could be found associated
with the model or if a portal exception occurred
SystemException
- if a system exception occurredpublic static void addModelResources(long companyId, long groupId, long userId, String name, long primKey, String[] groupPermissions, String[] guestPermissions) throws PortalException, SystemException
companyId
- the primary key of the portal instancegroupId
- the primary key of the groupuserId
- the primary key of the user adding the resourcesname
- a name for the resource, typically the model's class nameprimKey
- the primary key of the model instance, optionally
0
if no instance existsgroupPermissions
- the group permissions to be appliedguestPermissions
- the guest permissions to be applied
PortalException
- if no portal actions could be found associated
with the model or if a portal exception occurred
SystemException
- if a system exception occurredpublic static void addModelResources(long companyId, long groupId, long userId, String name, String primKey, String[] groupPermissions, String[] guestPermissions) throws PortalException, SystemException
companyId
- the primary key of the portal instancegroupId
- the primary key of the groupuserId
- the primary key of the user adding the resourcesname
- a name for the resource, typically the model's class nameprimKey
- the primary key string of the model instance, optionally
an empty string if no instance existsgroupPermissions
- the group permissions to be appliedguestPermissions
- the guest permissions to be applied
PortalException
- if no portal actions could be found associated
with the model or if a portal exception occurred
SystemException
- if a system exception occurredpublic static Resource addResource(long companyId, String name, int scope, String primKey) throws SystemException
SystemException
public static void addResources(long companyId, long groupId, long userId, String name, long primKey, boolean portletActions, boolean addGroupPermissions, boolean addGuestPermissions) throws PortalException, SystemException
companyId
- the primary key of the portal instancegroupId
- the primary key of the groupuserId
- the primary key of the user adding the resourcesname
- a name for the resource, which should be a portlet ID if the
resource is a portlet or the resource's class name otherwiseprimKey
- the primary key of the resource instance, optionally
0
if no instance existsportletActions
- whether to associate portlet actions with the
resourceaddGroupPermissions
- whether to add group permissionsaddGuestPermissions
- whether to add guest permissions
PortalException
- if no portal actions could be found associated
with the resource or if a portal exception occurred
SystemException
- if a system exception occurredpublic static void addResources(long companyId, long groupId, long userId, String name, String primKey, boolean portletActions, boolean addGroupPermissions, boolean addGuestPermissions) throws PortalException, SystemException
companyId
- the primary key of the portal instancegroupId
- the primary key of the groupuserId
- the primary key of the user adding the resourcesname
- a name for the resource, which should be a portlet ID if the
resource is a portlet or the resource's class name otherwiseprimKey
- the primary key string of the resource instance,
optionally an empty string if no instance existsportletActions
- whether to associate portlet actions with the
resourceaddGroupPermissions
- whether to add group permissionsaddGuestPermissions
- whether to add guest permissions
PortalException
- if no portal actions could be found associated
with the resource or if a portal exception occurred
SystemException
- if a system exception occurredpublic static void addResources(long companyId, long groupId, String name, boolean portletActions) throws PortalException, SystemException
companyId
- the primary key of the portal instancegroupId
- the primary key of the groupname
- a name for the resource, which should be a portlet ID if the
resource is a portlet or the resource's class name otherwiseportletActions
- whether to associate portlet actions with the
resource
PortalException
- if no portal actions could be found associated
with the resource or if a portal exception occurred
SystemException
- if a system exception occurredpublic static void deleteResource(AuditedModel auditedModel, int scope) throws PortalException, SystemException
auditedModel
- the model associated with the resourcescope
- the scope of the resource. For more information see ResourceConstants
.
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredpublic static void deleteResource(long companyId, String name, int scope, long primKey) throws PortalException, SystemException
companyId
- the primary key of the portal instancename
- the resource's name, which should be a portlet ID if the
resource is a portlet or the resource's class name otherwisescope
- the scope of the resource. For more information see ResourceConstants
.primKey
- the primary key of the resource instance
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredpublic static void deleteResource(long companyId, String name, int scope, String primKey) throws PortalException, SystemException
companyId
- the primary key of the portal instancename
- the resource's name, which should be a portlet ID if the
resource is a portlet or the resource's class name otherwisescope
- the scope of the resource. For more information see ResourceConstants
.primKey
- the primary key string of the resource instance
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredpublic static void deleteResources(String name) throws SystemException
SystemException
public static Resource fetchResource(long companyId, String name, int scope, String primKey) throws SystemException
SystemException
public static long getLatestResourceId() throws SystemException
SystemException
public static Resource getResource(long companyId, String name, int scope, String primKey) throws PortalException, SystemException
companyId
- the primary key of the portal instancename
- a name for the resource, which should be a portlet ID if the
resource is a portlet or the resource's class name otherwisescope
- the scope of the resource. For more information see ResourceConstants
.primKey
- the primary key string of the resource
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredpublic static List<Resource> getResources() throws SystemException
SystemException
public static void updateModelResources(AuditedModel auditedModel, ServiceContext serviceContext) throws PortalException, SystemException
auditedModel
- the model associated with the resourcesserviceContext
- the service context to be applied. Can set group
and guest permissions.
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredpublic static void updateResources(long companyId, long groupId, String name, long primKey, String[] groupPermissions, String[] guestPermissions) throws PortalException, SystemException
companyId
- the primary key of the portal instancegroupId
- the primary key of the groupname
- the resource's name, which should be a portlet ID if the
resource is a portlet or the resource's class name otherwiseprimKey
- the primary key of the resource instancegroupPermissions
- the group permissions to be appliedguestPermissions
- the guest permissions to be applied
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredpublic static void updateResources(long companyId, long groupId, String name, String primKey, String[] groupPermissions, String[] guestPermissions) throws PortalException, SystemException
companyId
- the primary key of the portal instancegroupId
- the primary key of the groupname
- the resource's name, which should be a portlet ID if the
resource is a portlet or the resource's class name otherwiseprimKey
- the primary key string of the resource instancegroupPermissions
- the group permissions to be appliedguestPermissions
- the guest permissions to be applied
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredpublic static void updateResources(long companyId, String name, int scope, String primKey, String newPrimKey) throws PortalException, SystemException
companyId
- the primary key of the portal instancename
- the resource's name, which should be a portlet ID if the
resource is a portlet or the resource's class name otherwisescope
- the scope of the resource. For more information see ResourceConstants
.primKey
- the primary key string of the resource instancenewPrimKey
- the new primary key string of the resource
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredpublic static ResourceLocalService getService()
public void setService(ResourceLocalService service)
|
Liferay 6.1.2-ce-ga3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |