interface XIntrospectionAccess in module com::sun::star::beans::

(Global Index)

Syntax

interface XIntrospectionAccess : com::sun::star::uno::XInterface ;

Description

gives access to the result of an interface / object introspection done by the inspect-method of XIntrospection.

It supports some of the methods that are also defined in XPropertySet , but not the methods for listener registration, since this would not be appropriate for an introspection result.

The results of the get..() and has..() methods depends on the concepts given in the parameter nConcepts . The minimum supported concepts should be for the MethodConcept :

and for the PropertyConcept : Both groups get combined by an arithmetical or-operation.

The XExactName interface has to be supported in order to implement inaccurate name access for all objects which implement the XNameAccess interface or XPropertySet .

See also

XPropertySet

See also

XExactName

Method Summary

getSuppliedMethodConcepts

getSuppliedPropertyConcepts

getProperty

hasProperty

getProperties

getMethod

hasMethod

getMethods

getSupportedListeners

queryAdapter creates an adapter that implements an interface with the specified type.

Method Details



getSuppliedMethodConcepts

Syntax

long getSuppliedMethodConcepts ();

Description

Returns

zero or more constants of the MethodConcept constants group.

getSuppliedPropertyConcepts

Syntax

long getSuppliedPropertyConcepts ();

Description

Returns

zero or more constants of the PropertyConcept constants group.

getProperty

Syntax

com::sun::star::beans::Property getProperty (
string aName,
long nPropertyConcepts )
raises ( com::sun::star::container::NoSuchElementException );

Description

Returns

true> if the method exists and fits the given MethodConcepts; otherwise false is returned.

Parameter aName

the name of the Property .

Parameter nPropertyConcepts

zero or more constants of the PropertyConcept constants group.

Throws

NoSuchElementException when an element under Name does not exist.

hasProperty

Syntax

boolean hasProperty (
string aName,
long nPropertyConcepts );

Description

Returns

true> if the method exists and fits the given PropertyConcept s; otherwise false is returned.

Parameter aName

the name of the Property .

Parameter nPropertyConcepts

zero or more constants of the PropertyConcept constants group.

getProperties

Syntax

sequence< com::sun::star::beans::Property > getProperties (
long nPropertyConcepts );

Description

Returns

all properties of the introspected object which accord to the given PropertyConcept s.

getMethod

Syntax

com::sun::star::reflection::XIdlMethod getMethod (
string aName,
long nMethodConcepts )
raises ( com::sun::star::lang::NoSuchMethodException );

Description

Returns

the method with the given name if it exists and fits the specified MethodConcept s.

Parameter aName

the name of the method.

Parameter nMethodConcepts

zero or more constants of the MethodConcept group.

Throws

NoSuchElementException if no element with the name Name exists.

hasMethod

Syntax

boolean hasMethod (
string aName,
long nMethodConcepts );

Description

Returns

true> if the method exists and fits the given MethodConcepts s; otherwise false is returned.

Parameter aName

the name of the method.

Parameter nMethodConcepts

zero or more constants of the MethodConcept constants group.

getMethods

Syntax

sequence< com::sun::star::reflection::XIdlMethod > getMethods (
long nMethodConcepts );

Description

Returns

all methods of the introspected object which accord to the given MethodConcept s.

getSupportedListeners

Syntax

sequence< type > getSupportedListeners ();

Description

Returns

a sequence of the types of listener interfaces which are supported by the introspected object.

queryAdapter

Syntax

com::sun::star::uno::XInterface queryAdapter (
type aInterfaceType )
raises ( com::sun::star::beans::IllegalTypeException );

Description

creates an adapter that implements an interface with the specified type.

The supplied concepts (see the methods XIntrospectionAccess::setConcepts() ) and the XIntrospectionAccess::setConcepts() member determine the interfaces returned by this method.

To access properties, query for the XPropertySet interface. If the XPropertySet can be queried, the XFastPropertySet interface must be supported too.

If the introspected object implements a name container, the introspection should return the XNameAccess and XNameContainer interfaces.

If the introspected object implements an index container, the introspection should return the XIndexAccess and XIndexContainer interfaces.

If the introspected object implements an enumeration container, the introspection should return the XEnumerationAccess interface.

If the introspected object implements the XIdlArray interface, the introspection should return this.

To implement inaccurate name access, at all objects, which implement the XNameAccess or XPropertySet interface, the XExactName interface has to be supported.

See also

XExactName
Top of Page