diff options
Diffstat (limited to 'rdf/base/nsIRDFResource.idl')
-rw-r--r-- | rdf/base/nsIRDFResource.idl | 81 |
1 files changed, 81 insertions, 0 deletions
diff --git a/rdf/base/nsIRDFResource.idl b/rdf/base/nsIRDFResource.idl new file mode 100644 index 0000000000..df4d4b8ffd --- /dev/null +++ b/rdf/base/nsIRDFResource.idl @@ -0,0 +1,81 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ + +#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(fb9686a7-719a-49dc-9107-10dea5739341)] +interface nsIRDFResource : nsIRDFNode { + /** + * The single-byte string value of the resource. + * @note THIS IS OBSOLETE. C++ should use GetValueConst and script + * should use .valueUTF8 + */ + readonly attribute string Value; + + /** + * The UTF-8 URI of the resource. + */ + readonly attribute AUTF8String ValueUTF8; + + /** + * An unscriptable version used to avoid a string copy. Meant + * for use as a performance optimization. The string is encoded + * in UTF-8. + */ + [noscript] void GetValueConst([shared] out string aConstValue); + + /** + * This method is called by the nsIRDFService after constructing + * a resource object to initialize its 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 ContractID as follows: + * + * component:/rdf/delegate-factory/[key]/[scheme] + * + * This ContractID 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); +}; + + |