001: /*
002: * $Header: /export/home/cvsroot/MyPersonalizerRepository/MyPersonalizer/Subsystems/Portal/Sources/es/udc/mypersonalizer/portal/model/types/content/FindDesktopContentResult.java,v 1.1.1.1 2004/03/25 12:08:40 fbellas Exp $
003: * $Revision: 1.1.1.1 $
004: * $Date: 2004/03/25 12:08:40 $
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.portal.model.types.content;
042:
043: import java.io.Serializable;
044: import java.util.*;
045:
046: /**
047: * This class is the result for a {@link
048: * es.udc.mypersonalizer.portal.model.actions.content.FindDesktopContentAction}
049: * action. It contains:
050: * <ul>
051: * <li><tt>allowedNewWorkspaces</tt>: The List of workspaces
052: * the user can add. If the user is <tt>mypersonalizer</tt>, then
053: * these will be the names of the workspace definitions present in the
054: * system.
055: * If it's another user, then these will be the workspaces of
056: * <tt>mypersonalizer</tt> for which the user has permissions.
057: * The elements of this List are Maps, containing the values:
058: * <ul>
059: * <li><tt>workspaceType</tt>: The name of the
060: * workspace definition (only if the user is mypersonalizer).</li>
061: * <li><tt>workspaceLayoutIdentifier</tt>: The identifier of the
062: * mypersonalizer workspace (only if the user is not
063: * mypersonalizer).</li>
064: * <li><tt>workspaceName</tt>: The name to be displayed for the
065: * workspace.</li>
066: * </ul>
067: * </li>
068: * <li><tt>removableWorkspaces</tt>: The List of workspaces the user can
069: * remove. These workspaces will be in fact Maps containing:
070: * <ul>
071: * <li><tt>workspaceName</tt>: The name of the workspace.</li>
072: * <li><tt>workspaceLayoutIdentifier</tt>: Its identifier.</li>
073: * </ul>
074: * </li>
075: * <li><tt>defaultWorkspaceLayoutIdentifier</tt>: The property identifier
076: * (Long) for the user's workspace which is set as default.</li>
077: * <li><tt>defaultWorkspaceName</tt>: The name of the default workspace,
078: * needed to be shown.</li>
079: * </ul>
080: *
081: * @author Daniel Fernandez
082: * @since 1.0
083: */
084: public class FindDesktopContentResult implements Serializable {
085:
086: /**
087: * The List of Maps for the workspaces the user can add.
088: */
089: private List allowedNewWorkspaces;
090:
091: /**
092: * The List of Maps for the workspaces the user can remove.
093: */
094: private List removableWorkspaces;
095:
096: /**
097: * The default workspace layout identifier.
098: */
099: private Long defaultWorkspaceLayoutIdentifier;
100:
101: /**
102: * The default workspace layout name.
103: */
104: private String defaultWorkspaceName;
105:
106: /**
107: * Creates a new instance of FindDesktopContentResult.
108: *
109: * @param allowedNewWorkspaces the List of allowed workspaces (Maps)
110: * @param removableWorkspaces the List of removable workspaces (Maps)
111: * @param defaultWorkspaceLayoutIdentifier the default workspace layout
112: * identifier.
113: * @param defaultWorkspaceName the default workspace name.
114: */
115: public FindDesktopContentResult(List allowedNewWorkspaces,
116: List removableWorkspaces,
117: Long defaultWorkspaceLayoutIdentifier,
118: String defaultWorkspaceName) {
119: this .allowedNewWorkspaces = allowedNewWorkspaces;
120: this .removableWorkspaces = removableWorkspaces;
121: this .defaultWorkspaceLayoutIdentifier = defaultWorkspaceLayoutIdentifier;
122: this .defaultWorkspaceName = defaultWorkspaceName;
123: }
124:
125: /**
126: * Returns the List of allowed workspaces, being each value
127: * a Map (as defined in the class description).
128: *
129: * @return the allowed workspaces List.
130: */
131: public List getAllowedNewWorkspaces() {
132: return allowedNewWorkspaces;
133: }
134:
135: /**
136: * Returns the List of removable workspaces, being each value
137: * a Map (as defined in the class description).
138: *
139: * @return the removable workspaces List.
140: */
141: public List getRemovableWorkspaces() {
142: return removableWorkspaces;
143: }
144:
145: /**
146: * Returns the default workspace layout identifier.
147: *
148: * @return the default workspace layout identifier.
149: */
150: public Long getDefaultWorkspaceLayoutIdentifier() {
151: return defaultWorkspaceLayoutIdentifier;
152: }
153:
154: /**
155: * Returns the default workspace name.
156: *
157: * @return the default workspace name.
158: */
159: public String getDefaultWorkspaceName() {
160: return defaultWorkspaceName;
161: }
162:
163: }
|