/**********************************************************************
// @@@ START COPYRIGHT @@@
//
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.
//
// @@@ END COPYRIGHT @@@
**********************************************************************/
/* -*-C++-*-
****************************************************************************
*
* File:         ComTdbControl.h
* Description:  
*
* Created:      5/6/98
* Language:     C++
*
*
*
*
****************************************************************************
*/

#ifndef COMTDBCONTROL_H
#define COMTDBCONTROL_H

#include "ComTdb.h"

class CliGlobals;
class Queue;

enum ControlQueryType
  {
    SHAPE_ = 0, DEFAULT_ = 1, TABLE_ = 2, CONTROL_SESSION_ = 3,
    SESSION_DEFAULT_ = 4
  };


///////////////////////////////////////////////////////
// class ExControlTdb
///////////////////////////////////////////////////////
// LCOV_EXCL_START
class ComTdbControl : public ComTdb
{
friend class ExControlTcb;
friend class ExControlPrivateState;

public:
  enum  ControlActionType
  {
    NONE_,
    HOLD_,
    RESTORE_
  };

  ComTdbControl()
    : ComTdb(ComTdb::ex_CONTROL_QUERY, eye_CONTROL_QUERY),
      reset_(0),
      actionType_(NONE_)
  {}
    
  ComTdbControl(ControlQueryType cqt,
	       Int32 reset,
	       char * sqlText, Int16 sqlTextCharSet,
	       char * value1,
	       char * value2,
	       char * value3,
	       ex_cri_desc * given_cri_desc,
	       ex_cri_desc * returned_cri_desc,
	       queue_index down,
	       queue_index up,
	       Lng32 num_buffers,
	       ULng32 buffer_size);

  // ---------------------------------------------------------------------
  // Redefine virtual functions required for Versioning.
  //----------------------------------------------------------------------
  virtual unsigned char getClassVersionID()
  {
    return 1;
  }

  virtual void populateImageVersionIDArray()
  {
    setImageVersionID(1,getClassVersionID());
    ComTdb::populateImageVersionIDArray();
  }

  virtual short getClassSize() { return (short)sizeof(ComTdbControl); }

  Long pack (void *);
  Lng32 unpack (void *, void * reallocator);

  ControlQueryType getType() const	{ return (ControlQueryType)cqt_; }
  char * getSqlText()                   { return sqlText_; }
  Int16 getSqlTextCharSet() const 
        { return sqlText_ ? sqlTextCharSet_ : (Int16)SQLCHARSETCODE_UNKNOWN; }
  char * getValue(Int32 i)
  { return i==1 ? value1_ : 
           i==2 ? value2_ : 
           i==3 ? value3_ : (NABasicPtr)NULL; }

  virtual Int32 numChildren() const 		{ return 0; }
  virtual const char *getNodeName() const 	{ return "EX_CONTROL"; }
  virtual Int32 numExpressions() const 		{ return 0; }
  Int16 getControlActionType() { return actionType_; };
  void setControlActionType(Int16 actionType)  { actionType_ = actionType; }
  void setNonResettable(NABoolean nonResettable) 
                 { nonResettable_ = nonResettable; }
  NABoolean isNonResettable() { return (nonResettable_ != FALSE); } 
 
private:

  // Remember, when putting tablename into one of these 3 char*'s,
  // to save its ANSI name; e.g.
  //	strcpy(xxx_, getTableName().getExposedNameAsAnsiString());

  // ## also need to add  charset  (enum? char*?) here -- i just did on 9/11/20101 - Thank you for the notes :-)
  // ## for SET CAT/SCH -- see ex_control.cpp ...

  NABasicPtr sqlText_;             // 00-07
  NABasicPtr value1_;              // 08-15
  NABasicPtr value2_;              // 16-23
  NABasicPtr value3_;              // 24-31

  Int16 cqt_;                      // 32-33
  Int16 reset_;                    // 34-35
  Int16 sqlTextCharSet_;           // 36-37
  Int16 actionType_;               // 38-39
  Int16 nonResettable_;            // 40-41
  char fillersComTdbControl_[30];  // 42-71

};
// LCOV_EXCL_STOP
#endif