public class PanelGroupHelpIdentifier extends Object
PanelGroup.getHelpIdentifiers()
to create an instance of this class.PanelGroup
,
Command
,
CommandHelpRetriever
Modifier and Type | Field | Description |
---|---|---|
static int |
STATUS_FOUND |
Constant indicating that the keyword specified for this help identifier and
panel group was found and information about the help identifier was retrieved.
|
static int |
STATUS_NAME_NOT_CORRECT |
Constant indicating that the keyword specified for this help identifier and
panel group was not correct.
|
static int |
STATUS_OBJECT_ACCESS_FAILURE |
Constant indicating that the system encountered a problem while accessing
the panel group or specified keyword information.
|
static int |
STATUS_UNKNOWN |
Constant indicating that the system returned a status code that is not known.
|
Modifier and Type | Method | Description |
---|---|---|
String |
getAnchor() |
Returns the name of the anchor within the help document
for this help identifier.
|
String |
getName() |
Returns the name of the help identifier.
|
String |
getPath() |
Returns the path of the panel group from whence this help identifier came.
|
int |
getStatus() |
Returns the state of the information for this help identifier.
|
String |
toString() |
Returns a String representation of this help identifier.
|
public static final int STATUS_NAME_NOT_CORRECT
public static final int STATUS_FOUND
public static final int STATUS_OBJECT_ACCESS_FAILURE
public static final int STATUS_UNKNOWN
public String getName()
public String getPath()
public int getStatus()
STATUS_NAME_NOT_CORRECT
- The system
could not find the help identifier.
STATUS_FOUND
- The system found the help identifier
and retrieved its information.
STATUS_OBJECT_ACCESS_FAILURE
- The system could not retrieve
the help identifier information for some reason. See the remote command host
server job log for details.
STATUS_UNKNOWN
- The system returned a help
identifier status that is not known.
public String getAnchor()
Copyright © 2024. All rights reserved.