Interface DeleteInterface

All Known Implementing Classes:
APIDeleteAction, FilesystemDeleteAction, MemoryDeleteAction, MockDeleteAction, MongoDBDeleteAction, RDBMSDeleteAction, S3DeleteAction, SFTPDeleteAction
public interface DeleteInterface
Interface for the Delete action.

  • Method Summary

    Modifier and Type
    Method
    Description
    DeleteOutput
    execute(DeleteInput deleteInput)
     
    default boolean
    supportsPreFetchQuery()
    Specify whether this particular module's delete action can invalid input: '&' should fetch records before deleting them, e.g., for audits or "not-found-checks"
    default boolean
    supportsQueryFilterInput()
    Specify whether this particular module's delete action natively supports receiving a queryFilter as input (e.g., SQL does).

  • Method Details

    • execute

      DeleteOutput execute(DeleteInput deleteInput) throws QException
      Throws:
      QException

    • supportsQueryFilterInput

      default boolean supportsQueryFilterInput()
      Specify whether this particular module's delete action natively supports receiving a queryFilter as input (e.g., SQL does). If the module doesn't support a query filter, then the qqq framework (DeleteAction) will, if it receives a queryFilter in its input, it will execute the query, and pass the list of primary keys down into the module's delete implementation.

    • supportsPreFetchQuery

      default boolean supportsPreFetchQuery()
      Specify whether this particular module's delete action can invalid input: '&' should fetch records before deleting them, e.g., for audits or "not-found-checks"