com.mentata.sg8
Class SG8Discovery

java.lang.Object
  com.mentata.sg8.SG8Discovery

Direct Known Subclasses:

SG8Change, SG8Search

public class SG8Discovery

extends Object

A bean defining a single match for a directory search. This bean serves as a basic wrapper for an SG8 object, with properties for the object and the name of a particular attribute along with pseudo properties that enable JSP content to access the object's attributes and attribute lists.

Since:

0.7

Author:

Jon Roberts

Constructor Summary

SG8Discovery()

Method Summary

String	getAttribute() Returns the name of the highlighted attribute for the discovered entry.
String[]	getAttributelist() Returns the current attribute list from the discovered object.
String	getKeywords() Returns a keyword list for the discovered object.
SG8Object	getObject() Returns the discovered object.
SG8Attribute	getSg8attribute() Returns the current attribute from the discovered object.
void	setAttribute(String attribute) Sets the attribute to highlight in the discovered entry.
void	setCurrentattribute(String attribute) Sets the current attribute for the discovery.
void	setCurrentlist(String attributelist) Sets the current attribute list for the discovery.
void	setObject(SG8Object object) Sets the discovered object.

Methods inherited from class java.lang.Object

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

Constructor Detail

SG8Discovery

public SG8Discovery()

Method Detail

setAttribute

public void setAttribute(String attribute)

Sets the attribute to highlight in the discovered entry.

Parameters:

attribute - an attribute name

getAttribute

public String getAttribute()

Returns the name of the highlighted attribute for the discovered entry.

Returns:

the name of the highlighted attribute

setObject

public void setObject(SG8Object object)

Sets the discovered object.

Parameters:

object - a populated SG8 object

getObject

public SG8Object getObject()

Returns the discovered object.

Returns:

the populated SG8 object

setCurrentlist

public void setCurrentlist(String attributelist)

Sets the current attribute list for the discovery.

Parameters:

attributelist - an attribute list name

getAttributelist

public String[] getAttributelist()
                          throws L3DException

Returns the current attribute list from the discovered object.

Returns:

the configured list of attribute names

Throws:

L3DException - if the attribute list is undefined in the discovered object

setCurrentattribute

public void setCurrentattribute(String attribute)

Sets the current attribute for the discovery.

Parameters:

attribute - an attribute name

getSg8attribute

public SG8Attribute getSg8attribute()
                             throws SG8Exception

Returns the current attribute from the discovered object.

Returns:

the configured SG8 attribute

Throws:

SG8Exception - if the attribute is undefined in the discovered object

getKeywords

public String getKeywords()
                   throws L3DException

Returns a keyword list for the discovered object.

Returns:

a comma delimited list of keywords

Throws:

L3DException - if the attribute is undefined in the discovered object