# -*- coding: utf-8 -*-
from zope.interface import Interface


class IOrderable(Interface):
    """ Marker interface for orderable portal content """


class IFolder(Interface):
    """ Marker interface for Plone-like folders """


class IOrderableFolder(IFolder):
    """ A Plone-like folder with ordering support """

    def getOrdering():
        """ return the currently active ordering adapter for this folder """

    def setOrdering(ordering=u''):
        """ (re)set ordering adapter to be used for this folder """


class IOrdering(Interface):
    """ An adapter providing ordering operations on its context folder.

        The OrderedBTreeFolderBase mix-in class will adapt self (the
        folder) to this interface when trying to get object position or
        find the order of items. There is a default implementation, but
        you can provide a different policy.

        Your adapter (which should still adapt to IOrdered) can
        optionally provide IExplicitOrdering, defined below. This is
        used to support explicit ordering, e.g. through a UI. """

    def notifyAdded(obj_id):
        """ Inform the ordering implementation that an item was added """

    def notifyRemoved(obj_id):
        """ Inform the ordering implementation that an item was removed """

    def getObjectPosition(obj_id):
        """ Get the position of the given object id """

    def idsInOrder():
        """ Return all object ids, in the correct order """


class IExplicitOrdering(IOrdering):
    """ An adapter allowing explicit ordering """

    def moveObjectsByDelta(ids, delta, subset_ids=None, suppress_events=False):
        """ Move the specified ids (a sequence, or a single string id)
            by the given delta (a positive or negative number). By
            default, this moves the objects within the whole set of
            sub-items in the context container, but if subset_ids is
            specified, it gives a subset of ids to consider.
            Should return the number of objects that changed position. """

    def moveObjectsUp(ids, delta=1, subset_ids=None):
        """ Move specified sub-objects up by delta in container. """

    def moveObjectsDown(ids, delta=1, subset_ids=None):
        """ Move specified sub-objects down by delta in container. """

    def moveObjectsToTop(ids, subset_ids=None):
        """ Move specified sub-objects to top of container. """

    def moveObjectsToBottom(ids, subset_ids=None):
        """ Move specified sub-objects to bottom of container. """

    def moveObjectToPosition(obj_id, position, suppress_events=False):
        """ Move specified object to absolute position. """

    def orderObjects(key, reverse=None):
        """ Order sub-objects by key and direction. """