backend.domainObjects
Class Result

java.lang.Object
  backend.domainObjects.Result

public class Result
extends java.lang.Object

This class assumes that there is one and only one <groups> thingy in the whole <result> thingy. I use the word "thingy" because I don't know what you'd call it---I'm not familiar with XML. Maybe "section" is the word I'm looking for, but I'm not 100% sure. This class contains a single list of groups, which is abstracted from another class, the APGroupList class. In some ways, it works as a wrapper class for APGroupList, but really, this class serves to correspond to the <result> tags in XML and it helps keep things distinct in the parsing implementation.

Author:

ptm2

Constructor Summary

Result()

Method Summary

void	fromXML(org.kxml2.io.KXmlParser theParser) This is the master XML-parsing method.
java.lang.String	getErrorMessage() If the result is an error message, this will return the error message received.
APGroupList	getList() This returns the list of access point groups, and it's the only way to get at the data that a Result-type object parses from XML
boolean	isError() Returns a boolean that tells whether the result picked up an error or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

Result

public Result()

Method Detail

isError

public boolean isError()

Returns a boolean that tells whether the result picked up an error or not.

getErrorMessage

public java.lang.String getErrorMessage()

If the result is an error message, this will return the error message received. If not, this should return null.

getList

public APGroupList getList()

This returns the list of access point groups, and it's the only way to get at the data that a Result-type object parses from XML

fromXML

public void fromXML(org.kxml2.io.KXmlParser theParser)

This is the master XML-parsing method. It accepts a KXmlParser-type object that has already been initialized and is ready to go as far as parsing is concerned---i.e. the input stream has already been given to the KXmlParser, etc. The whole parse system keeps creating objects to fill the fields of the different classes and then hands the parser down to these field-objects' fromXML methods so that the fields can fill in their own fields with objects the parser can parse. It's a rather recursive system. This particular parse method is different from the other ones in that it does not assume that the start tag that corresponds to its class has already been seen and that the parser is past that particular start tag. This method searches for the <result> start tag, and begins parsing from there.