Interface DDLExporter


public interface DDLExporter
Provides a service for exporting Record Set records. The format this service uses to export records is the format that was specified to the DDLExporterFactory that created this service.
See Also:
  • Method Summary

    Modifier and Type
    Method
    Description
    byte[]
    export(long recordSetId)
    Exports the record set's records as a byte array.
    byte[]
    export(long recordSetId, int status)
    Exports the record set's records of the workflow status as a byte array.
    byte[]
    export(long recordSetId, int status, int start, int end)
    Exports a range of the record set's records as a byte array.
    byte[]
    export(long recordSetId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDLRecord> orderByComparator)
    Exports an ordered range of the record set's records as a byte array.
    Returns the export format of the current DDL Exporter service instance.
    Returns the locale of the current DDL Exporter service instance.
    void
    setLocale(Locale locale)
    Returns the locale of the current DDL Exporter service instance.
  • Method Details

    • export

      byte[] export(long recordSetId) throws Exception
      Exports the record set's records as a byte array.
      Parameters:
      recordSetId - the record set ID
      Returns:
      the byte values of the exported records
      Throws:
      Exception - if an unexpected exception occurred
    • export

      byte[] export(long recordSetId, int status) throws Exception
      Exports the record set's records of the workflow status as a byte array.
      Parameters:
      recordSetId - the record set ID
      status - the workflow status of the records to export
      Returns:
      the byte values of the exported records
      Throws:
      Exception - if an unexpected exception occurred
    • export

      byte[] export(long recordSetId, int status, int start, int end) throws Exception
      Exports a range of the record set's records as a byte array.
      Parameters:
      recordSetId - the record set ID
      status - the workflow status of the records
      start - the lower bound of the range of records to export
      end - the upper bound of the range of records to export (not inclusive)
      Returns:
      the byte values of the exported records
      Throws:
      Exception - if an unexpected exception occurred
    • export

      byte[] export(long recordSetId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<DDLRecord> orderByComparator) throws Exception
      Exports an ordered range of the record set's records as a byte array.
      Parameters:
      recordSetId - the record set ID
      status - the workflow status of the records
      start - the lower bound of the range of records to export
      end - the upper bound of the range of records to export (not inclusive)
      orderByComparator - a comparator to order the records (optionally null)
      Returns:
      the byte values of the exported records
      Throws:
      Exception - if an unexpected exception occurred
    • getFormat

      String getFormat()
      Returns the export format of the current DDL Exporter service instance.
      Returns:
      the format value of the current service instance
    • getLocale

      Locale getLocale()
      Returns the locale of the current DDL Exporter service instance.
      Returns:
      the locale of the current service instance
    • setLocale

      void setLocale(Locale locale)
      Returns the locale of the current DDL Exporter service instance.
      Parameters:
      locale - the locale used to retrieve the localized values of the record