| com.flexive.shared.interfaces.BriefcaseEngine
All known Subclasses: com.flexive.ejb.beans.BriefcaseEngineBean,
| BriefcaseEngine | | public interface BriefcaseEngine (Code) | | Bean handling Briefcases.
A briefcase is a object store which may be accessed with flexive SQL
or the API provided by this beans.
author:
Gregor Schober (gregor.schober@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at) |
| Method Summary | |
| void | addItems(long id, long[] objectIds)
Add the given items to the briefcase. | | void | clear(long id)
Removes all items of the given briefcase. | | long | create(String name, String description, Long aclId)
Creates a new empty briefcase.
Parameters:
name - the name of the briefcase.
Parameters:
description - the description (may be empty)
Parameters:
aclId - the ACL to use if the briefcase should be shared, or null if the briefcase isonly visible for the owner. | | long[] | getItems(long id)
Load all item IDs stored in the given briefcase. | | List<Briefcase> | getList(boolean includeShared)
Gets a list of all briefcase for the calling user. | | Briefcase | load(long id)
Loads the briefcase with the given id. | | void | modify(long id, String name, String description, Long aclId)
Modifies a briefcase. | | void | remove(long id)
Removes the briefcase with the specified id. | | void | removeItems(long id, long[] objectIds)
Removes the given items from the briefcase. | | void | setItems(long id, long[] objectIds)
Replace the current briefcase content with the given objects (i.e. | | void | updateItems(long id, long[] addObjectIds, long[] removeObjectIds)
Adds/removes the given items for the briefcase. |
| addItems | | void addItems(long id, long[] objectIds) throws FxApplicationException(Code) | | Add the given items to the briefcase.
Parameters:
id - the briefcase ID
Parameters:
objectIds - the object IDs to be added
throws:
FxApplicationException - if the items could not be added |
| create | | long create(String name, String description, Long aclId) throws FxApplicationException(Code) | | Creates a new empty briefcase.
Parameters:
name - the name of the briefcase.
Parameters:
description - the description (may be empty)
Parameters:
aclId - the ACL to use if the briefcase should be shared, or null if the briefcase isonly visible for the owner. the unique briefcase id
throws:
FxApplicationException - if the create failed |
| getList | | List<Briefcase> getList(boolean includeShared) throws FxApplicationException(Code) | | Gets a list of all briefcase for the calling user.
Parameters:
includeShared - if enabled shared briefcases will be included, if disabled onlythe briefcases created by the calling user will be returned the briefcases
throws:
FxApplicationException - if the function fails |
| modify | | void modify(long id, String name, String description, Long aclId) throws FxApplicationException(Code) | | Modifies a briefcase.
Parameters:
name - the new name of the briefcase, or null to keep the old value
Parameters:
description - the new description, or null to keep the old value
Parameters:
aclId - the new ACL, or -1 to remove a old acl, or null to keep the old value
Parameters:
id - the id of the briefcase to modify
throws:
FxApplicationException - if the modify operation failed |
| remove | | void remove(long id) throws FxApplicationException(Code) | | Removes the briefcase with the specified id.
The calling user may remove a briefcase if he is the owner, or if he has ben granted the remove
permission via the briefcases ACL.
A global supervisor may remove and briefcase.
A mandator supervisor may remove all briefcases that belong to his domain.
Parameters:
id - the id
throws:
FxApplicationException - if the calling user lacks the remove permission and is not the owner,or if a other error occured. |
| removeItems | | void removeItems(long id, long[] objectIds) throws FxApplicationException(Code) | | Removes the given items from the briefcase.
Parameters:
id - the briefcase ID
Parameters:
objectIds - the objects to be removed
throws:
FxApplicationException - if the items could not be removed |
| setItems | | void setItems(long id, long[] objectIds) throws FxApplicationException(Code) | | Replace the current briefcase content with the given objects (i.e. clear the
briefcase, then add the given objects).
Parameters:
id - the briefcase ID
Parameters:
objectIds - the new briefcase content
throws:
FxApplicationException - if the content could not be replaced |
| updateItems | | void updateItems(long id, long[] addObjectIds, long[] removeObjectIds) throws FxApplicationException(Code) | | Adds/removes the given items for the briefcase.
Parameters:
id - the briefcase ID
Parameters:
addObjectIds - items to be added
Parameters:
removeObjectIds - items to be removed
throws:
FxApplicationException - if the briefcase could not be updated |
|
|