Songbird / Development / Songbird Add-Ons API Documentation

sbILocalDatabaseGUIDArray Interface Reference

[USER CODE SHOULD NOT REFERENCE THIS CLASS] More...

import "sbILocalDatabaseGUIDArray.idl";

Inheritance diagram for sbILocalDatabaseGUIDArray:

sbILocalDatabaseAsyncGUIDArray List of all members.

Public Member Functions

AString getSortPropertyValueByIndex (in unsigned long aIndex)
 Return the sortable property value at the given index.
unsigned long getMediaItemIdByIndex (in unsigned long aIndex)
 Return the media item id at the given index.
AString getOrdinalByIndex (in unsigned long aIndex)
 Return the ordinal at the given index.
AString getGuidByIndex (in unsigned long aIndex)
 Return the guid at the given index.
unsigned long long getRowidByIndex (in unsigned long aIndex)
 Return the rowid at the given index.
boolean containsGuid (in AString aGuid)
 Return true if the array contains the given GUID. May be forced to fetch and cache all items.

Public Attributes

attribute AString databaseGUID
attribute nsIURI databaseLocation
attribute AString baseTable
attribute AString baseConstraintColumn
attribute unsigned long baseConstraintValue
attribute unsigned long fetchSize
attribute boolean isDistinct
readonly attribute unsigned
long 
length
attribute sbILocalDatabaseGUIDArrayListener listener
attribute sbILocalDatabasePropertyCache propertyCache
readonly attribute sbIPropertyArray currentSort

Detailed Description

[USER CODE SHOULD NOT REFERENCE THIS CLASS]

Definition at line 54 of file sbILocalDatabaseGUIDArray.idl.


Member Function Documentation

AString sbILocalDatabaseGUIDArray::getSortPropertyValueByIndex ( in unsigned long  aIndex  ) 

Return the sortable property value at the given index.

Parameters:
aIndex The index of the array
Returns:
The sortable property value
Exceptions:
NS_ERROR_INVALID_ARG If the index is out of bounds

unsigned long sbILocalDatabaseGUIDArray::getMediaItemIdByIndex ( in unsigned long  aIndex  ) 

Return the media item id at the given index.

Parameters:
aIndex The index of the array
Returns:
The media item id
Exceptions:
NS_ERROR_INVALID_ARG If the index is out of bounds

AString sbILocalDatabaseGUIDArray::getOrdinalByIndex ( in unsigned long  aIndex  ) 

Return the ordinal at the given index.

Parameters:
aIndex The index of the array
Returns:
The ordinal
Exceptions:
NS_ERROR_INVALID_ARG If the index is out of bounds

AString sbILocalDatabaseGUIDArray::getGuidByIndex ( in unsigned long  aIndex  ) 

Return the guid at the given index.

Parameters:
aIndex The index of the array
Returns:
The guid
Exceptions:
NS_ERROR_INVALID_ARG If the index is out of bounds

unsigned long long sbILocalDatabaseGUIDArray::getRowidByIndex ( in unsigned long  aIndex  ) 

Return the rowid at the given index.

Parameters:
aIndex The index of the array
Returns:
The guid
Exceptions:
NS_ERROR_INVALID_ARG If the index is out of bounds


The documentation for this interface was generated from the following file:
Generated on Tue Mar 10 14:28:59 2009 for Songbird by  doxygen 1.5.2