/*******************************************************************************
 *  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.commoninterface;

import java.io.Serializable;

import cdac.medinfo.sdk.dcm30_04.utils.ISingleCollection;

/**
 * This interface needs to be implemented by all classes which implements functioning of TransferSyntax class.
 */
public interface ITransferSyntax extends Serializable
{
	/**
	 * Sets the TransferSyntax.
	 * @param iVRTransferSyntax integer value of TransferSyntax.
	 * @param iEndianNess integer value shows endianness.
	 */
	void setTranferSyntax(int iVRTransferSyntax,int iEndianNess);

	/**
	 * Sets the TransferSyntax according to unique ID.
	 * @param strUID String value of unique Identity.
	 * @return int - shows status as success or failure.
	 */
	int setTransferSyntax(String strUID);
	/**
	 * Retrieves the Transfer Syntax UID specified by DICOM Standard
	 * @return String - String value of Transfer Syntax UID
	 */
	String getTransferSyntaxUID();

	/**
	 * Retrieves the VR TransferSyntax.
	 * @return int - integer value of VR TransferSyntax.
	 */
	int getVRTransferSyntax();

	/**
	 * Sets the VR TransferSyntax.
	 * @param iVRTransferSyntax integer value of VR TransferSyntax.
	 */
	void setVRTransferSyntax(int iVRTransferSyntax);

	/**
	 * Retrieves the EndianNess. 
	 * @return int - integer value of EndianNess
	 */
	int getEndianNess();

	/**
	 * Sets the EndianNess.
	 * @param iEndianNess integer value of EndianNess
	 */
	void setEndianNess(int iEndianNess);

	/**
	 * Checks that whether it's a default TransferSyntax.
	 * @return boolean - shows status as success or failure.
	 */
	boolean isDefaultTransferSyntax();

	/**
	 * Converts the Transfer Syntax to DICOM Default Transfer Syntax
	 * @return int - shows status as success or failure.
	 */
	int changeToDefault();

	/**
	 * Checks that Module's TransferSyntax and DataSet's is same or not.
	 * @param objObject instance of Object.
	 * @return boolean - shows status as success or failure.
	 */
	public boolean equals(Object objObject);

	/**
	 * Retrieves the collection of UID of Lossy Compressed TransferSyntax.
	 * @return ISingleCollection<String> - instance of Collection of string.
	 */ 
	public ISingleCollection<String> getLossyCompressedTSUIDs();

	/**
	 * Retrieves the collection of UID of Lossless Compressed TransferSyntax.
	 * @return ISingleCollection<String> - instance of collection of string.
	 */ 
	public ISingleCollection<String> getLosslessCompressedTSUIDs();

	/**
	 * Retrieves the collection of UID of Uncompressed TransferSyntax.
	 * @return ISingleCollection<String> - instance of collection of string.
	 */ 
	public ISingleCollection<String> getUncompressedTSUIDs();
}
