package com.onaro.sanscreen.client.help;

/**
 * This interface provides mapping of help context IDs to topic IDs.  This is for cases where topic IDs in JavaHelp might be generated by tooling
 * and the code might not want to use generated IDs.
 * 
 * @author rnoel
 *
 */
public interface IHelpContextProvider {
    /**
     * Returns the topic ID associated with the context ID or null if the context ID could not be found or was empty.
     * 
     * @param contextId the context ID
     * @return the topic ID associated with the context ID or null if the context ID could not be found or was empty.
     */
    public String getTopicId(String contextId);
    
    /**
     * Returns the closest topic ID associated with the context ID or null if the context ID could not be found or was empty.  This can
     * be used to support a scheme by which the code might have context IDs but the mapping file may not.  You can implement this method
     * to try to find a "closest" ID.
     * 
     * @param contextId the context ID
     * @return the closest topic ID associated with the context ID or null if the context ID could not be found or was empty.
     */
    public String getClosestTopicId(String contextId);
    
}