story.scheherazade.virgil.help
Class FAQ

java.lang.Object
  extended by story.scheherazade.virgil.help.FAQ

public class FAQ
extends java.lang.Object

The purpose of this class is to represent the Scheherazade FAQ data structure. This structure consists of an ID (name), a question, and an answer.

Author:
Marshall

Field Summary
static java.lang.String ANSWER
           
static java.lang.String F_ID
           
static java.lang.String QUESTION
           
 
Constructor Summary
FAQ(org.w3c.dom.Node node)
          Constructor for creation of an FAQ object from a node
FAQ(java.lang.String ID, java.lang.String question, java.lang.String answer)
          Constructor for explicit creation of an FAQ object
 
Method Summary
 java.lang.String getAnswer()
          Returns the ANSWER of the FAQ
 java.lang.String getID()
          Returns the ID of the FAQ
 java.lang.String getQuestion()
          Returns the QUESTION of the FAQ
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

F_ID

public static final java.lang.String F_ID
See Also:
Constant Field Values

QUESTION

public static final java.lang.String QUESTION
See Also:
Constant Field Values

ANSWER

public static final java.lang.String ANSWER
See Also:
Constant Field Values
Constructor Detail

FAQ

public FAQ(java.lang.String ID,
           java.lang.String question,
           java.lang.String answer)
Constructor for explicit creation of an FAQ object

Parameters:
ID - the ID of the FAQ
question - the question of the FAQ
answer - the answer to the question

FAQ

public FAQ(org.w3c.dom.Node node)
    throws java.lang.Exception
Constructor for creation of an FAQ object from a node

Parameters:
node - an FAQ represented as a Node data structure that has children in the form of a Question and an Answer
Throws:
java.lang.Exception
Method Detail

getID

public java.lang.String getID()
Returns the ID of the FAQ

Returns:
the ID of the FAQ

getQuestion

public java.lang.String getQuestion()
Returns the QUESTION of the FAQ

Returns:
the QUESTION of the FAQ

getAnswer

public java.lang.String getAnswer()
Returns the ANSWER of the FAQ

Returns:
the ANSWER of the FAQ


Copyright © 2011 David K. Elson. All Rights Reserved.