1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_ucb_XContentIdentifier_idl__ 24cdf0e10cSrcweir#define __com_sun_star_ucb_XContentIdentifier_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir 31cdf0e10cSrcweir//============================================================================= 32cdf0e10cSrcweir 33cdf0e10cSrcweirmodule com { module sun { module star { module ucb { 34cdf0e10cSrcweir 35cdf0e10cSrcweir//============================================================================= 36cdf0e10cSrcweir/** An identifier for contents. 37cdf0e10cSrcweir 38cdf0e10cSrcweir @version 1.0 39cdf0e10cSrcweir @author Kai Sommerfeld 40cdf0e10cSrcweir @see XContent 41cdf0e10cSrcweir*/ 42cdf0e10cSrcweirpublished interface XContentIdentifier: com::sun::star::uno::XInterface 43cdf0e10cSrcweir{ 44cdf0e10cSrcweir //------------------------------------------------------------------------- 45cdf0e10cSrcweir /** returns the content identifier string. 46cdf0e10cSrcweir 47cdf0e10cSrcweir @returns 48cdf0e10cSrcweir the content identifier string. This must be a valid URI 49cdf0e10cSrcweir (Uniform Resource Identifier, see RFC 2396). This string 50cdf0e10cSrcweir is required. If a content provider 'implements' some 51cdf0e10cSrcweir existent URI scheme (e.g., a content provider offering 52cdf0e10cSrcweir access to a file system would implement the 'file' scheme, 53cdf0e10cSrcweir and a content provider offering access to IMAP servers 54cdf0e10cSrcweir would implement the 'imap' scheme), the content identifier 55cdf0e10cSrcweir strings should use that scheme. If on the other hand a 56cdf0e10cSrcweir content provider offers access to content for which no 57cdf0e10cSrcweir appropriate URI scheme exists, a vendor-specific URL scheme 58cdf0e10cSrcweir starting with 'vnd.' must be created (see the Internet Draft 59cdf0e10cSrcweir draft-king-vnd-urlscheme-00.txt). 60cdf0e10cSrcweir */ 61cdf0e10cSrcweir string getContentIdentifier(); 62cdf0e10cSrcweir 63cdf0e10cSrcweir //------------------------------------------------------------------------- 64cdf0e10cSrcweir /** returns the content provider scheme string. 65cdf0e10cSrcweir 66cdf0e10cSrcweir <p>This string will be calculated from the content identifier string 67cdf0e10cSrcweir and must be lower-cased(!). It is the 'scheme' the content provider is 68cdf0e10cSrcweir registered for. In example, a provider for FTP contents will use 69cdf0e10cSrcweir ftp-URL's as content identifiers. The content provider scheme for all 70cdf0e10cSrcweir contents provided by that provider will be "ftp". 71cdf0e10cSrcweir </p> 72cdf0e10cSrcweir 73cdf0e10cSrcweir @returns 74cdf0e10cSrcweir the content provider scheme string. 75cdf0e10cSrcweir */ 76cdf0e10cSrcweir string getContentProviderScheme(); 77cdf0e10cSrcweir 78cdf0e10cSrcweir}; 79cdf0e10cSrcweir 80cdf0e10cSrcweir//============================================================================= 81cdf0e10cSrcweir 82cdf0e10cSrcweir}; }; }; }; 83cdf0e10cSrcweir 84cdf0e10cSrcweir#endif 85