from __future__ import annotations
from typing import Any, TYPE_CHECKING
from com.sun.star.sdbc import XResultSetUpdate
from ooodev.exceptions import ex as mEx
from ooodev.loader import lo as mLo
if TYPE_CHECKING:
from ooodev.utils.type_var import UnoInterface
[docs]class ResultSetUpdatePartial:
"""
Partial class for XResultSetUpdate.
"""
[docs] def __init__(self, component: XResultSetUpdate, interface: UnoInterface | None = XResultSetUpdate) -> None:
"""
Constructor
Args:
component (XResultSetUpdate): UNO Component that implements ``com.sun.star.container.XResultSetUpdate`` interface.
interface (UnoInterface, optional): The interface to be validated. Defaults to ``XResultSetUpdate``.
"""
def validate(comp: Any, obj_type: Any) -> None:
if obj_type is None:
return
if not mLo.Lo.is_uno_interfaces(comp, obj_type):
raise mEx.MissingInterfaceError(obj_type)
validate(component, interface)
self.__component = component
# region XResultSetUpdate
[docs] def cancel_row_updates(self) -> None:
"""
Cancels the updates made to a row.
This method may be called after calling an updateXXX method(s) and before calling
``XResultSetUpdate.updateRow()`` to rollback the updates made to a row.
If no updates have been made or updateRow has already been called, then this method has no effect.
"""
self.__component.cancelRowUpdates()
[docs] def delete_row(self) -> None:
"""
Deletes the current row from the result set and the underlying database.
"""
self.__component.deleteRow()
[docs] def insert_row(self) -> None:
"""
Inserts a new row into the result set and the underlying database.
Must be on the insert row when this method is called.
"""
self.__component.insertRow()
[docs] def move_to_current_row(self) -> None:
"""
Moves the cursor to the remembered cursor position, usually the current row.
This method has no effect if the cursor is not on the insert row.
"""
self.__component.moveToCurrentRow()
[docs] def move_to_insert_row(self) -> None:
"""
Moves the cursor to the insert row.
The current row is remembered while the cursor is positioned on the insert row.
"""
self.__component.moveToInsertRow()
[docs] def update_row(self) -> None:
"""
Updates the underlying database with the new contents of the current row.
This method cannot be called when the cursor is on the insert row.
"""
self.__component.updateRow()
# endregion XResultSetUpdate