sbIPropertyManager Interface Reference

Manager for system wide metadata properties. More...

import"sbIPropertyManager.idl";

Inheritance diagram for sbIPropertyManager:
[legend]
Collaboration diagram for sbIPropertyManager:
[legend]

Public Member Functions

sbIPropertyInfo getPropertyInfo (in AString aID)
 Get a property object from its id. More...
 
void addPropertyInfo (in sbIPropertyInfo aPropertyInfo)
 Add a property into the system. More...
 
boolean hasProperty (in AString aID)
 Check for a property in the system by ID. More...
 
nsIStringBundle createBundle (in string aURLSpec)
 Helper to get a string bundle. More...
 
AString getStringFromName (in nsIStringBundle aBundle, in AString aName)
 Helper to get a display value, using a string name, from a bundle. More...
 
sbIPropertyArray getDependentProperties (in AString aID)
 Get all the properties that in any way depend on the given property. For example, the secondary sort of property A may include property B. More...
 

Public Attributes

readonly attribute
nsIStringEnumerator 
propertyIDs
 An enumerator containing the ids of all registered properties. More...
 

Detailed Description

Manager for system wide metadata properties.

Components should register properties with this service at startup.

See Also
sbIPropertyInfo

Definition at line 52 of file sbIPropertyManager.idl.

Member Function Documentation

void sbIPropertyManager::addPropertyInfo ( in sbIPropertyInfo  aPropertyInfo)

Add a property into the system.

Parameters
aPropertyInfoProperty to add into the system. An exception is thrown if the property's ID is not unique
nsIStringBundle sbIPropertyManager::createBundle ( in string  aURLSpec)

Helper to get a string bundle.

sbIPropertyArray sbIPropertyManager::getDependentProperties ( in AString  aID)

Get all the properties that in any way depend on the given property. For example, the secondary sort of property A may include property B.

sbIPropertyInfo sbIPropertyManager::getPropertyInfo ( in AString  aID)

Get a property object from its id.

Parameters
aIDID of the property
Returns
Property object for the given property, null if not found
AString sbIPropertyManager::getStringFromName ( in nsIStringBundle  aBundle,
in AString  aName 
)

Helper to get a display value, using a string name, from a bundle.

boolean sbIPropertyManager::hasProperty ( in AString  aID)

Check for a property in the system by ID.

Parameters
aIDID of the property
Returns
true if property is in system
false if property is not in system

Member Data Documentation

readonly attribute nsIStringEnumerator sbIPropertyManager::propertyIDs

An enumerator containing the ids of all registered properties.

Definition at line 58 of file sbIPropertyManager.idl.


The documentation for this interface was generated from the following file: