sbILocalDatabaseGUIDArray.idl

Go to the documentation of this file.

/*
//
// BEGIN SONGBIRD GPL
//
// This file is part of the Songbird web player.
//
// Copyright(c) 2005-2008 POTI, Inc.
// http://songbirdnest.com
//
// This file may be licensed under the terms of of the
// GNU General Public License Version 2 (the "GPL").
//
// Software distributed under the License is distributed
// on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either
// express or implied. See the GPL for the specific language
// governing rights and limitations.
//
// You should have received a copy of the GPL along with this
// program. If not, go to http://www.gnu.org/licenses/gpl.html
// or write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
//
// END SONGBIRD GPL
//
*/

#include "nsISupports.idl"

interface nsIStringEnumerator;
interface nsIURI;
interface sbILocalDatabasePropertyCache;
interface sbIPropertyArray;

[scriptable, uuid(60cc270d-58f9-4cc5-a68c-d16a0139a027)]
interface sbILocalDatabaseGUIDArrayListener : nsISupports
{
  void onBeforeInvalidate(in boolean aInvalidateLength);

  void onAfterInvalidate();
};

[scriptable, uuid(80d33aac-dbb1-44eb-bda8-22c764ab16df)]
interface sbILocalDatabaseGUIDArrayLengthCache : nsISupports
{
  void addCachedLength(in AString aKey, in unsigned long aLength);
  void removeCachedLength(in AString aKey);
  unsigned long getCachedLength(in AString aKey);

  void addCachedNonNullLength(in AString aKey, in unsigned long aLength);
  void removeCachedNonNullLength(in AString aKey);
  unsigned long getCachedNonNullLength(in AString aKey);
};

[scriptable, uuid(e1b502cc-3e00-4873-bb9b-722cd8a13e99)]
interface sbILocalDatabaseGUIDArray : nsISupports
{
  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;

  readonly attribute unsigned long length;

  attribute sbILocalDatabaseGUIDArrayListener listener;

  attribute sbILocalDatabasePropertyCache propertyCache;

  attribute sbILocalDatabaseGUIDArrayLengthCache lengthCache;
  
  void addSort(in AString aProperty,
               in boolean aAscending);

  void clearSorts();

  readonly attribute sbIPropertyArray currentSort;

  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);

  unsigned long getMediaItemIdByIndex(in unsigned long aIndex);

  AString getOrdinalByIndex(in unsigned long aIndex);

  AString getGuidByIndex(in unsigned long aIndex);

  unsigned long long getRowidByIndex(in unsigned long aIndex);

  AString getViewItemUIDByIndex(in unsigned long aIndex);

  void invalidate(in boolean aInvalidateLength);

  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);

  /* aViewItemUID is a concatenation of the mediaItem's rowid and mediaItemid
   * in it's libraries database, of the form "rowid-mediaItemid".
   *
   * We can use this viewItemUID to find the index in the guid array
   * of the mediaitem that it corresponds to. */
  unsigned long getIndexByViewItemUID(in AString aViewItemUID);

  boolean containsGuid(in AString aGuid);

  void suppressInvalidation(in boolean aSuppress);
  
  void mayInvalidate([array, size_is(aCount)] in unsigned long aDirtyPropertyIDs,
                     in unsigned long aCount);
};