Package com.mendix.systemwideinterfaces.connectionbus.requests.types

Interface IGetRequest

All Known Subinterfaces:
IOQLTextGetRequest, ITextGetRequest, IXPathTextGetRequest
public interface IGetRequest
This interface represents a retrieval request. All implementations of this interface can be used to define different manners to retrieve data.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getQueryTimeout()
    Returns the execution timeout of all the queries executed for this request.
    IRetrievalSchema
    getRetrievalSchema()
    Returns the format of the data to be retrieved.
    void
    setQueryTimeout(int queryTimeout)
    Sets the execution timeout of all the queries executed for this request.
    void
    setRetrievalSchema(IRetrievalSchema retrievalSchema)
    Sets the format of the data to be retrieved.
    void
    setRetrieveCount(boolean shouldRetrieveCount)
    Sets whether this request retrieves also the count of the rows, when there isn't set a result limit.
    boolean
    shouldRetrieveCount()
    Returns whether this request retrieves also the count of the rows, when there isn't set a result limit.

  • Method Details

    • getRetrievalSchema

      IRetrievalSchema getRetrievalSchema()
      Returns the format of the data to be retrieved.

    • setRetrievalSchema

      void setRetrievalSchema(IRetrievalSchema retrievalSchema)
      Sets the format of the data to be retrieved.
      Parameters:
      retrievalSchema - the format to set

    • shouldRetrieveCount

      boolean shouldRetrieveCount()
      Returns whether this request retrieves also the count of the rows, when there isn't set a result limit.
      Returns:
      whether this request retrieves also the count of the rows

    • setRetrieveCount

      void setRetrieveCount(boolean shouldRetrieveCount)
      Sets whether this request retrieves also the count of the rows, when there isn't set a result limit.
      Parameters:
      shouldRetrieveCount - this defines whether this request retrieves also the count of the rows

    • getQueryTimeout

      int getQueryTimeout()
      Returns the execution timeout of all the queries executed for this request.
      Returns:
      the query execution timeout

    • setQueryTimeout

      void setQueryTimeout(int queryTimeout)
      Sets the execution timeout of all the queries executed for this request.
      Parameters:
      queryTimeout - the execution timeout in seconds