gecko-dev/rdf/base/idl/nsIRDFResource.idl
1999-11-24 20:51:39 +00:00

91 lines
3.1 KiB
Plaintext

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
*
* The contents of this file are subject to the Netscape Public
* License Version 1.1 (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.mozilla.org/NPL/
*
* Software distributed under the License is distributed on an "AS
* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
* implied. See the License for the specific language governing
* rights and limitations under the License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is Netscape
* Communications Corporation. Portions created by Netscape are
* Copyright (C) 1998 Netscape Communications Corporation. All
* Rights Reserved.
*
* Contributor(s):
*/
#include "nsrootidl.idl"
#include "nsIRDFNode.idl"
/**
* An nsIRDFResource is an object that has unique identity in the
* RDF data model. The object's identity is determined by its URI.
*/
[scriptable, uuid(E0C493D1-9542-11d2-8EB8-00805F29F370)]
interface nsIRDFResource : nsIRDFNode {
/**
* The single-byte string value of the resource
*/
readonly attribute string Value;
/**
* An unscriptable version used to avoid a string copy. Meant
* for use as a performance optimization.
*/
[noscript] void GetValueConst([shared] out string aConstValue);
/**
* This method is called by the nsIRDFService after constructing
* a resource object to initialize it's URI. You would not normally
* call this method directly
*/
void Init(in string uri);
/**
* Determine if the resource has the given URI.
*/
boolean EqualsString(in string aURI);
/**
* Retrieve the "delegate" object for this resource. A resource
* may have several delegate objects, each of whose lifetimes is
* bound to the life of the resource object.
*
* This method will return the delegate for the given key after
* QueryInterface()-ing it to the requested IID.
*
* If no delegate exists for the specified key, this method will
* attempt to create one using the component manager. Specifically,
* it will combine aKey with the resource's URI scheme to produce
* a ProgID as follows:
*
* component:/rdf/delegate-factory/[key]/[scheme]
*
* This ProgID will be used to locate a factory using the
* FindFactory() method of nsIComponentManager. If the nsIFactory
* exists, it will be used to create a "delegate factory"; that
* is, an object that supports nsIRDFDelegateFactory. The delegate
* factory will be used to construct the delegate object.
*/
void GetDelegate(in string aKey, in nsIIDRef aIID,
[iid_is(aIID),retval] out nsQIResult aResult);
/**
* Force a delegate to be "unbound" from the resource.
*
* Normally, a delegate object's lifetime will be identical to
* that of the resource to which it is bound; this method allows a
* delegate to unlink itself from an RDF resource prematurely.
*/
void ReleaseDelegate(in string aKey);
};