org.snmp4j.agent.mo
Class MOMutableColumn

java.lang.Object
  extended by org.snmp4j.agent.mo.MOColumn
      extended by org.snmp4j.agent.mo.MOMutableColumn
All Implemented Interfaces:
java.lang.Comparable
Direct Known Subclasses:
AutonomousType, DateAndTime, DisplayString, Enumerated, KeyChange, RowPointer, RowStatus, SnmpAdminString, SnmpTagList, SnmpTagValue, StorageType

public class MOMutableColumn
extends MOColumn

The MOMutableColumn class represents mutable columnar SMI objects. It represents all instances of a table's column not only a single instance (cell).

Objects represented by MOMutableColumn can be modified via SNMP, thus MOColumn supports read-only, read-write, and read-create maximum access.

Version:
1.0
Author:
Frank Fock
See Also:
MOColumn

Constructor Summary
MOMutableColumn(int columnID, int syntax)
           
MOMutableColumn(int columnID, int syntax, MOAccess access)
           
MOMutableColumn(int columnID, int syntax, MOAccess access, org.snmp4j.smi.Variable defaultValue)
           
MOMutableColumn(int columnID, int syntax, MOAccess access, org.snmp4j.smi.Variable defaultValue, boolean mutableInService)
           
 
Method Summary
 void addMOValueValidationListener(MOValueValidationListener validator)
           
 void cleanup(SubRequest subRequest, MOTableRow row, int column)
           
 void commit(SubRequest subRequest, MOTableRow row, MOTableRow changeSet, int column)
           
 org.snmp4j.smi.Variable getDefaultValue()
           
 boolean isMandatory()
          Returns true if this column must be specified in a SET request which creates a row.
 boolean isMutableInService()
           
 void prepare(SubRequest subRequest, MOTableRow row, MOTableRow changeSet, int column)
           
 void removeMOValueValidationListener(MOValueValidationListener validator)
           
 void setDefaultValue(org.snmp4j.smi.Variable defaultValue)
           
 void setMandatory(boolean mandatory)
          Sets a flag that determines if this column must be specified in a SET request which creates a row.
 void setMutableInService(boolean mutableInService)
           
 java.lang.String toString()
           
 void undo(SubRequest subRequest, MOTableRow row, int column)
           
 int validate(org.snmp4j.smi.Variable newValue, org.snmp4j.smi.Variable oldValue)
           
protected  boolean validateSetRequest(SubRequest subRequest, MOTableRow row, int column)
           
 
Methods inherited from class org.snmp4j.agent.mo.MOColumn
compareTo, get, getAccess, getColumnID, getSyntax, getTable, getValue, isVolatile, setAccess, setColumnID, setSyntax, setTable
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MOMutableColumn

public MOMutableColumn(int columnID,
                       int syntax)

MOMutableColumn

public MOMutableColumn(int columnID,
                       int syntax,
                       MOAccess access)

MOMutableColumn

public MOMutableColumn(int columnID,
                       int syntax,
                       MOAccess access,
                       org.snmp4j.smi.Variable defaultValue)

MOMutableColumn

public MOMutableColumn(int columnID,
                       int syntax,
                       MOAccess access,
                       org.snmp4j.smi.Variable defaultValue,
                       boolean mutableInService)
Method Detail

addMOValueValidationListener

public void addMOValueValidationListener(MOValueValidationListener validator)

removeMOValueValidationListener

public void removeMOValueValidationListener(MOValueValidationListener validator)

validate

public int validate(org.snmp4j.smi.Variable newValue,
                    org.snmp4j.smi.Variable oldValue)

validateSetRequest

protected boolean validateSetRequest(SubRequest subRequest,
                                     MOTableRow row,
                                     int column)

prepare

public void prepare(SubRequest subRequest,
                    MOTableRow row,
                    MOTableRow changeSet,
                    int column)

commit

public void commit(SubRequest subRequest,
                   MOTableRow row,
                   MOTableRow changeSet,
                   int column)

undo

public void undo(SubRequest subRequest,
                 MOTableRow row,
                 int column)

cleanup

public void cleanup(SubRequest subRequest,
                    MOTableRow row,
                    int column)

setDefaultValue

public void setDefaultValue(org.snmp4j.smi.Variable defaultValue)

setMutableInService

public void setMutableInService(boolean mutableInService)

getDefaultValue

public org.snmp4j.smi.Variable getDefaultValue()

isMutableInService

public boolean isMutableInService()

isMandatory

public boolean isMandatory()
Returns true if this column must be specified in a SET request which creates a row.

Returns:
true if this row has a maximum access of READ-CREATE and has a null default value, false otherwise.

setMandatory

public void setMandatory(boolean mandatory)
Sets a flag that determines if this column must be specified in a SET request which creates a row. The default is true.

Parameters:
mandatory - if true and a row has a maximum access of READ-CREATE and has a null default value, then it must be provided in order to activate the row.
Since:
1.3.2

toString

public java.lang.String toString()
Overrides:
toString in class MOColumn

Copyright 2005-2010 Frank Fock (SNMP4J.org)

Copyright © 2011 SNMP4J.org. All Rights Reserved.