org.bonitasoft.engine.identity

Interface UserMembership

All Superinterfaces:

BonitaObject, Serializable

All Known Implementing Classes:

UserMembershipImpl

public interface UserMembership
extends BonitaObject

represents a relation between User and Role and Group inside the organization.

A User can be associated with a Group or a Role or both. If a User is associated with a Group only, the Role methods of this class will return null or 0. If a user is associated with a Role only, the Group methods of this class will return null or 0.

Since:

6.0.0

Author:

Bole Zhang, Matthieu Chaffotte

See Also:

Group, Role, User

Method Summary

Modifier and Type	Method and Description
long	getAssignedBy()
String	getAssignedByName()
Date	getAssignedDate()
long	getGroupId()
String	getGroupName()
String	getGroupParentPath()
long	getId()
long	getRoleId()
String	getRoleName()
long	getUserId()
String	getUsername()

Method Detail

getId

long getId()

Returns:

the user membership's id

getUserId

long getUserId()

Returns:

the user membership's user id

getRoleId

long getRoleId()

Returns:

the user membership's role id or 0 if the membership is not linked to a Role

getGroupId

long getGroupId()

Returns:

the user membership's group id or 0 if the membership is not linked to a Group

getAssignedBy

long getAssignedBy()

Returns:

the id of the user that assigned this user membership

getAssignedDate

Date getAssignedDate()

Returns:

the date this membership was assigned

getGroupName

String getGroupName()

Returns:

the user membership's group name or null if the membership is not linked to a Group

getRoleName

String getRoleName()

Returns:

the user membership's role name or null if the membership is not linked to a Group

getUsername

String getUsername()

Returns:

the username of the user that is assigned this membership

getAssignedByName

String getAssignedByName()

Returns:

the name of the user that created this membership

getGroupParentPath

String getGroupParentPath()

Returns:

the user membership's parent group path if any