blob: 12f28bffaaec35dcec2970cf24d23cf8de67759e (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
|
# Copyright (C) 2007 by the Free Software Foundation, Inc.
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
# USA.
"""Interface for a collection of rosters."""
from zope.interface import Interface, Attribute
class IRosterSet(Interface):
"""A collection of IRosters."""
serial = Attribute(
"""The unique integer serial number for this roster set.
This is necessary to enforce the separation between the list storage
and the user/roster storage. You should always reference a roster set
indirectly through its serial number.""")
rosters = Attribute(
"""An iterator over all the IRosters in this collection.""")
def add(roster):
"""Add the IRoster to this collection.
Does nothing if the roster is already a member of this collection.
"""
def delete(roster):
"""Delete the IRoster from this collection.
Does nothing if the roster is not a member of this collection.
"""
|