Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

com :: sun :: star :: util ::

interface XChangesBatch

Base Interface
com::sun::star::uno::XInterface

Description
this interface enables applying a set of changes in one batch transaction.

An object implementing this interface allows other interfaces to change its state locally. It will keep a list of pending changes until such changes are committed or cancelled.

Only when they are explicitly committed will these changes take effect persistently or globally.

See also
XChangesNotifier
See also
XChangesSet
See also
XCancellable


Known Services which Export this Interface

com::sun::star::ucb::HierarchyDataReadWriteAccess provides read and write access to a fragment of the hierarchy data.
com::sun::star::configuration::UpdateRootElement provides update control for a (by name) hierarchy and information about the hierarchy as a whole as well as its root.
com::sun::star::packages::Package The Package is a service that provides access to a set of files and folders contained within a Package. One instance of the Package service exists for each Package file to be manipulated. Each instance is created with an argument which specifies the URL of the Package file to which the user requires access. If the instance is created without arguments, it must be initialised with the XInitialization service methods before it is a valid instance of the service.

Methods' Summary

commitChanges Commits any pending changes.
hasPendingChanges checks whether this object has any pending changes that can be committed.
getPendingChanges queries for any pending changes that can be committed.

Methods' Details

commitChanges
 
void
commitChanges( )
raises ( com::sun::star::lang::WrappedTargetException );

Description
Commits any pending changes.

The meaning of 'commit', especially any transactional guarantees, depend on the service.

hasPendingChanges
 
boolean
hasPendingChanges();
Description
checks whether this object has any pending changes that can be committed.
getPendingChanges
 
com::sun::star::util::ChangesSet
getPendingChanges();
Description
queries for any pending changes that can be committed.

Top of Page