com.ibm.carma.ui.action.custom
Class CustomActionHelpContextIdRegistry

java.lang.Object
  extended by com.ibm.carma.ui.action.custom.CustomActionHelpContextIdRegistry

public class CustomActionHelpContextIdRegistry
extends java.lang.Object

Registry of help context ID's for custom actions. The registry can be populated using the registerContextHelpId(java.lang.String, java.lang.String, java.lang.String) method. The help context ID for a particular action can be retrieved using the getContextHelpId(java.lang.String, java.lang.String) method. The registry is used to populate the context help of the CustomActionInputDialog.

Since:
8.0

Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 java.lang.String getContextHelpId(java.lang.String ramUniqueId, java.lang.String actionId)
          Returns the registered context help ID for the given RAM and action.
static CustomActionHelpContextIdRegistry getRegistry()
          Returns the help context ID registry.
 void registerContextHelpId(java.lang.String ramUniqueId, java.lang.String actionId, java.lang.String contextHelpId)
          Registers the action's context help ID for the given RAM.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
See Also:
Constant Field Values
Method Detail

getRegistry

public static CustomActionHelpContextIdRegistry getRegistry()
Returns the help context ID registry. If the registry has not been created, a new instance is created.

Returns:
the instance of the registry

registerContextHelpId

public void registerContextHelpId(java.lang.String ramUniqueId,
                                  java.lang.String actionId,
                                  java.lang.String contextHelpId)
Registers the action's context help ID for the given RAM.

Parameters:
ramUniqueId - the RAM's unique ID
actionId - the action's three-digit ID
contextHelpId - the context help ID for the action

getContextHelpId

public java.lang.String getContextHelpId(java.lang.String ramUniqueId,
                                         java.lang.String actionId)
Returns the registered context help ID for the given RAM and action.

Parameters:
ramUniqueId - the RAM's unique ID
actionId - the action's three-digit ID
Returns:
the context help ID for the action