001: /*
002: * $Header: /export/home/cvsroot/MyPersonalizerRepository/MyPersonalizer/Subsystems/Kernel/Sources/es/udc/mypersonalizer/kernel/model/repository/interfaces/WorkspaceDefinitionAccessor.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 java.util.Collection;
044:
045: import es.udc.mypersonalizer.kernel.util.exceptions.InstanceNotFoundException;
046: import es.udc.mypersonalizer.kernel.util.exceptions.DuplicateInstanceException;
047: import es.udc.mypersonalizer.kernel.util.exceptions.InternalErrorException;
048:
049: /**
050: * This interface specifies the methods required to store and retrieve
051: * instances of the <code>WorkspaceDefinition</code> class.
052: *
053: * @author Abel Iago Toral Quiroga
054: * @author Abel Muinho
055: * @since 1.0
056: */
057: public interface WorkspaceDefinitionAccessor {
058:
059: /**
060: * Finds a workspace definition in the database.
061: * @param workspaceType The workspace definition type, which is also
062: * its unique identifier.
063: * @throws <code>InstanceNotFoundException</code> can't find the
064: * workspace definition in the database.
065: * @throws <code>InternalErrorException</code> if a severe error occured.
066: * @return The workspace definition.
067: */
068: public WorkspaceDefinition findWorkspaceDefinition(
069: String workspaceType) throws InstanceNotFoundException,
070: InternalErrorException;
071:
072: /**
073: * Updates a workspace definition in the database.
074: * @param workspaceDefinition the new workspace definition data.
075: * @throws <code>InstanceNotFoundException</code> can't find the
076: * workspace definition to update in the database.
077: * @throws <code>InternalErrorException</code> if a severe error occured.
078: */
079: public void updateWorkspaceDefinition(
080: WorkspaceDefinition workspaceDefinition)
081: throws InstanceNotFoundException, InternalErrorException;
082:
083: /**
084: * Removes a workspace definition in the database.
085: * @param workspaceType The workspace definition type, which is also
086: * its unique identifier.
087: * @throws <code>InstanceNotFoundException</code> can't find the workspace
088: * definition to remove in the database.
089: * @throws <code>InternalErrorException</code> if a severe error occured.
090: */
091: public void removeWorkspaceDefinition(String workspaceType)
092: throws InstanceNotFoundException, InternalErrorException;
093:
094: /**
095: * Adds a workspace definition to the database.
096: * @param workspaceDefinition the workspace definition to add.
097: * @throws <code>DuplicateInstanceException</code> if there is
098: * another workspace definition with the same workspace type.
099: * @throws <code>InternalErrorException</code> if a severe error occured.
100: */
101: public void addWorkspaceDefinition(
102: WorkspaceDefinition workspaceDefinition)
103: throws DuplicateInstanceException, InternalErrorException;
104:
105: /**
106: * Finds all workspace definitions in the database.
107: * @throws <code>InternalErrorException</code> if a severe error occured.
108: * @return a <code>Collection</code> of <code>WorkspaceDefinition</code>s
109: * with all the workspace definitions in the database.
110: */
111: public Collection findAllWorkspaceDefinitions()
112: throws InternalErrorException;
113: }
|