org.docgene.help.model

Class HelpRef

java.lang.Object

org.docgene.help.model.HelpRef

public class HelpRef
extends java.lang.Object

A reference to an article.

Since:

0.87

Constructor Summary

Constructors

Constructor and Description
HelpRef(java.lang.String id, Article article, java.lang.String title) Constructor.

Method Summary

Modifier and Type	Method and Description
Article	getArticle() Return the ref article.
java.lang.String	getID() Return the ref ID.
java.lang.String	getTitle() Return the ref title (can be null).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HelpRef

public HelpRef(java.lang.String id,
               Article article,
               java.lang.String title)

Constructor.

Parameters:

id - the ref id

article - the article

title - the title (can be null)

Method Detail

getID

public java.lang.String getID()

Return the ref ID.

Returns:

the ref ID

getArticle

public Article getArticle()

Return the ref article.

Returns:

the ref article

getTitle

public java.lang.String getTitle()

Return the ref title (can be null).

Returns:

the ref title