001: /*
002: * $Header: /export/home/cvsroot/MyPersonalizerRepository/MyPersonalizer/Subsystems/Kernel/Sources/es/udc/mypersonalizer/kernel/model/repository/interfaces/WorkspaceLayoutAccessor.java,v 1.1.1.1 2004/03/25 12:08:36 fbellas Exp $
003: * $Revision: 1.1.1.1 $
004: * $Date: 2004/03/25 12:08:36 $
005: *
006: * =============================================================================
007: *
008: * Copyright (c) 2003, The MyPersonalizer Development Group
009: * (http://www.tic.udc.es/~fbellas/mypersonalizer/index.html) at
010: * University Of A Coruna
011: * All rights reserved.
012: *
013: * Redistribution and use in source and binary forms, with or without
014: * modification, are permitted provided that the following conditions are met:
015: *
016: * - Redistributions of source code must retain the above copyright notice,
017: * this list of conditions and the following disclaimer.
018: *
019: * - Redistributions in binary form must reproduce the above copyright notice,
020: * this list of conditions and the following disclaimer in the documentation
021: * and/or other materials provided with the distribution.
022: *
023: * - Neither the name of the University Of A Coruna nor the names of its
024: * contributors may be used to endorse or promote products derived from
025: * this software without specific prior written permission.
026: *
027: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
028: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
029: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
030: * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
031: * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
032: * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
033: * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
034: * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
035: * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
036: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
037: * POSSIBILITY OF SUCH DAMAGE.
038: *
039: */
040:
041: package es.udc.mypersonalizer.kernel.model.repository.interfaces;
042:
043: import es.udc.mypersonalizer.kernel.model.properties.Property;
044: import es.udc.mypersonalizer.kernel.util.exceptions.InstanceNotFoundException;
045: import es.udc.mypersonalizer.kernel.util.exceptions.InternalErrorException;
046: import java.util.Collection;
047: import java.util.Map;
048:
049: /**
050: * This interface specifies the methods required to store and retrieve
051: * instances of the <code>WorkspaceLayout</code> class.
052: *
053: * @author Daniel Fernandez
054: * @since 1.0
055: */
056: public interface WorkspaceLayoutAccessor {
057:
058: /**
059: * Finds a workspace layout
060: *
061: * @param identifier the workspace layout identifier
062: * @throws InternalErrorException if any fatal errors happen.
063: * @throws InstanceNotFoundException if it was unable to find the
064: * specified instance
065: * @return the WorkspaceLayout desired.
066: */
067: public WorkspaceLayout findWorkspaceLayout(Long identifier)
068: throws InternalErrorException, InstanceNotFoundException;
069:
070: /**
071: * Finds a set of workspace layout from their identifiers
072: *
073: * @param identifiers the Collection of identifiers (Long).
074: * @throws InternalErrorException if any fatal errors happen.
075: * @throws InstanceNotFoundException if it was unable to find the
076: * specified instance.
077: * @return a Map with the WorkspaceLayouts, indexed by identifier.
078: */
079: public Map findWorkspaceLayouts(Collection identifiers)
080: throws InternalErrorException, InstanceNotFoundException;
081:
082: /**
083: * Adds a new workspace layout to the repository. This method must return a
084: * {@link WorkspaceLayout} with a correct identifier.
085: *
086: * @param property the Property which will maintain the WorkspaceLayout data
087: * @throws InternalErrorException if any fatal errors happen.
088: * @return a WorkspaceLayout with the provided property, and a valid
089: * property identifier.
090: */
091: public WorkspaceLayout addWorkspaceLayout(Property property)
092: throws InternalErrorException;
093:
094: /**
095: * Updates an existing workspace layout.
096: *
097: * @param workspaceLayout the workspace layout to be updated, identified by
098: * its identifier.
099: * @throws InternalErrorException if any fatal errors happen.
100: * @throws InstanceNotFoundException if the workspace layout that should be
101: * updated isn't found.
102: */
103: public void updateWorkspaceLayout(WorkspaceLayout workspaceLayout)
104: throws InternalErrorException, InstanceNotFoundException;
105:
106: /**
107: * Removes a workspace layout from the repository.
108: *
109: * @param identifier The identifier of the workspace layout to be removed
110: * @throws InternalErrorException if any fatal errors happen.
111: * @throws InstanceNotFoundException if the workspace layout is not found
112: */
113: public void removeWorkspaceLayout(Long identifier)
114: throws InternalErrorException, InstanceNotFoundException;
115:
116: }
|