org.opennms.netmgt.config.categories
Class Common

java.lang.Object
  org.opennms.netmgt.config.categories.Common

All Implemented Interfaces:

Serializable

public class Common
extends Object
implements Serializable

Common attributes that apply to all categories in a group.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Common()

Method Summary

String	getRule() Returns the value of field 'rule'.
boolean	isValid() Method isValid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	setRule(String rule) Sets the value of field 'rule'.
static Common	unmarshal(Reader reader) Method unmarshal.
void	validate()

Methods inherited from class java.lang.Object

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

Constructor Detail

Common

public Common()

Method Detail

getRule

public String getRule()

Returns the value of field 'rule'. The field 'rule' has the following description: A common rule that will be applied to all categories in this group in addition to the category's rule.

Returns:

the value of field 'Rule'.

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

marshal

public void marshal(Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Parameters:

out -

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

marshal

public void marshal(ContentHandler handler)
             throws IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Parameters:

handler -

Throws:

IOException - if an IOException occurs during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

setRule

public void setRule(String rule)

Sets the value of field 'rule'. The field 'rule' has the following description: A common rule that will be applied to all categories in this group in addition to the category's rule.

Parameters:

rule - the value of field 'rule'.

unmarshal

public static Common unmarshal(Reader reader)
                        throws org.exolab.castor.xml.MarshalException,
                               org.exolab.castor.xml.ValidationException

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled org.opennms.netmgt.config.categories.Common

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException

Throws:

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema