interface XParameterizedContentProvider in module com::sun::star::ucb::

(Global Index)

Syntax

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

Description

Register specially adjusted instances of content providers on URL templates and supplementary arguments.

Method Summary

registerInstance Register a content provider on a URL template and supplementary arguments.

deregisterInstance Deregisters a content provider.

Known Services Which Export this Interface

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

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

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

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

Method Details



registerInstance

Syntax

com::sun::star::ucb::XContentProvider registerInstance (
string Template,
string Arguments,
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 IllegalArgumentException may be raised.

Parameter Arguments

Any supplementary arguments required by this XContentProvider , represented as a single string. If the input is malformed, an 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

Syntax

com::sun::star::ucb::XContentProvider deregisterInstance (
string Template,
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 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