GetHelpTopicAction (QDL root module 1.6.0 API)

java.lang.Object
- edu.uiuc.ncsa.sas.thing.Thing
- - edu.uiuc.ncsa.sas.thing.action.Action
  - - org.qdl_lang.sas.action.GetHelpTopicAction

All Implemented Interfaces:

edu.uiuc.ncsa.sas.SASConstants, QDLSASConstants
```
public class GetHelpTopicAction
extends edu.uiuc.ncsa.sas.thing.action.Action
implements QDLSASConstants
```
Gets help for a given topic.
Created by Jeff Gaynor
on 8/29/22 at 7:17 AM

Field Summary
- Fields inherited from class edu.uiuc.ncsa.sas.thing.Thing
  type
- Fields inherited from interface org.qdl_lang.sas.QDLSASConstants
  ACTION_BUFFER_SAVE, ACTION_GET_HELP_TOPIC, ACTION_LIST_FUNCTIONS, KEY_EDIT_ALIAS, KEY_EDIT_ARG_STATE, KEY_EDIT_OBJECT_TYPE, KEY_EDIT_OBJECT_TYPE_BUFFER, KEY_EDIT_OBJECT_TYPE_FILE, KEY_EDIT_OBJECT_TYPE_FUNCTION, KEY_EDIT_OBJECT_TYPE_VARIABLE, KEY_FUNCTION_HELP, KEY_FUNCTION_LIST, KEY_HELP_EXAMPLE, RESPONSE_BUFFER_SAVE, RESPONSE_TYPE_EDIT, RESPONSE_TYPE_GET_HELP_TOPIC, RESPONSE_TYPE_LIST_FUNCTIONS
- Fields inherited from interface edu.uiuc.ncsa.sas.SASConstants
  ACTION_EXECUTE, ACTION_INVOKE, ACTION_LOGOFF, ACTION_LOGON, ACTION_NEW_KEY, CLIENT_ID_HEAD, HEADER_SESSION_ID, KEYS_ACTION, KEYS_ARGUMENT, KEYS_COMMENT, KEYS_EXECUTABLE_NAME, KEYS_INTERNAL_ID, KEYS_METHOD, KEYS_PROMPT, KEYS_SAS, KEYS_STATE, KEYS_SUBJECT, KEYS_SUBJECT_ID, KEYS_SUBJECT_SESSION_ID, KEYS_TYPE, REQUEST_TYPE, RESPONSE_CONTENT, RESPONSE_MESSAGE, RESPONSE_PROMPT, RESPONSE_SESSION_ID, RESPONSE_STATUS, RESPONSE_STATUS_ERROR, RESPONSE_STATUS_OK, RESPONSE_SYMMETRIC_KEY, RESPONSE_TYPE, RESPONSE_TYPE_ERROR, RESPONSE_TYPE_LOGOFF, RESPONSE_TYPE_LOGON, RESPONSE_TYPE_NEW_KEY, RESPONSE_TYPE_OUTPUT, RESPONSE_TYPE_PROMPT

Constructor Summary

Constructors
Constructor Description

GetHelpTopicAction()

GetHelpTopicAction(String name)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`deserialize(net.sf.json.JSONObject json)`
`String`	`getName()`
`net.sf.json.JSONObject`	`serialize()`
`void`	`setName(String name)`

Methods inherited from class edu.uiuc.ncsa.sas.thing.action.Action
getComment, getId, getState, setComment, setId, setState, toString

Methods inherited from class edu.uiuc.ncsa.sas.thing.Thing
equals, getType, setType

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GetHelpTopicAction
```
public GetHelpTopicAction()
```

GetHelpTopicAction

public GetHelpTopicAction(String name)

Method Detail
- getName
```
public String getName()
```
- setName
```
public void setName(String name)
```
- serialize
```
public net.sf.json.JSONObject serialize()
```
  Overrides:
  
  serialize in class edu.uiuc.ncsa.sas.thing.action.Action
- deserialize
```
public void deserialize(net.sf.json.JSONObject json)
```
  Overrides:
  
  deserialize in class edu.uiuc.ncsa.sas.thing.action.Action