General interface to data resources. More...
import"sbILibraryResource.idl";
Public Member Functions | |
AString | getProperty (in AString aID) |
Get the value of a property of this resource. More... | |
void | setProperty (in AString aID, in AString aValue) |
Set the value of a property on this resource. More... | |
sbIPropertyArray | getProperties ([optional] in sbIPropertyArray aPropertyIDs) |
Get properties from this resource in a property array. More... | |
void | setProperties (in sbIPropertyArray aProperties) |
Sets the properties and values in the supplied property array to this resource. This works as if you called setProperty on each property in the array. More... | |
boolean | equals (in sbILibraryResource aOtherLibraryResource) |
Tests the equality of two library resources. More... | |
Public Attributes | |
readonly attribute AString | guid |
The guid of this resource. More... | |
readonly attribute long long | created |
The creation time of this resource as a unix timestamp. More... | |
readonly attribute long long | updated |
The last update time of this resource as a unix timestamp. More... | |
readonly attribute nsIStringEnumerator | propertyIDs |
Returns a string enumerator of the IDs of all the properties set on this resource. More... | |
readonly attribute boolean | userEditable |
True if users should be allowed to modify the resource. More... | |
General interface to data resources.
This interface should be implemented by each object of the data model, including libraries, media items, and media lists.
Definition at line 48 of file sbILibraryResource.idl.
boolean sbILibraryResource::equals | ( | in sbILibraryResource | aOtherLibraryResource | ) |
Tests the equality of two library resources.
sbIPropertyArray sbILibraryResource::getProperties | ( | [optional] in sbIPropertyArray | aPropertyIDs | ) |
Get properties from this resource in a property array.
aPropertyIDs | A property array containing the IDs of the properties you wish to retrieve. The values of these properties are disregarded. If this parameter is null or not specified, all properties will be returned |
AString sbILibraryResource::getProperty | ( | in AString | aID | ) |
Get the value of a property of this resource.
This method will never throw. If a value doesn't exist it will return a special "void" string that behaves just like an empty string except that the IsVoid() method will return PR_TRUE for those who care.
aID | ID of the property to get |
void sbILibraryResource::setProperties | ( | in sbIPropertyArray | aProperties | ) |
Sets the properties and values in the supplied property array to this resource. This works as if you called setProperty on each property in the array.
aProperties | Properties to set to this resource |
void sbILibraryResource::setProperty | ( | in AString | aID, |
in AString | aValue | ||
) |
Set the value of a property on this resource.
aID | ID of the property to set |
aValue | New value for the specified property |
readonly attribute long long sbILibraryResource::created |
The creation time of this resource as a unix timestamp.
Definition at line 86 of file sbILibraryResource.idl.
readonly attribute AString sbILibraryResource::guid |
The guid of this resource.
Definition at line 69 of file sbILibraryResource.idl.
readonly attribute nsIStringEnumerator sbILibraryResource::propertyIDs |
Returns a string enumerator of the IDs of all the properties set on this resource.
Definition at line 110 of file sbILibraryResource.idl.
readonly attribute long long sbILibraryResource::updated |
The last update time of this resource as a unix timestamp.
Definition at line 104 of file sbILibraryResource.idl.
readonly attribute boolean sbILibraryResource::userEditable |
True if users should be allowed to modify the resource.
Definition at line 116 of file sbILibraryResource.idl.