com.wewebu.ow.server.conf
Interface OwBaseUserInfo

All Known Subinterfaces:
OwUserInfo
All Known Implementing Classes:
OwLDAPGroupInfo, OwLDAPUserInfo

public interface OwBaseUserInfo

Base interface for user and group information.

Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.

For licensing information read the license.txt file or
go to: http://wiki.alfresco.com


Method Summary
 Collection getGroups()
          get a list with group information the user is assigned to
 Collection getRoleNames()
          get a string list of role names for this user
 String getUserDisplayName()
          get the user display name.
 String getUserEmailAdress()
          get the user eMail Address
 String getUserID()
          get the user unique persistent ID, which does not change even when name changes
 String getUserLongName()
          get name of logged in user in the long descriptive form
 String getUserName()
          get the user login
 String getUserShortName()
          get the user short name.
 boolean isGroup()
          flag indication, that user info actually designates a group rather than a single user
 

Method Detail

getUserLongName

String getUserLongName()
                       throws Exception
get name of logged in user in the long descriptive form

Returns:
String user name
Throws:
Exception

getUserName

String getUserName()
                   throws Exception
get the user login

Returns:
String user login
Throws:
Exception

getUserDisplayName

String getUserDisplayName()
                          throws Exception
get the user display name.

Returns:
String the user display name or null if the display name can not be obtained.
Throws:
Exception
Since:
2.5.3.0

getUserShortName

String getUserShortName()
                        throws Exception
get the user short name.

Returns:
String the user short name or null if the short name can not be obtained.
Throws:
Exception
Since:
2.5.3.0

getUserEmailAdress

String getUserEmailAdress()
                          throws Exception
get the user eMail Address

Returns:
String user eMail
Throws:
Exception

getUserID

String getUserID()
get the user unique persistent ID, which does not change even when name changes

Returns:
String unique persistent ID

getRoleNames

Collection getRoleNames()
                        throws Exception
get a string list of role names for this user

Returns:
java.util.List of string role names
Throws:
Exception

getGroups

Collection getGroups()
                     throws Exception
get a list with group information the user is assigned to

Returns:
java.util.List of OwUserInfo
Throws:
Exception

isGroup

boolean isGroup()
                throws Exception
flag indication, that user info actually designates a group rather than a single user

Returns:
true = group otherwise user
Throws:
Exception


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.