Interface DDLRecordSetService

All Superinterfaces:
com.liferay.portal.kernel.service.BaseService
All Known Implementing Classes:
DDLRecordSetServiceWrapper

@AccessControlled @CTAware @JSONWebService @ProviderType @Transactional(isolation=PORTAL, rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class}) public interface DDLRecordSetService extends com.liferay.portal.kernel.service.BaseService
Provides the remote service interface for DDLRecordSet. 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:
Generated:
  • Method Summary

    Modifier and Type
    Method
    Description
    addRecordSet(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.
    void
    deleteRecordSet(long recordSetId)
    Deletes a record set and its resources.
    fetchRecordSet(long recordSetId)
    Returns a record set with the ID.
    Returns the OSGi service identifier.
    getRecordSet(long recordSetId)
    Returns a record set with the ID.
    getRecordSets(long[] groupIds)
    Returns all the record sets matching the groups, filtered by the user's VIEW permission.
    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, filtered by the user's VIEW permission.
    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, filtered by the user's VIEW permission.
    int
    searchCount(long companyId, long groupId, String keywords, int scope)
    Returns the number of record sets matching the parameters, filtered by the user's VIEW permission.
    int
    searchCount(long companyId, long groupId, String name, String description, int scope, boolean andOperator)
    Returns the number of all record sets matching the parameters, filtered by the user's VIEW permission.
    updateMinDisplayRows(long recordSetId, int minDisplayRows, com.liferay.portal.kernel.service.ServiceContext serviceContext)
    Updates the number of minimum rows to display for the record set.
    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 structure, name, description, and minimum number of display rows for the record set matching the group ID and record set key.
    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.
    updateRecordSet(long recordSetId, com.liferay.dynamic.data.mapping.storage.DDMFormValues settingsDDMFormValues)
    Updates the the record set's settings.
  • Method Details

    • addRecordSet

      DDLRecordSet addRecordSet(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) 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:
      com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
    • deleteRecordSet

      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:
      com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
    • fetchRecordSet

      @Transactional(propagation=SUPPORTS, readOnly=true) 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:
      com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
    • getOSGiServiceIdentifier

      String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • getRecordSet

      @Transactional(propagation=SUPPORTS, readOnly=true) 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:
      com.liferay.portal.kernel.exception.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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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, 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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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, 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

      @Transactional(propagation=SUPPORTS, readOnly=true) int searchCount(long companyId, long groupId, 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

      @Transactional(propagation=SUPPORTS, readOnly=true) int searchCount(long companyId, long groupId, String name, 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

      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:
      com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
    • updateRecordSet

      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 set
      settingsDDMFormValues - the record set's settings. For more information see DDMFormValues in the dynamic.data.mapping.api module.
      Returns:
      the record set
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
    • updateRecordSet

      DDLRecordSet updateRecordSet(long recordSetId, long ddmStructureId, Map<Locale,String> nameMap, Map<Locale,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:
      com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
    • updateRecordSet

      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) 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:
      com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred