com.haley.haleyrules
Interface TemplateField

All Superinterfaces:

KnowledgeBaseObject

public interface TemplateField

extends KnowledgeBaseObject

The TemplateField interface publishes the API for the fields of a Template. It is used primarily to assert a template fact using the TemplateAssertion interface. A field is returned by Template.findField(String).

Author:

The Haley Enterprise Copyright © 1998-2004, all rights reserved. Questions, comments or to report a problem contact support@haley.com

Method Summary

java.lang.String	getName() Get the name of this field.
java.lang.String	getReferences() Get the name of the template that this field references.
Template	getTemplate() Get the template that this field belongs to.
byte	getType() Get the type of the field.

Methods inherited from interface com.haley.haleyrules.KnowledgeBaseObject

getKnowledgeBase, release

Method Detail

getName

public java.lang.String getName()
                         throws EclipseException

Get the name of this field.

Returns:

the name of the field

Throws:

EclipseException - if the knowledge base, template, or field has been released

See Also:

Template.findField(String)

getTemplate

public Template getTemplate()
                     throws EclipseException

Get the template that this field belongs to. Each call to this member function must be accompanied with a corresponding call to KnowledgeBaseObject.release()

Returns:

the template

Throws:

EclipseException - if the knowledge base, template, or field has been released

getReferences

public java.lang.String getReferences()
                               throws EclipseException

Get the name of the template that this field references.

Returns:

the name of the template referenced by this field.

Throws:

EclipseException - if the knowledge base, template, or field has been released

getType

public byte getType()
             throws EclipseException

Get the type of the field.

Returns:

the type

Throws:

EclipseException - if the knowledge base, template, or field has been released

See Also:

TemplateFieldTypes