sbILibraryConstraints.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 nsISimpleEnumerator;
interface nsIStringEnumerator;
interface sbILibraryConstraint;
interface sbILibraryConstraintGroup;

[scriptable, uuid(3da5df89-9718-4c5e-9494-0d6116ab2bdd)]
interface sbILibraryConstraintBuilder : nsISupports
{
  sbILibraryConstraintBuilder parseFromString(in AString aSerializedConstraint);

  sbILibraryConstraintBuilder includeConstraint(in sbILibraryConstraint aConstraint);

  sbILibraryConstraintBuilder include(in AString aProperty,
                                      in AString aValue);

  sbILibraryConstraintBuilder includeList(in AString aProperty,
                                          in nsIStringEnumerator aValues);

  sbILibraryConstraintBuilder intersect();

  sbILibraryConstraint get();
};

[scriptable, uuid(c271cafb-fc06-4e56-bd01-368458117618)]
interface sbILibraryConstraint : nsISupports
{
  readonly attribute unsigned long groupCount;
  readonly attribute nsISimpleEnumerator groups;
  sbILibraryConstraintGroup getGroup(in unsigned long aIndex);

  boolean equals(in sbILibraryConstraint aOtherConstraint);
  AString toString();
};

[scriptable, uuid(37793a91-e229-4642-9c16-290b84e24b87)]
interface sbILibraryConstraintGroup : nsISupports
{
  readonly attribute nsIStringEnumerator properties;
  nsIStringEnumerator getValues(in AString aProperty);
  boolean hasProperty(in AString aProperty);
  boolean equals(in sbILibraryConstraintGroup aOtherGroup);
  AString toString();
};

[scriptable, uuid(d9655856-f518-43f1-b096-25f52b0b629e)]
interface sbILibrarySort : nsISupports
{
  void init(in AString aProperty, in boolean aIsAscending);

  readonly attribute AString property;
  readonly attribute boolean isAscending;
  AString toString();
};