com.liferay.dynamic.data.lists.service

Class DDLRecordSetServiceUtil

java.lang.Object

com.liferay.dynamic.data.lists.service.DDLRecordSetServiceUtil

@ProviderType
public class DDLRecordSetServiceUtil
extends java.lang.Object

Provides the remote service utility for DDLRecordSet. This utility wraps com.liferay.dynamic.data.lists.service.impl.DDLRecordSetServiceImpl and is the primary access point for service operations in application layer code running on a remote server. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.

See Also:

DDLRecordSetService, com.liferay.dynamic.data.lists.service.base.DDLRecordSetServiceBaseImpl, com.liferay.dynamic.data.lists.service.impl.DDLRecordSetServiceImpl

Generated:

Constructor Summary

Constructors

Constructor and Description
DDLRecordSetServiceUtil()

Method Summary

Modifier and Type	Method and Description
static DDLRecordSet	addRecordSet(long groupId, long ddmStructureId, java.lang.String recordSetKey, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, int minDisplayRows, int scope, com.liferay.portal.kernel.service.ServiceContext serviceContext) Adds a record set referencing the DDM structure.
static void	deleteRecordSet(long recordSetId) Deletes a record set and its resources.
static DDLRecordSet	fetchRecordSet(long recordSetId) Returns a record set with the ID.
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static DDLRecordSet	getRecordSet(long recordSetId) Returns a record set with the ID.
static java.util.List<DDLRecordSet>	getRecordSets(long[] groupIds) Returns all the record sets matching the groups, filtered by the user's VIEW permission.
static DDLRecordSetService	getService()
static java.util.List<DDLRecordSet>	search(long companyId, long groupId, java.lang.String keywords, int scope, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDLRecordSet> orderByComparator) Returns a range of all record sets matching the parameters, filtered by the user's VIEW permission.
static java.util.List<DDLRecordSet>	search(long companyId, long groupId, java.lang.String name, java.lang.String description, int scope, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDLRecordSet> orderByComparator) Returns an ordered range of record sets, filtered by the user's VIEW permission.
static int	searchCount(long companyId, long groupId, java.lang.String keywords, int scope) Returns the number of record sets matching the parameters, filtered by the user's VIEW permission.
static int	searchCount(long companyId, long groupId, java.lang.String name, java.lang.String description, int scope, boolean andOperator) Returns the number of all record sets matching the parameters, filtered by the user's VIEW permission.
static DDLRecordSet	updateMinDisplayRows(long recordSetId, int minDisplayRows, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates the number of minimum rows to display for the record set.
static DDLRecordSet	updateRecordSet(long recordSetId, DDMFormValues settingsDDMFormValues) Updates the the record set's settings.
static DDLRecordSet	updateRecordSet(long recordSetId, long ddmStructureId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, int minDisplayRows, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates the DDM structure, name, description, and minimum number of display rows for the record set matching the record set ID.
static DDLRecordSet	updateRecordSet(long groupId, long ddmStructureId, java.lang.String recordSetKey, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, int minDisplayRows, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates the DDM structure, name, description, and minimum number of display rows for the record set matching the group ID and record set key.

Methods inherited from class java.lang.Object

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

Constructor Detail

DDLRecordSetServiceUtil

public DDLRecordSetServiceUtil()

Method Detail

addRecordSet

public static DDLRecordSet addRecordSet(long groupId,
                                        long ddmStructureId,
                                        java.lang.String recordSetKey,
                                        java.util.Map<java.util.Locale,java.lang.String> nameMap,
                                        java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                                        int minDisplayRows,
                                        int scope,
                                        com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                 throws com.liferay.portal.kernel.exception.PortalException

Adds a record set referencing the DDM structure.

Parameters:

groupId - the primary key of the record set's group

ddmStructureId - the primary key of the record set's DDM structure

recordSetKey - the mnemonic primary key of the record set. If null, the record set key will be autogenerated.

nameMap - the record set's locales and localized names

descriptionMap - the record set's locales and localized descriptions

minDisplayRows - the record set's minimum number of rows to be displayed in spreadsheet view

scope - the record set's scope, used to scope the record set's data. For more information search DDLRecordSetConstants in the dynamic.data.lists.api module for constants starting with the "SCOPE_" prefix.

serviceContext - serviceContext the service context to be applied. This can set the UUID, guest permissions, and group permissions for the record set.

Returns:

the record set

Throws:

PortalException - if a portal exception occurred

deleteRecordSet

public static void deleteRecordSet(long recordSetId)
                            throws com.liferay.portal.kernel.exception.PortalException

Deletes a record set and its resources.

Parameters:

recordSetId - the primary key of the record set

Throws:

PortalException - if a portal exception occurred

fetchRecordSet

public static DDLRecordSet fetchRecordSet(long recordSetId)
                                   throws com.liferay.portal.kernel.exception.PortalException

Returns a record set with the ID.

Parameters:

recordSetId - the primary key of the record set

Returns:

the record set with the ID or null if the matching record set is not found

Throws:

PortalException - if a portal exception occurred

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getRecordSet

public static DDLRecordSet getRecordSet(long recordSetId)
                                 throws com.liferay.portal.kernel.exception.PortalException

Returns a record set with the ID.

Parameters:

recordSetId - the primary key of the record set

Returns:

the record set with the ID

Throws:

PortalException - if a matching record set could not be found or if the user did not have the required permission to access the record set

getRecordSets

public static java.util.List<DDLRecordSet> getRecordSets(long[] groupIds)

Returns all the record sets matching the groups, filtered by the user's VIEW permission.

Parameters:

groupIds - the primary keys of the record set's groups

Returns:

the matching record sets

search

public static java.util.List<DDLRecordSet> search(long companyId,
                                                  long groupId,
                                                  java.lang.String keywords,
                                                  int scope,
                                                  int start,
                                                  int end,
                                                  com.liferay.portal.kernel.util.OrderByComparator<DDLRecordSet> orderByComparator)

Returns a range of all record sets matching the parameters, filtered by the user's VIEW permission. The keywords parameter is used for matching String values to the record set's name or description.

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:

companyId - the primary key of the record set's company

groupId - the primary key of the record set's group

keywords - the keywords (space separated), which my occur in the record set name or description (optionally null). If the keywords value is not null, the search uses the OR operator in connecting query criteria; otherwise it uses the AND operator.

scope - the record set's scope. Constant used to scope the record set's data. For more information search the dynamic.data.lists.api module's DDLRecordSetConstants class for constants prefixed with "SCOPE_".

start - the lower bound of the range of record sets to return

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

orderByComparator - the comparator to order the record sets

Returns:

the range of matching record sets ordered by the comparator

search

public static java.util.List<DDLRecordSet> search(long companyId,
                                                  long groupId,
                                                  java.lang.String name,
                                                  java.lang.String description,
                                                  int scope,
                                                  boolean andOperator,
                                                  int start,
                                                  int end,
                                                  com.liferay.portal.kernel.util.OrderByComparator<DDLRecordSet> orderByComparator)

Returns an ordered range of record sets, filtered by the user's VIEW permission. Company ID and group ID must be matched. If the and operator is set to true, only record sets with a matching name, description, and scope are returned. If the and operator is set to false, only one parameter of name, description, and scope is needed to return matching record sets.

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:

companyId - the primary key of the record set's company

groupId - the primary key of the record set's group

name - the name keywords (space separated, optionally null)

description - the description keywords (space separated, optionally null)

scope - the record set's scope. Constant used to scope the record set's data. For more information search the dynamic.data.lists.api module's DDLRecordSetConstants class for constants prefixed with "SCOPE_".

andOperator - whether every field must match its value or keywords, or just one field must match. Company and group must match their values.

start - the lower bound of the range of record sets to return

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

orderByComparator - the comparator to order the record sets

Returns:

the range of matching record sets ordered by the comparator

searchCount

public static int searchCount(long companyId,
                              long groupId,
                              java.lang.String keywords,
                              int scope)

Returns the number of record sets matching the parameters, filtered by the user's VIEW permission. The keywords parameter is used for matching record set names or descriptions.

Parameters:

companyId - the primary key of the record set's company

groupId - the primary key of the record set's group.

keywords - the keywords (space separated) to look for and match in the record set name or description (optionally null). If the keywords value is not null, the OR operator is used in connecting query criteria; otherwise it uses the AND operator.

scope - the record set's scope. A constant used to scope the record set's data. For more information search the dynamic.data.lists.api module's DDLRecordSetConstants class for constants prefixed with "SCOPE_".

Returns:

the number of matching record sets

searchCount

public static int searchCount(long companyId,
                              long groupId,
                              java.lang.String name,
                              java.lang.String description,
                              int scope,
                              boolean andOperator)

Returns the number of all record sets matching the parameters, filtered by the user's VIEW permission. If the and operator is set to true, only record sets with a matching name, description, and scope are counted. If the and operator is set to false, only one parameter of name, description, and scope is needed to count matching record sets.

Parameters:

companyId - the primary key of the record set's company

groupId - the primary key of the record set's group

name - the name keywords (space separated). This can be null.

description - the description keywords (space separated). Can be null.

scope - the record set's scope. A constant used to scope the record set's data. For more information search the dynamic.data.lists.api module's DDLRecordSetConstants class for constants prefixed with "SCOPE_".

andOperator - whether every field must match its value or keywords, or just one field must match. Company and group must match their values.

Returns:

the number of matching record sets

updateMinDisplayRows

public static DDLRecordSet updateMinDisplayRows(long recordSetId,
                                                int minDisplayRows,
                                                com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                         throws com.liferay.portal.kernel.exception.PortalException

Updates the number of minimum rows to display for the record set. Useful when the record set is being displayed in spreadsheet.

Parameters:

recordSetId - the primary key of the record set

minDisplayRows - the record set's minimum number of rows to be displayed in spreadsheet view

serviceContext - the service context to be applied. This can set the record set modified date.

Returns:

the record set

Throws:

PortalException - if a portal exception occurred

updateRecordSet

public static DDLRecordSet updateRecordSet(long recordSetId,
                                           DDMFormValues settingsDDMFormValues)
                                    throws com.liferay.portal.kernel.exception.PortalException

Updates the the record set's settings.

Parameters:

recordSetId - the primary key of the record set

settingsDDMFormValues - the record set's settings. For more information see DDMFormValues in the dynamic.data.mapping.api module.

Returns:

the record set

Throws:

PortalException - if a portal exception occurred

updateRecordSet

public static DDLRecordSet updateRecordSet(long recordSetId,
                                           long ddmStructureId,
                                           java.util.Map<java.util.Locale,java.lang.String> nameMap,
                                           java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                                           int minDisplayRows,
                                           com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                    throws com.liferay.portal.kernel.exception.PortalException

Updates the DDM structure, name, description, and minimum number of display rows for the record set matching the record set ID.

Parameters:

recordSetId - the primary key of the record set

ddmStructureId - the primary key of the record set's DDM structure

nameMap - the record set's locales and localized names

descriptionMap - the record set's locales and localized descriptions

minDisplayRows - the record set's minimum number of rows to be displayed in spreadsheet view.

serviceContext - the service context to be applied. Can set the record set modified date.

Returns:

the record set

Throws:

PortalException - if a portal exception occurred

updateRecordSet

public static DDLRecordSet updateRecordSet(long groupId,
                                           long ddmStructureId,
                                           java.lang.String recordSetKey,
                                           java.util.Map<java.util.Locale,java.lang.String> nameMap,
                                           java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                                           int minDisplayRows,
                                           com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                    throws com.liferay.portal.kernel.exception.PortalException

Updates the DDM structure, name, description, and minimum number of display rows for the record set matching the group ID and record set key.

Parameters:

groupId - the primary key of the record set's group

ddmStructureId - the primary key of the record set's DDM structure

recordSetKey - the record set's mnemonic primary key

nameMap - the record set's locales and localized names

descriptionMap - the record set's locales and localized descriptions

minDisplayRows - the record set's minimum number of rows to be displayed in spreadsheet view

serviceContext - the service context to be applied. This can set the record set modified date.

Returns:

the record set

Throws:

PortalException - if a portal exception occurred

getService

public static DDLRecordSetService getService()