com.sapportals.wcm.util.usermanagement

Class SelectionUserManager

java.lang.Object
  com.sapportals.wcm.util.usermanagement.SelectionUserManager

Deprecated. As of NetWeaver 7.1, please use com.sap.ip.collaboration.coreui.api.people.composite.PeoplePicker.

public final class SelectionUserManager
extends Object

SelectionUserManager

Copyright (c) SAP AG 2001-2002

Field Summary

static String	DISPLAY_GROUP_CLOSE Deprecated. closing symbol for a selected group.
static String	DISPLAY_GROUP_OPEN Deprecated. opening symbol for a selected group.
static String	DISPLAY_ROLE_CLOSE Deprecated. closing symbol for a selected role.
static String	DISPLAY_ROLE_OPEN Deprecated. opening symbol for a selected role.
static String	DISPLAY_UNCHECKED_CLOSE Deprecated. closing symbol for an unchecked user.
static String	DISPLAY_UNCHECKED_OPEN Deprecated. opening symbol for an unchecked user.
static String	SEPARATOR Deprecated. tag to separate entries in the string export of the users, groups etc.
static String	TAG_FINALIZER Deprecated. tag to separate entries in the string export of the users, groups etc.
static String	TAG_SEPARATOR Deprecated. this is a tag to separate entries in the string export of the users, groups etc.
static int	TYPE_EMAIL Deprecated. Constant to identify a selected Object's Type (User, Group, Role: from IUMPrincipal) or (email, unchecked)
static int	TYPE_GROUP Deprecated. Constant to identify a selected Object's Type (User, Group, Role: from IUMPrincipal) or (email, unchecked)
static int	TYPE_ROLE Deprecated. Constant to identify a selected Object's Type (User, Group, Role: from IUMPrincipal) or (email, unchecked)
static int	TYPE_UNCHECKED Deprecated. Constant to identify a selected Object's Type (User, Group, Role: from IUMPrincipal) or (email, unchecked)
static int	TYPE_USER Deprecated. Constant to identify a selected Object's Type (User, Group, Role: from IUMPrincipal) or (email, unchecked)

Constructor Summary

SelectionUserManager()
Deprecated. By default, unchecked Names and email-adresses are not allowed.

SelectionUserManager(boolean allowEmails)
Deprecated. Constructor for the SelectionUserManager object

SelectionUserManager(boolean allowEmails, boolean allowUncheckedNames)
Deprecated. Constructor for the SelectionUserManager object

Method Summary

boolean	addEmailFromInput(String userList) Deprecated. Adds a feature to the EmailFromInput attribute of the SelectionUserManager object
boolean	addFromInput(String userList, boolean checkInput) Deprecated.
String[]	checkForInvalidIDs(String userList) Deprecated.
String[]	checkForNewInput(String userList) Deprecated.
String[]	checkForNonUniqueIDs(String userList) Deprecated.
void	deleteFromInput(String input) Deprecated. checks, if users who were selected have been deleted in the display
String	getDisplayString() Deprecated. Gets the displayString attribute of the SelectionUserManager object
String[]	getIDs(int typeOfList) Deprecated.
String	getInvalidIDs() Deprecated. Are invalid IDs given?
HashMap	getNonUniqueIDs() Deprecated. Gets the nonUniqueIDs attribute of the SelectionUserManager object
HashMap	getNonUniqueIDs(String userList) Deprecated.
String	getSelectionList() Deprecated.
Collection	getSelectionUsers(int typeOfList) Deprecated.
HashMap	getUniqueAndValidIDs(String userList) Deprecated.
void	handleAll(String userInput) Deprecated. before calling this method, the SelectionUserManager needs to be initialized with the persistent string, via the method initWithString .
boolean	initWithString(String persistentString) Deprecated.
boolean	isInvalidIDGiven() Deprecated. Gets the invalidIDGiven attribute of the SelectionUserManager object
boolean	isNonUniqueIDGiven() Deprecated. Are non UniqueIDsGiven?
void	setList(String[] ids, int typeOfList) Deprecated. fill a collection with ids, create display names
void	setList(String id, int typeOfList) Deprecated. fill a collection with id, create display name
void	setList(String id, String displayName, int typeOfList) Deprecated. fill a collection with id and displayName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE_USER

public static final int TYPE_USER

Deprecated.

Constant to identify a selected Object's Type (User, Group, Role: from IUMPrincipal) or (email, unchecked)

See Also:

Constant Field Values

TYPE_ROLE

public static final int TYPE_ROLE

