org.outerj.xreporter.user
Interface User

All Known Implementing Classes:
UserImpl

public interface User

An xReporter end-user. Usually belonging to the human species.


Method Summary
 void generateSaxFragment(org.xml.sax.ContentHandler contentHandler)
          Generate an XML (SAX) representation of this user.
 java.lang.String getCustomer()
          Returns a string representing the customer to which this user belongs.
 java.lang.String getName()
          Returns the username of this user.
 java.lang.String getProperty(java.lang.String name)
          Gets a user-defined property of this user.
 java.util.List getRoles()
          Returns a List containing this user's roles.
 

Method Detail

getName

public java.lang.String getName()
Returns the username of this user. This is not his real name.


getRoles

public java.util.List getRoles()
Returns a List containing this user's roles. The items in the List are Strings.


getCustomer

public java.lang.String getCustomer()
Returns a string representing the customer to which this user belongs. This could be an empty string, but wil never be null.


getProperty

public java.lang.String getProperty(java.lang.String name)
Gets a user-defined property of this user.


generateSaxFragment

public void generateSaxFragment(org.xml.sax.ContentHandler contentHandler)
                         throws org.xml.sax.SAXException
Generate an XML (SAX) representation of this user. This method will not call startDocument and endDocument on the contentHandler, neither will it add a declaration (and prefix events) for the xReporter namespace.

Throws:
org.xml.sax.SAXException