/*
 * JBoss, Home of Professional Open Source.
 * See the COPYRIGHT.txt file distributed with this work for information
 * regarding copyright ownership.  Some portions may be licensed
 * to Red Hat, Inc. under one or more contributor license agreements.
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301 USA.
 * Modified by
 * @author  Data Virtuality GmbH
 * @date    $Date$
 *
 */
// https://issues.jboss.org/browse/TEIID-3912
// https://issues.jboss.org/browse/TEIID-3426
// https://issues.jboss.org/browse/TEIID-4284
// https://issues.jboss.org/browse/TEIID-4481
// https://issues.redhat.com/browse/TEIID-4439
package org.teiid.translator.salesforce;
 
import java.io.IOException;
import java.util.Calendar;
import java.util.LinkedHashMap;
import java.util.List;
 
import javax.resource.ResourceException;
import javax.resource.cci.Connection;
 
import org.teiid.translator.salesforce.execution.DataPayload;
import org.teiid.translator.salesforce.execution.DeletedResult;
import org.teiid.translator.salesforce.execution.UpdatedResult;
 
import com.sforce.async.BatchInfo;
import com.sforce.async.BatchResult;
import com.sforce.async.JobInfo;
import com.sforce.async.OperationEnum;
import com.sforce.async.SObject;
import com.sforce.soap.partner.DescribeGlobalResult;
import com.sforce.soap.partner.DescribeSObjectResult;
import com.sforce.soap.partner.QueryResult;
 
public interface SalesforceConnection extends Connection {
        
        public static class BatchResultInfo {
            private String batchId;
            private int waitCount;

            //batch state
            private String[] resultList;
            private int resultNum;

            //pk chunk state
            private LinkedHashMap<String, BatchInfo> pkBatches;

            public BatchResultInfo(String batchInfo) {
                    this.batchId = batchInfo;
            }

            public String[] getResultList() {
       return resultList;
   }

            public void setResultList(String[] resultList) {
                this.resultList = resultList;
                this.resultNum = 0;
            }

            public int getAndIncrementResultNum() {
       return resultNum++;
   }

            public void setResultNum(int resultNum) {
       this.resultNum = resultNum;
   }

            public String getBatchId() {
                    return batchId;
            }

            public void setPkBatches(LinkedHashMap<String, BatchInfo> pkBatches) {
                this.pkBatches = pkBatches;
            }

            public LinkedHashMap<String, BatchInfo> getPkBatches() {
       return pkBatches;
   }

            public int incrementAndGetWaitCount() {
                return ++waitCount;
            }

            public void resetWaitCount() {
                waitCount = 0;
            }
        }
        
        public interface BulkBatchResult {
            
            public List<String> nextRecord() throws IOException;
            
            public void close();
            
        }
 
        public QueryResult query(String queryString, int maxBatchSize, boolean queryAll) throws ResourceException;
 
        public QueryResult queryMore(String queryLocator, int batchSize) throws ResourceException;
        
        public boolean isValid();
        
        public int delete(String[] ids) throws ResourceException ;
 
        public int create(DataPayload data) throws ResourceException;

        public int upsert(DataPayload data) throws ResourceException;
 
        public int update(List<DataPayload> updateDataList) throws ResourceException;
 
        public UpdatedResult getUpdated(String objectName, Calendar startCalendar, Calendar endCalendar) throws ResourceException;
 
        public DeletedResult getDeleted(String objectName, Calendar startCalendar, Calendar endCalendar) throws ResourceException;
        
        public com.sforce.soap.partner.sobject.SObject[] retrieve(String fieldList, String sObjectType, List<String> ids) throws ResourceException;
        
        public DescribeGlobalResult getObjects() throws ResourceException;
        
        public DescribeSObjectResult[] getObjectMetaData(String... objectName) throws ResourceException;
        
        public BatchResult[] getBulkResults(JobInfo job, List<String> ids) throws ResourceException;
 
        public void cancelBulkJob(JobInfo job) throws ResourceException;
 
        JobInfo closeJob(String jobId) throws ResourceException;
 
        String addBatch(List<SObject> payload, JobInfo job)
                        throws ResourceException;
 
        JobInfo createBulkJob(String objectName, OperationEnum operation, boolean usePkChunking) throws ResourceException;
 
        Long getCardinality(String sobject) throws ResourceException;
        
        String getVersion();
 
        BatchResultInfo addBatch(String query, JobInfo job) throws ResourceException;
 
        BulkBatchResult getBatchQueryResults(String id, BatchResultInfo info) throws ResourceException;
        
        public void setMaxChunkSize(int maxChunkSize);

        void setPollingInterval(long pollingInterval);
}