Deprecated.

Constant to identify a selected Object's Type (User, Group, Role: from IUMPrincipal) or (email, unchecked)

See Also:

Constant Field Values

TYPE_GROUP

public static final int TYPE_GROUP

Deprecated.

Constant to identify a selected Object's Type (User, Group, Role: from IUMPrincipal) or (email, unchecked)

See Also:

Constant Field Values

TYPE_EMAIL

public static final int TYPE_EMAIL

Deprecated.

Constant to identify a selected Object's Type (User, Group, Role: from IUMPrincipal) or (email, unchecked)

See Also:

Constant Field Values

TYPE_UNCHECKED

public static final int TYPE_UNCHECKED

Deprecated.

Constant to identify a selected Object's Type (User, Group, Role: from IUMPrincipal) or (email, unchecked)

See Also:

Constant Field Values

TAG_SEPARATOR

public static final String TAG_SEPARATOR

Deprecated.

this is a tag to separate entries in the string export of the users, groups etc.

See Also:

Constant Field Values

TAG_FINALIZER

public static final String TAG_FINALIZER

Deprecated.

tag to separate entries in the string export of the users, groups etc.

See Also:

Constant Field Values

DISPLAY_GROUP_OPEN

public static final String DISPLAY_GROUP_OPEN

Deprecated.

opening symbol for a selected group.

See Also:

Constant Field Values

DISPLAY_GROUP_CLOSE

public static final String DISPLAY_GROUP_CLOSE

Deprecated.

closing symbol for a selected group.

See Also:

Constant Field Values

DISPLAY_ROLE_OPEN

public static final String DISPLAY_ROLE_OPEN

Deprecated.

opening symbol for a selected role.

See Also:

Constant Field Values

DISPLAY_ROLE_CLOSE

public static final String DISPLAY_ROLE_CLOSE

Deprecated.

closing symbol for a selected role.

See Also:

Constant Field Values

DISPLAY_UNCHECKED_CLOSE

public static final String DISPLAY_UNCHECKED_CLOSE

Deprecated.

closing symbol for an unchecked user.

See Also:

Constant Field Values

DISPLAY_UNCHECKED_OPEN

public static final String DISPLAY_UNCHECKED_OPEN

Deprecated.

opening symbol for an unchecked user.

See Also:

Constant Field Values

SEPARATOR

public static final String SEPARATOR

Deprecated.

tag to separate entries in the string export of the users, groups etc.

See Also:

Constant Field Values

Constructor Detail

SelectionUserManager

public SelectionUserManager(boolean allowEmails)

Deprecated.

Constructor for the SelectionUserManager object

Parameters:

allowEmails - email-adresses (recognized by the "@"-symbol) are allowed as valid selection

SelectionUserManager

public SelectionUserManager(boolean allowEmails,
                            boolean allowUncheckedNames)

Deprecated.

Constructor for the SelectionUserManager object

Parameters:

allowEmails - email-adresses (recognized by the "@"-symbol) are allowed as valid selection

allowUncheckedNames - names, that are not known by the usermanagement can be used as valid selection

SelectionUserManager

public SelectionUserManager()

Deprecated.

By default, unchecked Names and email-adresses are not allowed. With this setting, only users, groups and roles of the usermanagement can be added to the list of selected users

Method Detail

setList

public void setList(String[] ids,
                    int typeOfList)
             throws WcmException

Deprecated.

fill a collection with ids, create display names

Parameters:

ids - StringArray of User-IDs

typeOfList - value to distinguish between groups, roles, users...

Throws:

WcmException - is thrown when problems in UserManagement occur

setList

public void setList(String id,
                    int typeOfList)
             throws WcmException

Deprecated.

fill a collection with id, create display name

Parameters:

id - User-ID

typeOfList - value to distinguish between groups, roles, users...

Throws:

WcmException - is thrown when problems in UserManagement occur

setList

public void setList(String id,
                    String displayName,
                    int typeOfList)
             throws WcmException

Deprecated.

fill a collection with id and displayName

Parameters:

id - User-ID

displayName - DisplayName of the given User

typeOfList - value to distinguish between groups, roles, users...

Throws:

WcmException - is thrown when problems in UserManagement occur

getSelectionUsers

public Collection getSelectionUsers(int typeOfList)

Deprecated.

Parameters:

typeOfList - value to distinguish between groups, roles, users...

Returns:

a Collection of SelectionUsers or NULL

getIDs

public String[] getIDs(int typeOfList)

Deprecated.

Parameters:

