org.snmp4j.agent.mo.MOMutableTableModel Maven / Gradle / Ivy
/*_############################################################################
_##
_## SNMP4J-Agent - MOMutableTableModel.java
_##
_## Copyright (C) 2005-2009 Frank Fock (SNMP4J.org)
_##
_## Licensed under the Apache License, Version 2.0 (the "License");
_## you may not use this file except in compliance with the License.
_## You may obtain a copy of the License at
_##
_## http://www.apache.org/licenses/LICENSE-2.0
_##
_## Unless required by applicable law or agreed to in writing, software
_## distributed under the License is distributed on an "AS IS" BASIS,
_## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
_## See the License for the specific language governing permissions and
_## limitations under the License.
_##
_##########################################################################*/
package org.snmp4j.agent.mo;
import org.snmp4j.smi.OID;
/**
* The MOMutableTableModel defines the interface for mutable
* table models. Mutable table models support row creation and deletion through
* SNMP SET operations.
*
* @author Frank Fock
* @version 1.0
*/
public interface MOMutableTableModel extends MOTableModel, MOTableRowFactory {
/**
* Adds a row to the table. If a row with the same index already exists
* it will be replaced and returned.
*
* @param row
* the MOTableRow instance to add.
* @return
* the previous row with the specified index or null if it
* did not have one.
*/
MOTableRow addRow(MOTableRow row);
/**
* Removes the row with the specified index from the table and returns it.
* @param index
* the row index of the row to remove.
* @return
* the removed row or null if the table did not contain such
* a row.
*/
MOTableRow removeRow(OID index);
/**
* Removes all rows.
*/
void clear();
/**
* Remove all rows that do not match the given filter criteria
* from the model.
* @param filter
* the MOTableRowFilter that filters out the rows to
* delete.
*/
void clear(MOTableRowFilter filter);
/**
* Sets the factory instance to be used for creating rows for this model.
*
* @param rowFactory
* a MOTableRowFactory instance or null to
* disable row creation.
*/
void setRowFactory(MOTableRowFactory rowFactory);
}