Package org.labkey.remoteapi.query

Class SaveRowsCommand.Command

java.lang.Object
org.labkey.remoteapi.query.SaveRowsCommand.Command
Enclosing class:
SaveRowsCommand
public static class SaveRowsCommand.Command extends Object
Represents a single command operation of a specified type (e.g., insert, update, delete) to be executed within a SaveRowsCommand.

  • Constructor Details

  • Method Details

    • getJsonObject

      public org.json.JSONObject getJsonObject()

    • getAuditBehavior

      public BaseRowsCommand.AuditBehavior getAuditBehavior()
      Gets the audit behavior setting for this command. Determines the level of detail in the audit log for this operation.
      Returns:
      The current audit behavior setting, or null if using default behavior

    • setAuditBehavior

      public SaveRowsCommand.Command setAuditBehavior(BaseRowsCommand.AuditBehavior auditBehavior)
      Sets the audit behavior for this command.
      Parameters:
      auditBehavior - The desired audit behavior
      Returns:
      This Command instance for method chaining

    • getAuditUserComment

      public String getAuditUserComment()
      Gets the user-provided comment that will be included in the audit log.
      Returns:
      The audit comment, or null if none was set

    • setAuditUserComment

      public SaveRowsCommand.Command setAuditUserComment(String auditUserComment)
      Sets a user comment to be included in the audit log for this command.
      Parameters:
      auditUserComment - The comment to include in the audit log
      Returns:
      This Command instance for method chaining

    • getCommandType

      public SaveRowsCommand.CommandType getCommandType()
      Gets the type of operation this command represents.
      Returns:
      The CommandType for this command

    • getContainerPath

      public String getContainerPath()
      Gets the container path where this command should be executed.
      Returns:
      The container path, or null if using the default container

    • setContainerPath

      public SaveRowsCommand.Command setContainerPath(String containerPath)
      Sets the container path where this command should be executed.
      Parameters:
      containerPath - The target container path
      Returns:
      This Command instance for method chaining

    • getExtraContext

      public Map<String,Object> getExtraContext()
      Gets additional context parameters specific to this command.
      Returns:
      Map of extra context parameters, or null if none are set

    • setExtraContext

      public SaveRowsCommand.Command setExtraContext(Map<String,Object> extraContext)
      Sets additional context parameters for this specific command.
      Parameters:
      extraContext - Map of extra parameters to be passed with this command
      Returns:
      This Command instance for method chaining

    • getQueryName

      public String getQueryName()
      Gets the name of the query this command operates on.
      Returns:
      The query name

    • getSchemaName

      public String getSchemaName()
      Gets the name of the schema containing the query.
      Returns:
      The schema name

    • getRows

      public List<Map<String,Object>> getRows()
      Gets the list of rows to be processed by this command. Each row is represented as a Map of column names to values.
      Returns:
      List of rows to be processed

    • setRows

      public SaveRowsCommand.Command setRows(List<Map<String,Object>> rows)
      Sets the list of rows to be processed by this command.
      Parameters:
      rows - List of maps where each map represents a row with column names as keys
      Returns:
      This Command instance for method chaining

    • isSkipReselectRows

      public Boolean isSkipReselectRows()
      Checks if the command should skip re-selecting rows after the operation.
      Returns:
      Boolean indicating whether to skip row re-selection or null for default behavior

    • setSkipReselectRows

      public SaveRowsCommand.Command setSkipReselectRows(Boolean skipReselectRows)
      Sets whether to skip re-selecting rows after the operation completes.
      Parameters:
      skipReselectRows - When true, skips row reselection after the operation When false, performs row reselection When null, uses server default behavior
      Returns:
      This Command instance for method chaining