typeOfList - value to distinguish between groups, roles, users...

Returns:

an Array with the IDs of the list or NULL

getSelectionList

public String getSelectionList()

Deprecated.

Returns:

String to persist in Control, separated as described in initWithString

getNonUniqueIDs

public HashMap getNonUniqueIDs(String userList)

Deprecated.

Parameters:

userList - a List of user-ids, display-names etc. (Usually submitted from a user-Input)

Returns:

a HashMap with three String[] Lists of nonUnique Recipients or NULL, if all is ok

getUniqueAndValidIDs

public HashMap getUniqueAndValidIDs(String userList)

Deprecated.

Parameters:

userList - a List of user-ids, display-names etc. (Usually submitted from a user-Input)

Returns:

a HashMap with three String[] Lists of nonUnique Recipients or NULL, if all is ok

getDisplayString

public String getDisplayString()

Deprecated.

Gets the displayString attribute of the SelectionUserManager object

Returns:

The displayString value

isInvalidIDGiven

public boolean isInvalidIDGiven()

Deprecated.

Gets the invalidIDGiven attribute of the SelectionUserManager object

Returns:

The invalidIDGiven value

isNonUniqueIDGiven

public boolean isNonUniqueIDGiven()

Deprecated.

Are non UniqueIDsGiven?

Returns:

The nonUniqueIDGiven value

getNonUniqueIDs

public HashMap getNonUniqueIDs()

Deprecated.

Gets the nonUniqueIDs attribute of the SelectionUserManager object

Returns:

The nonUniqueIDs value

getInvalidIDs

public String getInvalidIDs()

Deprecated.

Are invalid IDs given?

Returns:

The invalidIDs value

initWithString

public boolean initWithString(String persistentString)
                       throws WcmException

Deprecated.

Parameters:

persistentString - HtmlB/Wdf-Controls persist the value of User-Input fields with strings. The SelectionUserManager, which takes care of the user-selection in controls, offers two methods to initialize itself with the persistent data from the control (that is this method!) and to create a String with all information needed, after the user-input has been submitted to the SelectionUserManager. That is the method getSelectionList. The String combines User-ID, descriptionName and Type of User (user, role, group...) in triples and separates them from the next entry.

Returns:

flag, if operation successful or not

Throws:

WcmException - Description of Exception

checkForInvalidIDs

public String[] checkForInvalidIDs(String userList)

Deprecated.

Parameters:

userList - a list of UserIDs, displaynames etc., ususally coming from a user-input-field

Returns:

a SEPARATOR seperated List of invalid Recipients or NULL, if all is ok

checkForNonUniqueIDs

public String[] checkForNonUniqueIDs(String userList)

Deprecated.

Parameters:

userList - a list of UserIDs, displaynames etc., ususally coming from a user-input-field

Returns:

a SEPARATOR seperated List of nonUnique Recipients or NULL, if all is ok

checkForNewInput

public String[] checkForNewInput(String userList)

Deprecated.

Parameters:

userList - a list of UserIDs, displaynames etc., ususally coming from a user-input-field

Returns:

a List of all inputs, that are not known to the Manager at this time.
null, if all inputs are known

deleteFromInput

public void deleteFromInput(String input)

Deprecated.

checks, if users who were selected have been deleted in the display

Parameters:

input - Description of Parameter

addFromInput

public boolean addFromInput(String userList,
                            boolean checkInput)
                     throws WcmException

Deprecated.

Parameters:

userList - a list of UserIDs, displaynames etc., ususally coming from a user-input-field

checkInput - flag, if it is needed to check for invalid or nonUnique IDs

Returns:

flag, if operation successful or not

Throws:

WcmException - is thrown when problems in the usermanagement occur

addEmailFromInput

public boolean addEmailFromInput(String userList)
                          throws WcmException

Deprecated.

Adds a feature to the EmailFromInput attribute of the SelectionUserManager object

Parameters:

userList - The feature to be added to the EmailFromInput attribute

Returns:

Description of the Returned Value

Throws:

WcmException - Description of Exception

handleAll

public void handleAll(String userInput)
               throws WcmException

Deprecated.

before calling this method, the SelectionUserManager needs to be initialized with the persistent string, via the method initWithString . All information for control logic afterwards (invalid or non unique users), all actions (delete, add, format displaynames) are performed in this method. The persistence for the control once again can be exported via setList .

Parameters:

userInput - A list of UserIDs, Displaynames etc. usually coming from a user-input-field.

Throws:

WcmException - problems occured within the UserManagement

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM