package com.onaro.sanscreen.client.help;

/**
 * Interface that components can include that will allow them to dynamically specify the help context (might need to be different
 * based on circumstances).
 * 
 * @author rnoel
 *
 */
public interface IHelpContextIdProvider {

    /**
     * Returns the context ID string for a component.  This is invoked at the time help is triggered, allowing components
     * to return a different context ID than the one that might have been assigned when the object was initialized.
     * 
     * @return the context ID string for the component.
     */
    public String getHelpContextId();
}