com.dell.cpsd.hal.data.provider.client.IHalDataProviderWorkManager Maven / Gradle / Ivy

Go to download
/**
 * Copyright © 2017 Dell Inc. or its subsidiaries. All Rights Reserved.
 * Dell EMC Confidential/Proprietary Information
 */

package com.dell.cpsd.hal.data.provider.client;

import com.dell.cpsd.hal.data.provider.client.handler.IHalDataProviderWorkHandler;

/**
 * This interface should be implemented by a HAL data provider work manager.
 * 
 * Copyright © 2017 Dell Inc. or its subsidiaries. All Rights Reserved.
 * Dell EMC Confidential/Proprietary Information
 * 
 *
 * @since 1.0
 */
public interface IHalDataProviderWorkManager
{
    /**
     * This registers the IHalDataProviderWorkHandler using the request identifier.
     *
     * @param requestId
     *            The request identifier.
     * @param handler
     *            The handler to register.
     *
     * @return True if the handler was registered, else false.
     *
     * @since 1.0
     */
    public boolean registerHandler(final String requestId, final T handler);

    /**
     * This unregisters the IHalDataProviderWorkHandler with the request identifier.
     *
     * @param requestId
     *            The request identifier.
     *
     * @return The handler that was registered, or null.
     *
     * @since 1.0
     */
    public T unregisterHandler(final String requestId);

    /**
     * This returns the IHalDataProviderWorkHandler with the specified request identifier, or null.
     *
     * @param requestId
     *            The request identifier.
     *
     * @return The IHalDataProviderWorkHandler, or null.
     *
     * @since 1.0
     */
    public T lookupHandler(final String requestId);
}