(incubating) | The Free and Open Productivity Suite

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous

Content for OpenOffice.org version 3.3.
Overview Module Use Devguide Index
Methods' Summary Attributes' Summary Methods' Details Attributes' Details

:: com :: sun :: star :: ucb ::

interface XParameterizedContentProvider
Description
Register specially adjusted instances of content providers on URL templates and supplementary arguments.
Methods' Summary
registerInstance Register a content provider on a URL template and supplementary arguments.  
deregisterInstance Deregisters a content provider.  
Methods' Details
registerInstance
XContentProvider
registerInstance( [in] string  Template,
[in] string  Arguments,
[in] boolean  ReplaceExisting )
raises( ::com::sun::star::lang::IllegalArgumentException );
Description
Register a content provider on a URL template and supplementary arguments.
Parameter Template
A URL template. If the input is malformed or too complex, an ::com::sun::star::lang::IllegalArgumentException may be raised.
Parameter Arguments
Any supplementary arguments required by this XContentProvider, represented as a single string. If the input is malformed, an ::com::sun::star::lang::IllegalArgumentException may be raised.
Parameter ReplaceExisting
If true, and if the given Template conflicts with an already registered instance, the old registration is replaced by the new one. If false, and if the given Template conflicts with an already registered instance, the new registration is not performed, and null is returned.
Returns
Either this XContentProvider, or another, specially adjusted version of this XContentProvider (this flexibility allows for different implementation strategies), or null if the given Template conflicts with an already registered instance and ReplaceExisting is false. Note that the returned XContentProvider must still be registered at the content provider manager!
deregisterInstance
XContentProvider
deregisterInstance( [in] string  Template,
[in] string  Arguments )
raises( ::com::sun::star::lang::IllegalArgumentException );
Description
Deregisters a content provider.
Parameter Template
A URL template. If the input is malformed or too complex, an IllegalArgumentException may be raised.
Parameter Arguments
Any supplementary arguments required by this XContentProvider, represented as a single string. If the input is malformed, an ::com::sun::star::lang::IllegalArgumentException may be raised.
Returns
Either this XContentProvider, or another, specially adjusted version of this XContentProvider (this flexibility allows for different implementation strategies), or null if no instance is registered for the given Template. Note that the returned XContentProvider must still be deregistered at the content provider manager!
Top of Page

Copyright © 1995, 2010, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Apache OpenOffice is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.

Copyright & License
Apache and the Apache feather logos are trademarks of The Apache Software Foundation. OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.