001: /***************************************************************
002: * This file is part of the [fleXive](R) project.
003: *
004: * Copyright (c) 1999-2008
005: * UCS - unique computing solutions gmbh (http://www.ucs.at)
006: * All rights reserved
007: *
008: * The [fleXive](R) project is free software; you can redistribute
009: * it and/or modify it under the terms of the GNU General Public
010: * License as published by the Free Software Foundation;
011: * either version 2 of the License, or (at your option) any
012: * later version.
013: *
014: * The GNU General Public License can be found at
015: * http://www.gnu.org/copyleft/gpl.html.
016: * A copy is found in the textfile GPL.txt and important notices to the
017: * license from the author are found in LICENSE.txt distributed with
018: * these libraries.
019: *
020: * This library is distributed in the hope that it will be useful,
021: * but WITHOUT ANY WARRANTY; without even the implied warranty of
022: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
023: * GNU General Public License for more details.
024: *
025: * For further information about UCS - unique computing solutions gmbh,
026: * please see the company website: http://www.ucs.at
027: *
028: * For further information about [fleXive](R), please see the
029: * project website: http://www.flexive.org
030: *
031: *
032: * This copyright notice MUST APPEAR in all copies of the file!
033: ***************************************************************/package com.flexive.shared.interfaces;
034:
035: import com.flexive.shared.exceptions.FxApplicationException;
036: import com.flexive.shared.search.Briefcase;
037:
038: import javax.ejb.Remote;
039: import java.util.List;
040:
041: /**
042: * Bean handling Briefcases.
043: * <p />
044: * A briefcase is a object store which may be accessed with flexive SQL
045: * or the API provided by this beans.
046: *
047: * @author Gregor Schober (gregor.schober@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)
048: */
049: @Remote
050: public interface BriefcaseEngine {
051:
052: /**
053: * Creates a new empty briefcase.
054: *
055: * @param name the name of the briefcase.
056: *
057: * @param description the description (may be empty)
058: * @param aclId the ACL to use if the briefcase should be shared, or null if the briefcase is
059: * only visible for the owner.
060: * @return the unique briefcase id
061: * @throws FxApplicationException if the create failed
062: */
063: long create(String name, String description, Long aclId)
064: throws FxApplicationException;
065:
066: /**
067: * Gets a list of all briefcase for the calling user.
068: *
069: * @param includeShared if enabled shared briefcases will be included, if disabled only
070: * the briefcases created by the calling user will be returned
071: * @return the briefcases
072: * @throws FxApplicationException if the function fails
073: */
074: List<Briefcase> getList(boolean includeShared)
075: throws FxApplicationException;
076:
077: /**
078: * Loads the briefcase with the given id.
079: *
080: * @param id the id
081: * @return the briefcase
082: * @throws FxApplicationException if a error occured
083: * @throws com.flexive.shared.exceptions.FxNotFoundException if it could not be found or was not readable by the calling user.
084: */
085: Briefcase load(long id) throws FxApplicationException;
086:
087: /**
088: * Removes the briefcase with the specified id.
089: * <p />
090: * The calling user may remove a briefcase if he is the owner, or if he has ben granted the remove
091: * permission via the briefcases ACL.<br>
092: * A global supervisor may remove and briefcase.<br>
093: * A mandator supervisor may remove all briefcases that belong to his domain.<br>
094: *
095: * @param id the id
096: * @throws FxApplicationException if the calling user lacks the remove permission and is not the owner,
097: * or if a other error occured.
098: */
099: void remove(long id) throws FxApplicationException;
100:
101: /**
102: * Modifies a briefcase.
103: *
104: * @param name the new name of the briefcase, or null to keep the old value
105: * @param description the new description, or null to keep the old value
106: * @param aclId the new ACL, or -1 to remove a old acl, or null to keep the old value
107: * @param id the id of the briefcase to modify
108: * @throws FxApplicationException if the modify operation failed
109: */
110: void modify(long id, String name, String description, Long aclId)
111: throws FxApplicationException;
112:
113: /**
114: * Removes all items of the given briefcase.
115: *
116: * @param id the briefcase ID
117: * @throws FxApplicationException if the briefcase could not be cleared
118: */
119: void clear(long id) throws FxApplicationException;
120:
121: /**
122: * Add the given items to the briefcase.
123: *
124: * @param id the briefcase ID
125: * @param objectIds the object IDs to be added
126: * @throws FxApplicationException if the items could not be added
127: */
128: void addItems(long id, long[] objectIds)
129: throws FxApplicationException;
130:
131: /**
132: * Replace the current briefcase content with the given objects (i.e. clear the
133: * briefcase, then add the given objects).
134: *
135: * @param id the briefcase ID
136: * @param objectIds the new briefcase content
137: * @throws FxApplicationException if the content could not be replaced
138: */
139: void setItems(long id, long[] objectIds)
140: throws FxApplicationException;
141:
142: /**
143: * Adds/removes the given items for the briefcase.
144: *
145: * @param id the briefcase ID
146: * @param addObjectIds items to be added
147: * @param removeObjectIds items to be removed
148: * @throws FxApplicationException if the briefcase could not be updated
149: */
150: void updateItems(long id, long[] addObjectIds,
151: long[] removeObjectIds) throws FxApplicationException;
152:
153: /**
154: * Removes the given items from the briefcase.
155: *
156: * @param id the briefcase ID
157: * @param objectIds the objects to be removed
158: * @throws FxApplicationException if the items could not be removed
159: */
160: void removeItems(long id, long[] objectIds)
161: throws FxApplicationException;
162:
163: /**
164: * Load all item IDs stored in the given briefcase.
165: *
166: * @param id the briefcase ID
167: * @return the item IDs
168: * @throws FxApplicationException if the items could not be loaded
169: */
170: long[] getItems(long id) throws FxApplicationException;
171: }
|