Class OrderedSetInterface

Description
Description | Methods (details)

The OrderedSet interface defines methods that are needed for ordering sets of ids. Sets provide for the easy storage of groups of ids.

  • author: Adam Franco
  • version: $Id: OrderedSet.interface.php,v 1.4 2007/09/04 20:25:49 adamfranco Exp $
  • license: GNU General Public License (GPL)
  • copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/sets/OrderedSet.interface.php (line 18) 

SetInterface
   |
   --OrderedSetInterface
Method Summary
Description | Methods (details)
void addItem (object Id $id)
integer count ()
integer getPosition (object Id $id)
void moveDown (object Id $id)
void moveToPosition (object Id $id, integer $position)
void moveUp (object Id $id)
Methods
Description | Methods (details)
addItem (line 27)

Add a new Id to the set. The new item will be placed at the end of the set.

  • access: public
void addItem (object Id $id)
  • object Id $id: The Id of the item to add.
count (line 66)

Return the number of ids in the set.

  • access: public
integer count ()
getPosition (line 57)

Return the current position of the id in the set.

  • access: public
integer getPosition (object Id $id)
  • object Id $id: The Id of the item to move.
moveDown (line 47)

Move the specified id toward the end of the set.

  • access: public
void moveDown (object Id $id)
  • object Id $id: The Id of the item to move.
moveToPosition (line 77)

Move the specified id to the specified position in the set.

  • access: public
void moveToPosition (object Id $id, integer $position)
  • object Id $id: The Id of the item to move.
  • integer $position: The new position of the specified id.
moveUp (line 37)

Move the specified id toward the begining of the set.

  • access: public
void moveUp (object Id $id)
  • object Id $id: The Id of the item to move.

Documentation generated on Wed, 19 Sep 2007 10:25:23 -0400 by phpDocumentor 1.3.0RC3