/*******************************************************************************
 *  Copyright 2017-2018 Centre for Development of Advanced Computing(C-DAC), Pune
 *  
 * Licensed 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.
 *******************************************************************************/
package cdac.medinfo.sdk.dcm30_04.services.dimsecommons;

import java.io.IOException;

import cdac.medinfo.sdk.dcm30_04.services.dicomnetcommons.SinkException;

/**
 * This Interface needs to be implemented by classes which provides storage processing of Data.
 */
public interface IDataSink 
{
	
	/**
	 * Stores,Creates or Sets the instance in DataBase if available from given Query Model.
	 * @param objQueryModel Instance of Query Model to be stored or created.
	 * @param strValue string value of Data Base storage path in store request, or Affected SOP Instance UID
	 * 				   in case of NCreate, or Requested SOP Instance UID in case of NSet request.  
	 * @return short - shows status value which will be used in generation of response
	 * 				   Refer EnumImplOpsStatus for supported response status values.
	 */
	short store(IQueryModel objQueryModel, String strValue) throws SinkException;

	/**
	 * Populates the DataBase if available and Serializes the DataSet.
	 * @param objDicomMessage instance of DicomMessage
	 * @param strStoragePath string value of Data Base storage path
	 * @return short - shows status value which will be used in generation of response
	 * 				Refer EnumImplOpsStatus for supported response status values.
	 * @throws IOException signals if IO exception occurs.
	 */
	short store(DicomMessage objDicomMessage, String strStoragePath)throws SinkException;
}
