/************************************************************** * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * *************************************************************/ #ifndef __com_sun_star_ucb_UniversalContentBroker_idl__ #define __com_sun_star_ucb_UniversalContentBroker_idl__ #ifndef __com_sun_star_lang_XComponent_idl__ #include #endif #ifndef __com_sun_star_ucb_XCommandProcessor_idl__ #include #endif #ifndef __com_sun_star_ucb_XCommandProcessor2_idl__ #include #endif #ifndef __com_sun_star_ucb_XContentProviderManager_idl__ #include #endif #ifndef __com_sun_star_ucb_XContentProvider_idl__ #include #endif #ifndef __com_sun_star_ucb_XContentIdentifierFactory_idl__ #include #endif #ifndef __com_sun_star_lang_XInitialization_idl__ #include #endif //============================================================================= module com { module sun { module star { module ucb { //============================================================================= /** is a one-instance service that provides access to a set of Contents via ContentProviders.

If the instance is created with two arguments of type string, these two strings are used to configure the newly instantiated broker; see the description of the required XInitialization interface for details.

If the instance is created without arguments, the newly instatiated broker is not configured. */ published service UniversalContentBroker { //------------------------------------------------------------------------- /** must be implemented to make it possible to resolve cyclic object references.

Those references i.e. may occur if content provider implementations hold references to the Broker. The Broker itself always holds its providers. If the Broker shall be released, XComponent::dispose must be called at the Broker. The implementation of this method must call XEventListener::disposing on the registered listeners (the providers holding the Broker must be those listeners) and release the appropriate object references. At the other hand, the implementation of XEventListener::disposing must release its appropriate references.

This interface is required. */ interface com::sun::star::lang::XComponent; //------------------------------------------------------------------------- /** provides access to all kind of contents provided by the registered content providers.

This interface is required. */ interface com::sun::star::ucb::XContentProvider; //------------------------------------------------------------------------- /** provides access to a set of content providers registered with the UCB.

This interface is required. */ interface com::sun::star::ucb::XContentProviderManager; //------------------------------------------------------------------------- /** creates XContentIdentifier implementation objects for all kind of contents provided by the UCB.

This interface is required. */ interface com::sun::star::ucb::XContentIdentifierFactory; //------------------------------------------------------------------------- /** supports the configuration of a newly created broker.

The XInitialization::initialize method should be called with two arguments of type string. These strings are used as a pair of keys to retrieve a set of content provider descriptions from the configuration management (stored at org.openoffice.ucb.Configuration.ContentProviders.key1.SecondaryKeys.key2.ProviderData within the configuration management's hierarchy). The retrieved descriptions are in turn used to register the corresponding content provider services at the broker.

Typical values for the pair of strings would be "Local"/"Office", to configure a broker that contains all the relevant content providers.

This interface is required. */ interface com::sun::star::lang::XInitialization; //------------------------------------------------------------------------- /** enables the caller to execute commands at the broker.

This interface is required.

		=======================================================================
		Commands:
		=======================================================================

		[return type]
			[command name]
				[parameter type and name]

		-----------------------------------------------------------------------
		Requiered commands:
		-----------------------------------------------------------------------

		// This command obtains an interface which allows to query
		// information on commands supported by the Content Broker.

		XCommandInfo
			getCommandInfo
				void

		// This command transfers Contents from one location to another.
		// Additionally, it can be used to create a link to a Content.
		// The implementation must be able to handle Contents provided
		// by any Content Provider. This is different from the command
		// 'transfer' that can be supported by a Content. That command
		// typically can only handle Contents provided by one
		// ContentProvider.

		void
			globalTransfer
				GlobalTransferCommandArgument
		
*/ interface com::sun::star::ucb::XCommandProcessor; //------------------------------------------------------------------------- /** is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via XCommandProcessor::createCommandIdentifier to avoid resource leaks. For a detailed description of the problem refer to XCommandProcessor2::releaseCommandIdentifier.

Where many existing UniversalContentBroker implementations do not (yet), every new implementation should support this interface. */ [optional] interface com::sun::star::ucb::XCommandProcessor2; }; //============================================================================= }; }; }; }; #endif