Class DDLRecordSetLocalServiceUtil
com.liferay.dynamic.data.lists.service.impl.DDLRecordSetLocalServiceImpl
and
is an 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.- See Also:
- Generated:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic DDLRecordSet
addDDLRecordSet
(DDLRecordSet ddlRecordSet) Adds the ddl record set to the database.static DDLRecordSet
addRecordSet
(long userId, long groupId, long ddmStructureId, String recordSetKey, Map<Locale, String> nameMap, Map<Locale, String> descriptionMap, int minDisplayRows, int scope, com.liferay.portal.kernel.service.ServiceContext serviceContext) Adds a record set referencing the DDM structure.static void
addRecordSetResources
(DDLRecordSet recordSet, boolean addGroupPermissions, boolean addGuestPermissions) Adds the resources to the record set.static void
addRecordSetResources
(DDLRecordSet recordSet, com.liferay.portal.kernel.service.permission.ModelPermissions modelPermissions) Adds the model resources with the permissions to the record set.static DDLRecordSet
createDDLRecordSet
(long recordSetId) Creates a new ddl record set with the primary key.static com.liferay.portal.kernel.model.PersistedModel
createPersistedModel
(Serializable primaryKeyObj) static DDLRecordSet
deleteDDLRecordSet
(long recordSetId) Deletes the ddl record set with the primary key from the database.static DDLRecordSet
deleteDDLRecordSet
(DDLRecordSet ddlRecordSet) Deletes the ddl record set from the database.static void
deleteDDMStructureRecordSets
(long ddmStructureId) static com.liferay.portal.kernel.model.PersistedModel
deletePersistedModel
(com.liferay.portal.kernel.model.PersistedModel persistedModel) static void
deleteRecordSet
(long recordSetId) Deletes the record set and its resources.static void
deleteRecordSet
(long groupId, String recordSetKey) Deletes the record set and its resources.static void
deleteRecordSet
(DDLRecordSet recordSet) Deletes the record set and its resources.static void
deleteRecordSets
(long groupId) Deletes all the record sets matching the group.static <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static com.liferay.portal.kernel.dao.orm.DynamicQuery
static <T> List<T>
dynamicQuery
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.static <T> List<T>
dynamicQuery
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.static <T> List<T>
dynamicQuery
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.static long
dynamicQueryCount
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static long
dynamicQueryCount
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.static DDLRecordSet
fetchDDLRecordSet
(long recordSetId) static DDLRecordSet
fetchDDLRecordSetByUuidAndGroupId
(String uuid, long groupId) Returns the ddl record set matching the UUID and group.static DDLRecordSet
fetchRecordSet
(long recordSetId) Returns the record set with the ID.static DDLRecordSet
fetchRecordSet
(long groupId, String recordSetKey) Returns the record set matching the group and record set key.static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery
static DDLRecordSet
getDDLRecordSet
(long recordSetId) Returns the ddl record set with the primary key.static DDLRecordSet
getDDLRecordSetByUuidAndGroupId
(String uuid, long groupId) Returns the ddl record set matching the UUID and group.static List<DDLRecordSet>
getDDLRecordSets
(int start, int end) Returns a range of all the ddl record sets.static List<DDLRecordSet>
getDDLRecordSetsByUuidAndCompanyId
(String uuid, long companyId) Returns all the ddl record sets matching the UUID and company.static List<DDLRecordSet>
getDDLRecordSetsByUuidAndCompanyId
(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDLRecordSet> orderByComparator) Returns a range of ddl record sets matching the UUID and company.static int
Returns the number of ddl record sets.static List<DDLRecordSet>
getDDMStructureRecordSets
(long ddmStructureId) static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery
getExportActionableDynamicQuery
(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery
static String
Returns the OSGi service identifier.static com.liferay.portal.kernel.model.PersistedModel
getPersistedModel
(Serializable primaryKeyObj) static DDLRecordSet
getRecordSet
(long recordSetId) Returns the record set with the ID.static DDLRecordSet
getRecordSet
(long groupId, String recordSetKey) Returns the record set matching the group and record set key.static DDLRecordSet
getRecordSet
(String uuid, long recordSetId) static List<DDLRecordSet>
getRecordSets
(long groupId) Returns all the record sets belonging the group.static List<DDLRecordSet>
getRecordSets
(long groupId, int start, int end) static int
getRecordSetsCount
(long groupId) Returns the number of all the record sets belonging the group.static int
getRecordSetsCount
(long groupId, long ddmStructureId, boolean andOperator) Returns the number of all the record sets belonging the group and associated with the DDMStructure.static com.liferay.dynamic.data.mapping.storage.DDMFormValues
getRecordSetSettingsDDMFormValues
(DDLRecordSet recordSet) Returns the record set's settings as a DDMFormValues object.static DDLRecordSetSettings
getRecordSetSettingsModel
(DDLRecordSet recordSet) Returns the record set's settings.static DDLRecordSetLocalService
static List<DDLRecordSet>
search
(long companyId, long groupId, 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, including a keywords parameter for matching string values to the record set's name or description.static List<DDLRecordSet>
search
(long companyId, long groupId, String name, 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.static int
searchCount
(long companyId, long groupId, String keywords, int scope) Returns the number of record sets matching the parameters.static int
searchCount
(long companyId, long groupId, String name, String description, int scope, boolean andOperator) Returns the number of all record sets matching the parameters.static DDLRecordSet
updateDDLRecordSet
(DDLRecordSet ddlRecordSet) Updates the ddl record set in the database or adds it if it does not yet exist.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 groupId, long ddmStructureId, String recordSetKey, Map<Locale, String> nameMap, Map<Locale, String> descriptionMap, int minDisplayRows, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates the DDM strucutre, name, description, and minimum number of display rows for the record set matching the record set key and group ID.static DDLRecordSet
updateRecordSet
(long recordSetId, long ddmStructureId, Map<Locale, String> nameMap, Map<Locale, 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 recordSetId, com.liferay.dynamic.data.mapping.storage.DDMFormValues settingsDDMFormValues) Updates the the record set's settings.
-
Constructor Details
-
DDLRecordSetLocalServiceUtil
public DDLRecordSetLocalServiceUtil()
-
-
Method Details
-
addDDLRecordSet
Adds the ddl record set to the database. Also notifies the appropriate model listeners.Important: Inspect DDLRecordSetLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
ddlRecordSet
- the ddl record set- Returns:
- the ddl record set that was added
-
addRecordSet
public static DDLRecordSet addRecordSet(long userId, long groupId, long ddmStructureId, String recordSetKey, Map<Locale, String> nameMap, Map<Locale, throws com.liferay.portal.kernel.exception.PortalExceptionString> descriptionMap, int minDisplayRows, int scope, com.liferay.portal.kernel.service.ServiceContext serviceContext) Adds a record set referencing the DDM structure.- Parameters:
userId
- the primary key of the record set's creator/ownergroupId
- the primary key of the record set's groupddmStructureId
- the primary key of the record set's DDM structurerecordSetKey
- the record set's mnemonic primary key. Ifnull
, the record set key will be autogenerated.nameMap
- the record set's locales and localized namesdescriptionMap
- the record set's locales and localized descriptionsminDisplayRows
- 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 searchDDLRecordSetConstants
in thedynamic.data.lists.api
module for constants starting with the "SCOPE_" prefix.serviceContext
- the service context to be applied. Can set the UUID, guest permissions, and group permissions for the record set.- Returns:
- the record set
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
addRecordSetResources
public static void addRecordSetResources(DDLRecordSet recordSet, boolean addGroupPermissions, boolean addGuestPermissions) throws com.liferay.portal.kernel.exception.PortalException Adds the resources to the record set.- Parameters:
recordSet
- the record setaddGroupPermissions
- whether to add group permissionsaddGuestPermissions
- whether to add guest permissions- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
addRecordSetResources
public static void addRecordSetResources(DDLRecordSet recordSet, com.liferay.portal.kernel.service.permission.ModelPermissions modelPermissions) throws com.liferay.portal.kernel.exception.PortalException Adds the model resources with the permissions to the record set.- Parameters:
recordSet
- the record setmodelPermissions
- the model permissions- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
createDDLRecordSet
Creates a new ddl record set with the primary key. Does not add the ddl record set to the database.- Parameters:
recordSetId
- the primary key for the new ddl record set- Returns:
- the new ddl record set
-
createPersistedModel
public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteDDLRecordSet
Deletes the ddl record set from the database. Also notifies the appropriate model listeners.Important: Inspect DDLRecordSetLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
ddlRecordSet
- the ddl record set- Returns:
- the ddl record set that was removed
-
deleteDDLRecordSet
public static DDLRecordSet deleteDDLRecordSet(long recordSetId) throws com.liferay.portal.kernel.exception.PortalException Deletes the ddl record set with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect DDLRecordSetLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
recordSetId
- the primary key of the ddl record set- Returns:
- the ddl record set that was removed
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a ddl record set with the primary key could not be found
-
deleteDDMStructureRecordSets
public static void deleteDDMStructureRecordSets(long ddmStructureId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deletePersistedModel
public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteRecordSet
public static void deleteRecordSet(DDLRecordSet recordSet) throws com.liferay.portal.kernel.exception.PortalException Deletes the record set and its resources.- Parameters:
recordSet
- the record set to be deleted- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
deleteRecordSet
public static void deleteRecordSet(long recordSetId) throws com.liferay.portal.kernel.exception.PortalException Deletes the record set and its resources.- Parameters:
recordSetId
- the primary key of the record set to be deleted- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
deleteRecordSet
public static void deleteRecordSet(long groupId, String recordSetKey) throws com.liferay.portal.kernel.exception.PortalException Deletes the record set and its resources.This operation updates the record set matching the group and recordSetKey.
- Parameters:
groupId
- the primary key of the record set's grouprecordSetKey
- the record set's mnemonic primary key- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
deleteRecordSets
public static void deleteRecordSets(long groupId) throws com.liferay.portal.kernel.exception.PortalException Deletes all the record sets matching the group.- Parameters:
groupId
- the primary key of the record set's group- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
dslQuery
public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dslQueryCount
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dynamicQuery
public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() -
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
public static <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end) 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.dynamic.data.lists.model.impl.DDLRecordSetModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)- Returns:
- the range of matching rows
-
dynamicQuery
public static <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.dynamic.data.lists.model.impl.DDLRecordSetModelImpl
.- Parameters:
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 (optionallynull
)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchDDLRecordSet
-
fetchDDLRecordSetByUuidAndGroupId
Returns the ddl record set matching the UUID and group.- Parameters:
uuid
- the ddl record set's UUIDgroupId
- the primary key of the group- Returns:
- the matching ddl record set, or
null
if a matching ddl record set could not be found
-
fetchRecordSet
Returns the record set with the ID.- Parameters:
recordSetId
- the primary key of the record set- Returns:
- the record set with the ID, or
null
if a matching record set could not be found
-
fetchRecordSet
Returns the record set matching the group and record set key.- Parameters:
groupId
- the primary key of the record set's grouprecordSetKey
- the record set's mnemonic primary key- Returns:
- the record set matching the group and record set key, or
null
if a matching record set could not be found
-
getActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() -
getDDLRecordSet
public static DDLRecordSet getDDLRecordSet(long recordSetId) throws com.liferay.portal.kernel.exception.PortalException Returns the ddl record set with the primary key.- Parameters:
recordSetId
- the primary key of the ddl record set- Returns:
- the ddl record set
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a ddl record set with the primary key could not be found
-
getDDLRecordSetByUuidAndGroupId
public static DDLRecordSet getDDLRecordSetByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException Returns the ddl record set matching the UUID and group.- Parameters:
uuid
- the ddl record set's UUIDgroupId
- the primary key of the group- Returns:
- the matching ddl record set
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a matching ddl record set could not be found
-
getDDLRecordSets
Returns a range of all the ddl record sets.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.dynamic.data.lists.model.impl.DDLRecordSetModelImpl
.- Parameters:
start
- the lower bound of the range of ddl record setsend
- the upper bound of the range of ddl record sets (not inclusive)- Returns:
- the range of ddl record sets
-
getDDLRecordSetsByUuidAndCompanyId
Returns all the ddl record sets matching the UUID and company.- Parameters:
uuid
- the UUID of the ddl record setscompanyId
- the primary key of the company- Returns:
- the matching ddl record sets, or an empty list if no matches were found
-
getDDLRecordSetsByUuidAndCompanyId
public static List<DDLRecordSet> getDDLRecordSetsByUuidAndCompanyId(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDLRecordSet> orderByComparator) Returns a range of ddl record sets matching the UUID and company.- Parameters:
uuid
- the UUID of the ddl record setscompanyId
- the primary key of the companystart
- the lower bound of the range of ddl record setsend
- the upper bound of the range of ddl record sets (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the range of matching ddl record sets, or an empty list if no matches were found
-
getDDLRecordSetsCount
public static int getDDLRecordSetsCount()Returns the number of ddl record sets.- Returns:
- the number of ddl record sets
-
getDDMStructureRecordSets
-
getExportActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) -
getIndexableActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getRecordSet
public static DDLRecordSet getRecordSet(long recordSetId) throws com.liferay.portal.kernel.exception.PortalException Returns the record set with the ID.- Parameters:
recordSetId
- the primary key of the record set- Returns:
- the record set with the ID
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if the the matching record set could not be found
-
getRecordSet
public static DDLRecordSet getRecordSet(long groupId, String recordSetKey) throws com.liferay.portal.kernel.exception.PortalException Returns the record set matching the group and record set key.- Parameters:
groupId
- the primary key of the record set's grouprecordSetKey
- the record set's mnemonic primary key- Returns:
- the record set matching the group and record set key
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if the the matching record set could not be found
-
getRecordSet
public static DDLRecordSet getRecordSet(String uuid, long recordSetId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getRecordSets
Returns all the record sets belonging the group.- Returns:
- the record sets belonging to the group
-
getRecordSets
-
getRecordSetsCount
public static int getRecordSetsCount(long groupId) Returns the number of all the record sets belonging the group.- Parameters:
groupId
- the primary key of the record set's group- Returns:
- the number of record sets belonging to the group
-
getRecordSetsCount
public static int getRecordSetsCount(long groupId, long ddmStructureId, boolean andOperator) Returns the number of all the record sets belonging the group and associated with the DDMStructure.- Parameters:
groupId
- the primary key of the record set's group- Returns:
- the number of record sets belonging to the group
-
getRecordSetSettingsDDMFormValues
public static com.liferay.dynamic.data.mapping.storage.DDMFormValues getRecordSetSettingsDDMFormValues(DDLRecordSet recordSet) throws com.liferay.portal.kernel.exception.PortalException Returns the record set's settings as a DDMFormValues object. For more information seeDDMFormValues
in thedynamic.data.mapping.api
module.- Parameters:
recordSet
- the record set- Returns:
- the record set settings as a DDMFormValues object
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
getRecordSetSettingsModel
public static DDLRecordSetSettings getRecordSetSettingsModel(DDLRecordSet recordSet) throws com.liferay.portal.kernel.exception.PortalException Returns the record set's settings.- Parameters:
recordSet
- the record set- Returns:
- the record set settings
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred- See Also:
-
search
public static List<DDLRecordSet> search(long companyId, long groupId, 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, including a keywords parameter for matching string values to the record set's name or description.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil.ALL_POS
will return the full result set.- Parameters:
companyId
- the primary key of the record set's companygroupId
- the primary key of the record set's groupkeywords
- the keywords (space separated) to look for and match in the record set name or description (optionallynull
). If the keywords value is notnull
, the search uses the OR operator 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 thedynamic.data.lists.api
module'sDDLRecordSetConstants
class for constants prefixed with "SCOPE_".start
- the lower bound of the range of record sets to returnend
- the upper bound of the range of recor 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 List<DDLRecordSet> search(long companyId, long groupId, String name, 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. Company ID and group ID must be matched. If the and operator is set totrue
, only record sets with a matching name, description, and scope are returned. If the and operator is set tofalse
, 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil.ALL_POS
will return the full result set.- Parameters:
companyId
- the primary key of the record set's companygroupId
- the primary key of the record set's groupname
- the name keywords (space separated, optionallynull
)description
- the description keywords (space separated, optionallynull
)scope
- the record set's scope. A constant used to scope the record set's data. For more information search thedynamic.data.lists.api
module'sDDLRecordSetConstants
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 returnend
- the upper bound of the range of recor 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
Returns the number of record sets matching the parameters. The keywords parameter is used for matching the record set's name or description- Parameters:
companyId
- the primary key of the record set's companygroupId
- 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 (optionallynull
). If the keywords value is notnull
, 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 thedynamic.data.lists.api
module'sDDLRecordSetConstants
class for constants prefixed with "SCOPE_".- Returns:
- the number of matching record sets
-
searchCount
public static int searchCount(long companyId, long groupId, String name, String description, int scope, boolean andOperator) Returns the number of all record sets matching the parameters. name and description keywords. Company ID and group ID must be matched. If the and operator is set totrue
, only record sets with a matching name, description, and scope are counted. If the and operator is set tofalse
, 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 companygroupId
- the primary key of the record set's groupname
- the name keywords (space separated). This can benull
.description
- the description keywords (space separated). This can benull
.scope
- the record set's scope. A constant used to scope the record set's data. For more information search thedynamic.data.lists.api
module'sDDLRecordSetConstants
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
-
updateDDLRecordSet
Updates the ddl record set in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect DDLRecordSetLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
ddlRecordSet
- the ddl record set- Returns:
- the ddl record set that was updated
-
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 setminDisplayRows
- the record set's minimum number of rows to be displayed in spreadsheet viewserviceContext
- the service context to be applied. This can set the record set modified date.- Returns:
- the record set
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
updateRecordSet
public static DDLRecordSet updateRecordSet(long recordSetId, com.liferay.dynamic.data.mapping.storage.DDMFormValues settingsDDMFormValues) throws com.liferay.portal.kernel.exception.PortalException Updates the the record set's settings.- Parameters:
recordSetId
- the primary key of the record setsettingsDDMFormValues
- the record set's settings. For more information seeDDMFormValues
in thedynamic.data.mapping.api
the module.- Returns:
- the record set
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
updateRecordSet
public static DDLRecordSet updateRecordSet(long recordSetId, long ddmStructureId, Map<Locale, String> nameMap, Map<Locale, throws com.liferay.portal.kernel.exception.PortalExceptionString> 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.- Parameters:
recordSetId
- the primary key of the record setddmStructureId
- the primary key of the record set's DDM structurenameMap
- the record set's locales and localized namesdescriptionMap
- the record set's locales and localized descriptionsminDisplayRows
- the record set's minimum number of rows to be displayed in spreadsheet viewserviceContext
- the service context to be applied. This can set the record set modified date.- Returns:
- the record set
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
updateRecordSet
public static DDLRecordSet updateRecordSet(long groupId, long ddmStructureId, String recordSetKey, Map<Locale, String> nameMap, Map<Locale, throws com.liferay.portal.kernel.exception.PortalExceptionString> descriptionMap, int minDisplayRows, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates the DDM strucutre, name, description, and minimum number of display rows for the record set matching the record set key and group ID.- Parameters:
groupId
- the primary key of the record set's groupddmStructureId
- the primary key of the record set's DDM structurerecordSetKey
- the record set's mnemonic primary keynameMap
- the record set's locales and localized namesdescriptionMap
- the record set's locales and localized descriptionsminDisplayRows
- the record set's minimum number of rows to be displayed in spreadsheet viewserviceContext
- the service context to be applied. This can set the record set modified date.- Returns:
- the record set
- Throws:
com.liferay.portal.kernel.exception.PortalException
- if a portal exception occurred
-
getService
-