<html> <head> <title>Interface XIntrospectionAccess</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XIntrospectionAccess-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">beans</a> :: </p> </td> </tr> <tr> <td class="title">interface XIntrospectionAccess</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>represents the result of an introspection operation done by the inspect method of <a href="XIntrospection.html">XIntrospection</a>. </dd> <dd><p>This interface gives information about an object's properties and methods as detected in the introspection process. It's not possible to access properties or call methods directly using this interface but it provides access to other interfaces to do so. See <a href="XIntrospectionAccess.html">XIntrospectionAccess</a>::<a href="XIntrospectionAccess.html#queryAdapter">queryAdapter()</a></p> <p>The <a href="XExactName.html">XExactName</a> interface has to be supported in order to implement inaccurate name access for all objects which implement the ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XNameAccess.html">XNameAccess</a> interface or <a href="XPropertySet.html">XPropertySet</a>.</p> <p>The <a href="XMaterialHolder.html">XMaterialHolder</a> interface has to be supported to give access to the inspected object.</p> </dd> <dt><b>See also</b></dt> <dd><a href="XPropertySet.html">XPropertySet</a>, <a href="XExactName.html">XExactName</a></dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#getSuppliedMethodConcepts">getSuppliedMethodConcepts</a></td> <td class="imsum_right">returns information about which method concepts described in the <a href="MethodConcept.html">MethodConcept</a> constants group are supported by this <a href="XIntrospectionAccess.html">XIntrospectionAccess</a> implementation. </td> </tr> <tr> <td class="imsum_left"><a href="#getSuppliedPropertyConcepts">getSuppliedPropertyConcepts</a></td> <td class="imsum_right">returns information about which property concepts described in the <a href="PropertyConcept.html">PropertyConcept</a> constants group are supported by this <a href="XIntrospectionAccess.html">XIntrospectionAccess</a> implementation. </td> </tr> <tr> <td class="imsum_left"><a href="#getProperty">getProperty</a></td> <td class="imsum_right">returns information about a property if a property with the demanded name exists and if it accords to one of the demanded <a href="PropertyConcept.html">PropertyConcept</a>s. The information is provided as <a href="Property.html">Property</a> struct. </td> </tr> <tr> <td class="imsum_left"><a href="#hasProperty">hasProperty</a></td> <td class="imsum_right">allows to ask if a property with the demanded name exists and if it accords to one of the demanded <a href="PropertyConcept.html">PropertyConcept</a>s. </td> </tr> <tr> <td class="imsum_left"><a href="#getProperties">getProperties</a></td> <td class="imsum_right">returns a sequence of properties of the introspected object </td> </tr> <tr> <td class="imsum_left"><a href="#getMethod">getMethod</a></td> <td class="imsum_right">returns information about a method if a method with the demanded name exists and if it accords to one of the demanded MethodConcepts. The information is provided as ::com::sun::star::<a href="../reflection/module-ix.html">reflection</a>::<a href="../reflection/XIdlMethod.html">XIdlMethod</a>. </td> </tr> <tr> <td class="imsum_left"><a href="#hasMethod">hasMethod</a></td> <td class="imsum_right">allows to ask if a method with the demanded name exists and if it accords to one of the demanded <a href="MethodConcept.html">MethodConcept</a>s. </td> </tr> <tr> <td class="imsum_left"><a href="#getMethods">getMethods</a></td> <td class="imsum_right">returns a sequence of methods of the introspected object. </td> </tr> <tr> <td class="imsum_left"><a href="#getSupportedListeners">getSupportedListeners</a></td> <td class="imsum_right">returns the listener types supported by the introspected object. </td> </tr> <tr> <td class="imsum_left"><a href="#queryAdapter">queryAdapter</a></td> <td class="imsum_right">creates an adapter that implements an interface with the specified type. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="getSuppliedMethodConcepts" class="membertitle">getSuppliedMethodConcepts</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">long</td> </tr> <tr> <td valign="top"><b>getSuppliedMethodConcepts</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns information about which method concepts described in the <a href="MethodConcept.html">MethodConcept</a> constants group are supported by this <a href="XIntrospectionAccess.html">XIntrospectionAccess</a> implementation. </dd> <dd><p>The minimum supported concepts should be:</p> <ul> <li> <b>MethodConcept::PROPERTY</b>, </li> <li> <b>MethodConcept::LISTENER</b>, </li> <li> <b>MethodConcept::ENUMERATION</b>, </li> <li> <b>MethodConcept::NAMECONTAINER</b></li> <li> <b>MethodConcept::INDEXCONTAINER</b>; </li> </ul> </dd> <dt><b>Returns</b></dt> <dd>zero or more constants of the <a href="MethodConcept.html">MethodConcept</a> constants group combined by an arithmetical or-operation. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getSuppliedPropertyConcepts" class="membertitle">getSuppliedPropertyConcepts</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">long</td> </tr> <tr> <td valign="top"><b>getSuppliedPropertyConcepts</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns information about which property concepts described in the <a href="PropertyConcept.html">PropertyConcept</a> constants group are supported by this <a href="XIntrospectionAccess.html">XIntrospectionAccess</a> implementation. </dd> <dd><p>The minimum supported concepts should be:</p> <ul> <li> <b>PropertyConcept::PROPERTYSET</b>, </li> <li> <b>PropertyConcept::ATTRIBUTES</b> and </li> <li> <b>PropertyConcept::METHODS</b>. </li> </ul> </dd> <dt><b>Returns</b></dt> <dd>zero or more constants of the <a href="PropertyConcept.html">PropertyConcept</a> constants group.combined by an arithmetical or-operation. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getProperty" class="membertitle">getProperty</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3"><a href="Property.html">Property</a></td> </tr> <tr> <td valign="top"><b>getProperty</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aName,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nPropertyConcepts )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns information about a property if a property with the demanded name exists and if it accords to one of the demanded <a href="PropertyConcept.html">PropertyConcept</a>s. The information is provided as <a href="Property.html">Property</a> struct. </dd> <dt><b>Returns</b></dt> <dd>A <a href="Property.html">Property</a> struct providing information about the demanded property, if a corresponding property exists. </dd> <dt><b>Parameter aName</b></dt> <dd>the name of the property. </dd> <dt><b>Parameter nPropertyConcepts</b></dt> <dd>zero or more constants of the <a href="PropertyConcept.html">PropertyConcept</a> constants group combined by an arithmetical or-operation. </dd> <dt><b>Throws</b></dt> <dd>NoSuchElementException when a property with the demanded name doesn't exist or if it accords to a wrong <a href="PropertyConcept.html">PropertyConcept</a>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="hasProperty" class="membertitle">hasProperty</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>hasProperty</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aName,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nPropertyConcepts );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>allows to ask if a property with the demanded name exists and if it accords to one of the demanded <a href="PropertyConcept.html">PropertyConcept</a>s. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if the property exists and accords to one of the demanded <a href="PropertyConcept.html">PropertyConcept</a>s, otherwise <b>false</b> is returned. </dd> <dt><b>Parameter aName</b></dt> <dd>the name of the property. </dd> <dt><b>Parameter nPropertyConcepts</b></dt> <dd>zero or more constants of the <a href="PropertyConcept.html">PropertyConcept</a> constants group combined by an arithmetical or-operation. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getProperties" class="membertitle">getProperties</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< <a href="Property.html">Property</a> ></td> </tr> <tr> <td valign="top"><b>getProperties</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nPropertyConcepts );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns a sequence of properties of the introspected object </dd> <dt><b>Returns</b></dt> <dd>all properties of the introspected object which accord to the demanded <a href="PropertyConcept.html">PropertyConcept</a>s. </dd> <dt><b>Parameter nPropertyConcepts</b></dt> <dd>zero or more constants of the <a href="PropertyConcept.html">PropertyConcept</a> constants group combined by an arithmetical or-operation. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getMethod" class="membertitle">getMethod</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">::com::sun::star::<a href="../reflection/module-ix.html">reflection</a>::<a href="../reflection/XIdlMethod.html">XIdlMethod</a></td> </tr> <tr> <td valign="top"><b>getMethod</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aName,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nMethodConcepts )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/NoSuchMethodException.html">NoSuchMethodException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns information about a method if a method with the demanded name exists and if it accords to one of the demanded MethodConcepts. The information is provided as ::com::sun::star::<a href="../reflection/module-ix.html">reflection</a>::<a href="../reflection/XIdlMethod.html">XIdlMethod</a>. </dd> <dt><b>Returns</b></dt> <dd>A ::com::sun::star::<a href="../reflection/module-ix.html">reflection</a>::<a href="../reflection/XIdlMethod.html">XIdlMethod</a> providing information about and access to the demanded method if a corresponding method exists. </dd> <dt><b>Parameter aName</b></dt> <dd>the name of the method. </dd> <dt><b>Parameter nMethodConcepts</b></dt> <dd>zero or more constants of the <a href="MethodConcept.html">MethodConcept</a> constants group combined by an arithmetical or-operation. </dd> <dt><b>Throws</b></dt> <dd>NoSuchElementException when a method with the demanded name doesn't exist or if it accords to a wrong <a href="MethodConcept.html">MethodConcept</a>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="hasMethod" class="membertitle">hasMethod</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>hasMethod</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aName,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nMethodConcepts );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>allows to ask if a method with the demanded name exists and if it accords to one of the demanded <a href="MethodConcept.html">MethodConcept</a>s. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if the method exists and accords to one of the demanded <a href="MethodConcept.html">MethodConcept</a>s, otherwise <b>false</b> is returned. </dd> <dt><b>Parameter aName</b></dt> <dd>the name of the method. </dd> <dt><b>Parameter nMethodConcepts</b></dt> <dd>zero or more constants of the <a href="MethodConcept.html">MethodConcept</a> constants group combined by an arithmetical or-operation. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getMethods" class="membertitle">getMethods</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< ::com::sun::star::<a href="../reflection/module-ix.html">reflection</a>::<a href="../reflection/XIdlMethod.html">XIdlMethod</a> ></td> </tr> <tr> <td valign="top"><b>getMethods</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nMethodConcepts );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns a sequence of methods of the introspected object. </dd> <dt><b>Returns</b></dt> <dd>all methods of the introspected object which accord to the demanded <a href="MethodConcept.html">MethodConcept</a>s. </dd> <dt><b>Parameter nMethodConcepts</b></dt> <dd>zero or more constants of the <a href="MethodConcept.html">MethodConcept</a> constants group combined by an arithmetical or-operation. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getSupportedListeners" class="membertitle">getSupportedListeners</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< type ></td> </tr> <tr> <td valign="top"><b>getSupportedListeners</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the listener types supported by the introspected object. </dd> <dd><p>If the introspected object has the methods <code>addFooListener( XFooListener xFoo )</code> and <code>removeFooListener( XFooListener xFoo )</code> the type of XFooListener will be one of the elements in the returned sequence. </dd> <dt><b>Returns</b></dt> <dd>a sequence of the types of listener interfaces which are supported by the introspected object. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="queryAdapter" class="membertitle">queryAdapter</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/XInterface.html">XInterface</a></td> </tr> <tr> <td valign="top"><b>queryAdapter</b>(</td> <td valign="top">[in] type</td> <td valign="bottom"> aInterfaceType )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="IllegalTypeException.html">IllegalTypeException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>creates an adapter that implements an interface with the specified type. </dd> <dd><p>To access properties, query for the <a href="XPropertySet.html">XPropertySet</a> interface. If the <a href="XPropertySet.html">XPropertySet</a> can be queried, the <a href="XFastPropertySet.html">XFastPropertySet</a> interface must be supported too. </p> <p>If the introspected object implements a name container, the introspection should return the ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XNameAccess.html">XNameAccess</a> and ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XNameContainer.html">XNameContainer</a> interfaces.</p> <p>If the introspected object implements an index container, the introspection should return the ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XIndexAccess.html">XIndexAccess</a> and ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XIndexContainer.html">XIndexContainer</a> interfaces.</p> <p>If the introspected object implements an enumeration container, the introspection should return the ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XEnumerationAccess.html">XEnumerationAccess</a> interface.</p> <p>If the introspected object implements the ::com::sun::star::<a href="../reflection/module-ix.html">reflection</a>::<a href="../reflection/XIdlArray.html">XIdlArray</a> interface, the introspection should return this.</p> <p>To implement inaccurate name access, at all objects, which implement the ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XNameAccess.html">XNameAccess</a> or <a href="XPropertySet.html">XPropertySet</a> interface, the <a href="XExactName.html">XExactName</a> interface has to be supported. </p> </dd> <dt><b>See also</b></dt> <dd><a href="XExactName.html">XExactName</a></dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>