LibreOffice
LibreOffice 6.2 SDK API Reference
Exported Interfaces | Public Attributes | List of all members
View Service Referencepublished

is used to specify views on data. More...

import"View.idl";

Inheritance diagram for View:
XRename XPropertySet XAlterView XInterface XInterface

Exported Interfaces

interface XRename
 is optional for implementation. More...
 
interface com::sun::star::beans::XPropertySet
 
interface XAlterView
 allows changing the view's Command. More...
 

Public Attributes

string Name
 is the name of the view. More...
 
string CatalogName
 is the name of the views catalog, may be empty. More...
 
string SchemaName
 is the name of the view's schema, may be empty. More...
 
string Command
 is the command for creating the view. More...
 
long CheckOption
 indicates if a check option should be used for the view. More...
 

Additional Inherited Members

- Public Member Functions inherited from XPropertySet
com::sun::star::beans::XPropertySetInfo getPropertySetInfo ()
 
void setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
 sets the value of the property with the specified name. More...
 
any getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 
void addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XPropertyChangeListener to the specified property. More...
 
void removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XPropertyChangeListener from the listener list. More...
 
void addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XVetoableChangeListener to the specified property with the name PropertyName. More...
 
void removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XVetoableChangeListener from the listener list. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 
- Protected Member Functions inherited from XRename
void rename ([in]string newName) raises (com::sun::star::sdbc::SQLException, com::sun::star::container::ElementExistException)
 is intended to alter the name of a object. More...
 
- Protected Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 
- Protected Member Functions inherited from XPropertySet
com::sun::star::beans::XPropertySetInfo getPropertySetInfo ()
 
void setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
 sets the value of the property with the specified name. More...
 
any getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 
void addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XPropertyChangeListener to the specified property. More...
 
void removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XPropertyChangeListener from the listener list. More...
 
void addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XVetoableChangeListener to the specified property with the name PropertyName. More...
 
void removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XVetoableChangeListener from the listener list. More...
 
- Protected Member Functions inherited from XAlterView
void alterCommand ([in] string NewCommand) raises ( ::com::sun::star::sdbc::SQLException )
 changes the command which constitutes the view More...
 

Detailed Description

is used to specify views on data.

A view object is only used for creation and deletion. Inspecting the command of a view is normally not supported.

If a view is going to be added to a database, the view must have a unique name within the view and the table container, as it can be used like a table. Note: After addition, both the containers for views and the container for tables must contain an element for the view.

Exported Interfaces

interface XAlterView
optional

allows changing the view's Command.

interface XRename
optional

is optional for implementation.

Member Data Documentation

string CatalogName
propertyreadonly

is the name of the views catalog, may be empty.

long CheckOption
propertyreadonly

indicates if a check option should be used for the view.

See also
com::sun::star::sdbcx::CheckOption
string Command
propertyreadonly

is the command for creating the view.

This is typically a SQL Select-Statement.

This property might be empty when a backend does not support retrieving the current SQL command of a view. However, if the View supports altering its command via the XAlterView interface, then it's required to also provide the current SQL command in the Command property.

string Name
propertyreadonly

is the name of the view.

string SchemaName
propertyreadonly

is the name of the view's schema, may be empty.


The documentation for this service was generated from the following file: