sbILocalDatabaseGUIDArray Interface Reference

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

import"sbILocalDatabaseGUIDArray.idl";

Inheritance diagram for sbILocalDatabaseGUIDArray:

Collaboration diagram for sbILocalDatabaseGUIDArray:

Public Member Functions
void	addSort (in AString aProperty, in boolean aAscending)
void	clearSorts ()
void	addFilter (in AString aProperty, in nsIStringEnumerator aValues, in boolean aIsSearch)
void	clearFilters ()
boolean	isIndexCached (in unsigned long aIndex)
AString	getSortPropertyValueByIndex (in unsigned long aIndex)
	Return the sortable property value at the given index. More...
unsigned long	getMediaItemIdByIndex (in unsigned long aIndex)
	Return the media item id at the given index. More...
AString	getOrdinalByIndex (in unsigned long aIndex)
	Return the ordinal at the given index. More...
AString	getGuidByIndex (in unsigned long aIndex)
	Return the guid at the given index. More...
unsigned long long	getRowidByIndex (in unsigned long aIndex)
	Return the rowid at the given index. More...
AString	getViewItemUIDByIndex (in unsigned long aIndex)
	Return the viewItemUID for the item at the given index. More...
void	invalidate (in boolean aInvalidateLength)
	Invalidate the contents of the array. More...
sbILocalDatabaseGUIDArray	clone ()
void	cloneInto (in sbILocalDatabaseGUIDArray aDest)
void	removeByIndex (in unsigned long aIndex)
unsigned long	getFirstIndexByPrefix (in AString aPrefix)
unsigned long	getFirstIndexByGuid (in AString aGuid)
unsigned long	getIndexByViewItemUID (in AString aViewItemUID)
boolean	containsGuid (in AString aGuid)
	Return true if the array contains the given GUID. May be forced to fetch and cache all items. More...
void	suppressInvalidation (in boolean aSuppress)
	Counter based invalidation suppression. More...
void	mayInvalidate ([array, size_is(aCount)] in unsigned long aDirtyPropertyIDs, in unsigned long aCount)
	Checks to see if the guid array needs to be invalidated and invalidates if needed. More...

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 boolean	isValid
attribute boolean	distinctWithSortableValues
	If the guid array is distinct, this value will cause the guid array to be filled with the sortable values instead of human redeable values. More...
readonly attribute unsigned long	length
attribute sbILocalDatabaseGUIDArrayListener	listener
attribute sbILocalDatabasePropertyCache	propertyCache
attribute sbILocalDatabaseGUIDArrayLengthCache	lengthCache
readonly attribute sbIPropertyArray	currentSort

Detailed Description

[USER CODE SHOULD NOT REFERENCE THIS CLASS]

Definition at line 81 of file sbILocalDatabaseGUIDArray.idl.

Member Function Documentation

void sbILocalDatabaseGUIDArray::addFilter	(	in AString	aProperty,
		in nsIStringEnumerator	aValues,
		in boolean	aIsSearch
	)

void sbILocalDatabaseGUIDArray::addSort	(	in AString	aProperty,
		in boolean	aAscending
	)

void sbILocalDatabaseGUIDArray::clearFilters

(

)

void sbILocalDatabaseGUIDArray::clearSorts

(

)

sbILocalDatabaseGUIDArray sbILocalDatabaseGUIDArray::clone

(

)

void sbILocalDatabaseGUIDArray::cloneInto

(

in sbILocalDatabaseGUIDArray

aDest

)

boolean sbILocalDatabaseGUIDArray::containsGuid

(

in AString

aGuid

)

Return true if the array contains the given GUID. May be forced to fetch and cache all items.

unsigned long sbILocalDatabaseGUIDArray::getFirstIndexByGuid

(

in AString

aGuid

)

unsigned long sbILocalDatabaseGUIDArray::getFirstIndexByPrefix

(

in AString

aPrefix

)

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 sbILocalDatabaseGUIDArray::getIndexByViewItemUID

