CStockage 4.2_beta-RC-1
API Documentation

org.esupportail.portal.channels.CStockage.spacesPersonalization
Class PersonalizationTool

java.lang.Object
  extended byorg.esupportail.portal.channels.CStockage.spacesPersonalization.PersonalizationTool

public class PersonalizationTool
extends java.lang.Object

Id: PersonalizationTool.java,v 1.0 13 janv. 2005 Copyright (c) 2005 Esup Portail (www.esup-portail.org) Classes: PersonalizationTool Original Author: Yohan Colmant This class is a tool used to manage the sharing actions


Field Summary
static java.lang.String ADMINISTRATED_SERVER
          If the server into the database is administrated
 
Constructor Summary
PersonalizationTool()
          Constructor
 
Method Summary
 void addStorageUsersPreferences(java.lang.String id, java.lang.String userKey)
          Add a user preference into the database from a user
 void delStorageUsersPreferences(java.lang.String id)
          Delete users preferences for a shared space from the database
 void delStorageUsersPreferencesForUser(java.lang.String id, java.lang.String userKey)
          Delete a user preference from the database
 java.util.Vector getAvailableSpacesForAll(java.lang.String userPortalLogin, boolean obliged)
          Get the available spaces for a group
 java.util.Vector getAvailableSpacesForGroup(java.lang.String targetKey, java.lang.String userPortalLogin, boolean obliged)
          Get the available spaces for a group
 java.util.Vector getAvailableSpacesForUser(java.lang.String targetKey, java.lang.String userPortalLogin, boolean obliged)
          Get the available spaces for a user
 java.util.Vector getKeyOfSpacesFromPreferences(java.lang.String target)
          Get the list of ids of spaces which has already been selected by the current user from users table
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ADMINISTRATED_SERVER

public static final java.lang.String ADMINISTRATED_SERVER
If the server into the database is administrated

See Also:
Constant Field Values
Constructor Detail

PersonalizationTool

public PersonalizationTool()
                    throws PropertiesException
Constructor

Throws:
PropertiesException
Method Detail

getAvailableSpacesForUser

public java.util.Vector getAvailableSpacesForUser(java.lang.String targetKey,
                                                  java.lang.String userPortalLogin,
                                                  boolean obliged)
                                           throws DataBaseException,
                                                  PropertiesException,
                                                  ServerException
Get the available spaces for a user

Parameters:
targetKey - the key of the target
userPortalLogin - the login of the user in the portal
Returns:
a vector. Each element is an array of [url, path, label, owner, xmlSpace, read:'T'|'F', write:'T'|'F']
Throws:
DataBaseException
PropertiesException
ServerException

getAvailableSpacesForGroup

public java.util.Vector getAvailableSpacesForGroup(java.lang.String targetKey,
                                                   java.lang.String userPortalLogin,
                                                   boolean obliged)
                                            throws DataBaseException,
                                                   PropertiesException,
                                                   ServerException
Get the available spaces for a group

Parameters:
targetKey - the key of the target
Returns:
a vector. Each element is an array of [url, path, label, owner, xmlSpace, read:'T'|'F', write:'T'|'F']
Throws:
DataBaseException
PropertiesException
ServerException

getAvailableSpacesForAll

public java.util.Vector getAvailableSpacesForAll(java.lang.String userPortalLogin,
                                                 boolean obliged)
                                          throws DataBaseException,
                                                 PropertiesException,
                                                 ServerException
Get the available spaces for a group

Parameters:
userPortalLogin - the login of the portal's user
obliged - if the user is obliged to see the space
Returns:
a vector. Each element is an array of [url, path, label, owner, xmlSpace, read:'T'|'F', write:'T'|'F']
Throws:
DataBaseException
PropertiesException
ServerException

delStorageUsersPreferencesForUser

public void delStorageUsersPreferencesForUser(java.lang.String id,
                                              java.lang.String userKey)
                                       throws DataBaseException
Delete a user preference from the database

Parameters:
id - the id of the sharement in the other database
userKey - the key of the user
Throws:
DataBaseException

delStorageUsersPreferences

public void delStorageUsersPreferences(java.lang.String id)
                                throws DataBaseException
Delete users preferences for a shared space from the database

Parameters:
id - the id of the sharement in the other database
Throws:
DataBaseException

addStorageUsersPreferences

public void addStorageUsersPreferences(java.lang.String id,
                                       java.lang.String userKey)
                                throws DataBaseException
Add a user preference into the database from a user

Parameters:
id - the id of the sharement in the other database
userKey - the login of the user in the portal
Throws:
DataBaseException

getKeyOfSpacesFromPreferences

public java.util.Vector getKeyOfSpacesFromPreferences(java.lang.String target)
                                               throws DataBaseException
Get the list of ids of spaces which has already been selected by the current user from users table

Parameters:
target - the user or group target key
Returns:
a Vector
Throws:
DataBaseException

CStockage 4.2_beta-RC-1
API Documentation