sbILocalDatabaseSmartMediaList.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"
#include "sbIMediaList.idl"

interface sbIPropertyOperator;
interface sbILocalDatabaseSmartMediaList;

[scriptable, uuid(39b60b98-1b65-4e6e-866c-25b88127f8ad)]
interface sbILocalDatabaseSmartMediaListCondition : nsISupports
{
  readonly attribute AString propertyID;

  readonly attribute sbIPropertyOperator operator;

  readonly attribute AString leftValue;

  readonly attribute AString rightValue;

  readonly attribute AString displayUnit;
};

[scriptable, function, uuid(4b3f9a5b-44d5-4384-8f4d-6f953013f877)]
interface sbILocalDatabaseSmartMediaListListener : nsISupports
{
  void onRebuild(in sbILocalDatabaseSmartMediaList aSmartMediaList);
};


[scriptable, uuid(908211a1-2466-4642-bab9-75b228ff1532)]
interface sbILocalDatabaseSmartMediaList : sbIMediaList
{
  const unsigned long MATCH_TYPE_ANY  = 0;
  const unsigned long MATCH_TYPE_ALL  = 1;
  const unsigned long MATCH_TYPE_NONE = 2;

  const unsigned long LIMIT_TYPE_NONE  = 0;
  const unsigned long LIMIT_TYPE_ITEMS = 1;
  const unsigned long LIMIT_TYPE_USECS = 2;
  const unsigned long LIMIT_TYPE_BYTES = 3;

  const unsigned long NOTEXISTS_ASZERO = 0;
  const unsigned long NOTEXISTS_ASNULL = 1;

  attribute unsigned long matchType;

  readonly attribute unsigned long conditionCount;

  attribute unsigned long limitType;

  attribute unsigned long long limit;

  attribute AString selectPropertyID;

  attribute boolean selectDirection;

  attribute boolean randomSelection;

  attribute boolean autoUpdate;
  
   attribute unsigned long notExistsMode;

  sbILocalDatabaseSmartMediaListCondition
    appendCondition(in AString aPropertyID,
                    in sbIPropertyOperator aOperator,
                    in AString aLeftValue,
                    in AString aRightValue,
                    in AString aDisplayUnit);

  void removeConditionAt(in unsigned long aConditionIndex);

  sbILocalDatabaseSmartMediaListCondition
    getConditionAt(in unsigned long aConditionIndex);

  void clearConditions();

  void rebuild();
  
  void addSmartMediaListListener(in sbILocalDatabaseSmartMediaListListener aListener);
  void removeSmartMediaListListener(in sbILocalDatabaseSmartMediaListListener aListener);
  
  attribute AString sourceLibraryGuid;
};