01: /*
02: * File : $Source: /usr/local/cvs/opencms/src/org/opencms/workplace/tools/I_CmsIdentifiableObjectContainer.java,v $
03: * Date : $Date: 2008-02-27 12:05:31 $
04: * Version: $Revision: 1.4 $
05: *
06: * This library is part of OpenCms -
07: * the Open Source Content Management System
08: *
09: * Copyright (c) 2002 - 2008 Alkacon Software GmbH (http://www.alkacon.com)
10: *
11: * This library is free software; you can redistribute it and/or
12: * modify it under the terms of the GNU Lesser General Public
13: * License as published by the Free Software Foundation; either
14: * version 2.1 of the License, or (at your option) any later version.
15: *
16: * This library is distributed in the hope that it will be useful,
17: * but WITHOUT ANY WARRANTY; without even the implied warranty of
18: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19: * Lesser General Public License for more details.
20: *
21: * For further information about Alkacon Software GmbH, please see the
22: * company website: http://www.alkacon.com
23: *
24: * For further information about OpenCms, please see the
25: * project website: http://www.opencms.org
26: *
27: * You should have received a copy of the GNU Lesser General Public
28: * License along with this library; if not, write to the Free Software
29: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30: */
31:
32: package org.opencms.workplace.tools;
33:
34: import java.util.List;
35:
36: /**
37: * Container for identifiable objects.<p>
38: *
39: * @author Michael Moossen
40: *
41: * @version $Revision: 1.4 $
42: *
43: * @since 6.0.0
44: */
45: public interface I_CmsIdentifiableObjectContainer {
46:
47: /**
48: * Appends the specified object to the end of this container. <p>
49: *
50: * @param id the object identifier
51: * @param object the object add to the container
52: *
53: * @see java.util.List#add(Object)
54: */
55: void addIdentifiableObject(String id, Object object);
56:
57: /**
58: * Inserts the specified object at the specified position in this container.<p>
59: *
60: * Shifts the object currently at that position (if any) and any subsequent
61: * objects to the right (adds one to their indices).<p>
62: *
63: * @param id the object identifier
64: * @param object the object add to the container
65: * @param position the insertion point
66: *
67: * @see java.util.List#add(int, Object)
68: */
69: void addIdentifiableObject(String id, Object object, float position);
70:
71: /**
72: * Resets the container.<p>
73: */
74: void clear();
75:
76: /**
77: * Returns the list of objects.<p>
78: *
79: * @return the a list of <code>{@link Object}</code>s.
80: */
81: List elementList();
82:
83: /**
84: * Returns an object by id.<p>
85: *
86: * @param id the id of the object
87: *
88: * @return the object if found, or <code>null</code>
89: *
90: * @see java.util.Map#get(Object)
91: */
92: Object getObject(String id);
93: }
|