(

in AString

aViewItemUID

)

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

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

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

AString sbILocalDatabaseGUIDArray::getViewItemUIDByIndex

(

in unsigned long

aIndex

)

Return the viewItemUID for the item at the given index.

Parameters

aIndex

The index of the mediaitem in the array

Returns

The viewItemUID (rowid-mediaItemid)

Exceptions

NS_ERROR_INVALID_ARG

If the index is out of bounds

void sbILocalDatabaseGUIDArray::invalidate

(

in boolean

aInvalidateLength

)

Invalidate the contents of the array.

Parameters

aInvalidateLength

- Also invalidates the cached length of the array.

boolean sbILocalDatabaseGUIDArray::isIndexCached

(

in unsigned long

aIndex

)

void sbILocalDatabaseGUIDArray::mayInvalidate	(	[array, size_is(aCount)] in unsigned long	aDirtyPropertyIDs,
		in unsigned long	aCount
	)

Checks to see if the guid array needs to be invalidated and invalidates if needed.

Parameters

aDirtyPropertyIDs

The list of dirty property ids. This array must best sorted from least to greatest property ID so that it can be binary searched.

void sbILocalDatabaseGUIDArray::removeByIndex

(

in unsigned long

aIndex

)

void sbILocalDatabaseGUIDArray::suppressInvalidation

(

in boolean

aSuppress

)

Counter based invalidation suppression.

Note

Don't call this method!

Member Data Documentation

attribute AString sbILocalDatabaseGUIDArray::baseConstraintColumn

Definition at line 89 of file sbILocalDatabaseGUIDArray.idl.

attribute unsigned long sbILocalDatabaseGUIDArray::baseConstraintValue

Definition at line 91 of file sbILocalDatabaseGUIDArray.idl.

attribute AString sbILocalDatabaseGUIDArray::baseTable

Definition at line 87 of file sbILocalDatabaseGUIDArray.idl.

readonly attribute sbIPropertyArray sbILocalDatabaseGUIDArray::currentSort

Definition at line 119 of file sbILocalDatabaseGUIDArray.idl.

attribute AString sbILocalDatabaseGUIDArray::databaseGUID

Definition at line 83 of file sbILocalDatabaseGUIDArray.idl.

attribute nsIURI sbILocalDatabaseGUIDArray::databaseLocation

Definition at line 85 of file sbILocalDatabaseGUIDArray.idl.

attribute boolean sbILocalDatabaseGUIDArray::distinctWithSortableValues

If the guid array is distinct, this value will cause the guid array to be filled with the sortable values instead of human redeable values.

Definition at line 104 of file sbILocalDatabaseGUIDArray.idl.

attribute unsigned long sbILocalDatabaseGUIDArray::fetchSize

Definition at line 93 of file sbILocalDatabaseGUIDArray.idl.

attribute boolean sbILocalDatabaseGUIDArray::isDistinct

Definition at line 95 of file sbILocalDatabaseGUIDArray.idl.

readonly attribute boolean sbILocalDatabaseGUIDArray::isValid

Definition at line 97 of file sbILocalDatabaseGUIDArray.idl.

readonly attribute unsigned long sbILocalDatabaseGUIDArray::length

Definition at line 106 of file sbILocalDatabaseGUIDArray.idl.

attribute sbILocalDatabaseGUIDArrayLengthCache sbILocalDatabaseGUIDArray::lengthCache

Definition at line 112 of file sbILocalDatabaseGUIDArray.idl.

attribute sbILocalDatabaseGUIDArrayListener sbILocalDatabaseGUIDArray::listener

Definition at line 108 of file sbILocalDatabaseGUIDArray.idl.

attribute sbILocalDatabasePropertyCache sbILocalDatabaseGUIDArray::propertyCache

Definition at line 110 of file sbILocalDatabaseGUIDArray.idl.

---

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

• /home/martin/dev/nightingale-hacking/components/library/localdatabase/public/sbILocalDatabaseGUIDArray.idl