sbILocalDatabaseLibrary.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 nsIArray;
interface nsISimpleEnumerator;
interface nsIURI;
interface sbIMediaItem;
interface sbIMediaList;
interface sbIDatabaseQuery;
interface sbILocalDatabaseLibraryCopyListener;
interface sbILocalDatabaseGUIDArray;
interface sbILocalDatabasePropertyCache;
interface sbIPropertyArray;

%{C++
class sbLocalDatabaseLibrary;
%}

[ptr] native sbLocalDatabaseLibrary(sbLocalDatabaseLibrary);

[scriptable, uuid(c73c2057-e0bf-4caa-8f48-9b4582909b51)]
interface sbILocalDatabaseLibrary : nsISupports
{
  readonly attribute AString databaseGuid;

  readonly attribute nsIURI databaseLocation;

  readonly attribute sbILocalDatabasePropertyCache propertyCache;
  
  void addCopyListener(in sbILocalDatabaseLibraryCopyListener aCopyListener);

  void removeCopyListener(in sbILocalDatabaseLibraryCopyListener aCopyListener);

  ACString getContractIdForGuid(in AString aGuid);

  unsigned long getMediaItemIdForGuid(in AString aGuid);

  void NotifyListenersItemUpdated(in sbIMediaItem aItem,
                                  in sbIPropertyArray aProperties);

  void notifyCopyListenersItemCopied(in sbIMediaItem aSourceItem,
                                     in sbIMediaItem aDestinationItem);

  sbIDatabaseQuery createQuery();

  void forceBeginUpdateBatch();
  void forceEndUpdateBatch();

  [noscript] readonly attribute sbLocalDatabaseLibrary nativeLibrary;
};