• Home
• com.thomsonreuters.ema
• ema
• 3.2.2.0
• source code
• OmmProviderErrorClient.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.thomsonreuters.ema.access.OmmProviderErrorClient Maven / Gradle / Ivy

/*|-----------------------------------------------------------------------------
 *|            This source code is provided under the Apache 2.0 license      --
 *|  and is provided AS IS with no warranty or guarantee of fit for purpose.  --
 *|                See the project's LICENSE.md for details.                  --
 *|           Copyright Thomson Reuters 2016. All rights reserved.            --
 *|-----------------------------------------------------------------------------
 */

package com.thomsonreuters.ema.access;

/**
 * OmmProviderErrorclient class provides callback mechanism used in place of exceptions.
 * 
 * 
By default OmmProvider class throws exceptions if a usage error occurs.
 * 
Specifying OmmProviderErrorClient on the constructor of OmmProvider overwrites this behavior.
 * 
Instead of throwing exceptions, respective callback method on OmmProviderErrorClient will be invoked.
 * 
 * @see OmmProvider
 * @see OmmException
 * @see OmmInvalidUsageException
 * @see OmmInvalidHandleException
 */

public interface OmmProviderErrorClient
{
	/**
	 * Invoked upon receiving an invalid handle.
	 * 
Requires OmmProvider constructor to have an OmmProviderErrorClient.
	 * 
	 * @param handle value of the handle that is invalid
	 * @param text specifies associated error text
	 */
	public void onInvalidHandle(long handle, String text);

	/**
	 * Invoked in the case of invalid usage.
	 * 
Requires OmmProvider constructor to have an OmmProviderErrorClient.
	 * 
	 * @param text specifies associated error text
	 */ 
	public void onInvalidUsage(String text);

}