|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface User
The User represents a snapshot of the user state.
It contains general user information, as well as information regarding the
permissions () the user currently have.Grant
The User instance can be modified and used to update the user's information.
| Method Summary | |
|---|---|
void |
addGrant(ModelParticipantInfo participant)
Marks that grants for this participant should be added to all model versions. |
void |
addGrant(String id)
Deprecated. Please use addGrant(ModelParticipantInfo participant) instead |
String |
getAccount()
Retrieves the account (login name) of the user. |
List<Grant> |
getAllGrants()
Returns all the grants (permissions) given to the user. |
List<UserGroup> |
getAllGroups()
Lists all user groups this user is a member of. |
Map<String,Object> |
getAllProperties()
Retrieves all user custom properties. |
String |
getDescription()
Retrieves this user description. |
UserDetailsLevel |
getDetailsLevel()
Retrieves the level of details for user. |
String |
getEMail()
Retrieves the email address of the user. |
String |
getFirstName()
Retrieves the first name of the user. |
String |
getLastName()
Retrieves the last name (family name) of the user. |
PermissionState |
getPermission(String permissionId)
Returns the permission state of the given permission id for the user. |
Date |
getPreviousLoginTime()
Returns the date of the previous login. |
Serializable |
getProperty(String name)
Retrieves a custom property value for user. |
Integer |
getQualityAssuranceProbability()
Get the probability for this user |
UserRealm |
getRealm()
Retrieves the realm of the user. |
String |
getRealmId()
Deprecated. Use getRealm().getId(); |
long |
getRealmOID()
Deprecated. Use getRealm().getOID(); |
Date |
getValidFrom()
Retrieves the date from which this user is valid. |
Date |
getValidTo()
Retrieves the date until this user is valid. |
boolean |
isAdministrator()
Returns if user is admin. |
boolean |
isPasswordExpired()
Checks if user password expired. |
void |
joinGroup(String id)
Marks this user's desire to join the user group identified by the given id. |
void |
leaveGroup(String id)
Marks this user's desire to leave the user group identified by the given id. |
void |
removeAllGrants()
Removes all user grants. |
void |
removeGrant(ModelParticipantInfo participant)
Marks the grants for this participant to be removed from all model versions. |
void |
removeGrant(String id)
Deprecated. Please use removeGrant(ModelParticipantInfo participant) instead |
void |
setAccount(String account)
Sets the account name of the user. |
void |
setAllProperties(Map<String,Object> properties)
Sets all the custom properties of the user. |
void |
setDescription(String description)
Sets the description of the user. |
void |
setEMail(String eMail)
Sets the email address of the user. |
void |
setFirstName(String firstName)
Sets the first name of the user. |
void |
setLastName(String lastName)
Sets the last name (family name) of the user. |
void |
setPassword(String password)
Sets the password of the user. |
void |
setProperty(String name,
Serializable value)
Sets a custom property. |
void |
setQualityAssuranceProbability(Integer probability)
Set the probability for quality assurance. |
void |
setValidFrom(Date validFrom)
Sets the validity start date of the account. |
void |
setValidTo(Date validTo)
Sets the validity end date of the account. |
| Methods inherited from interface org.eclipse.stardust.engine.api.model.DynamicParticipant |
|---|
getPartitionId, getPartitionOID |
| Methods inherited from interface org.eclipse.stardust.engine.api.model.Participant |
|---|
getAllAttributes, getAllSuperOrganizations, getAttribute, getElementOID, getModelOID, getNamespace |
| Methods inherited from interface org.eclipse.stardust.engine.api.model.ModelElement |
|---|
getId, getName, getQualifiedId |
| Methods inherited from interface org.eclipse.stardust.engine.api.model.DynamicParticipantInfo |
|---|
getOID |
| Methods inherited from interface org.eclipse.stardust.engine.api.model.ParticipantInfo |
|---|
getId, getName, getQualifiedId |
| Method Detail |
|---|
Integer getQualityAssuranceProbability()
void setQualityAssuranceProbability(Integer probability)
throws org.eclipse.stardust.common.error.InvalidValueException
probability - The probability for the user
org.eclipse.stardust.common.error.InvalidValueExceptionboolean isAdministrator()
IllegalStateException - if details level is UserDetailsLevel.MINIMALboolean isPasswordExpired()
Date getPreviousLoginTime()
long getRealmOID()
String getRealmId()
UserRealm getRealm()
String getAccount()
ModelElement.getId().
getAccount in interface UserInfoString getFirstName()
getFirstName in interface UserInfoString getLastName()
getLastName in interface UserInfoString getEMail()
Date getValidFrom()
getValidFrom in interface DynamicParticipantDate getValidTo()
getValidTo in interface DynamicParticipantString getDescription()
getDescription in interface ModelElementSerializable getProperty(String name)
name - the property name.
Map<String,Object> getAllProperties()
UserDetailsLevel getDetailsLevel()
void setPassword(String password)
password - the new password.UserService.modifyUser(org.eclipse.stardust.engine.api.runtime.User)void setAccount(String account)
account - the new account nameUserService.modifyUser(org.eclipse.stardust.engine.api.runtime.User)void setDescription(String description)
description - the user description.UserService.modifyUser(org.eclipse.stardust.engine.api.runtime.User)void setEMail(String eMail)
eMail - the new email address.UserService.modifyUser(org.eclipse.stardust.engine.api.runtime.User)void setFirstName(String firstName)
firstName - the new first name of the user.UserService.modifyUser(org.eclipse.stardust.engine.api.runtime.User)void setLastName(String lastName)
lastName - the user last name.UserService.modifyUser(org.eclipse.stardust.engine.api.runtime.User)void setValidFrom(Date validFrom)
validFrom - the validity start date, or null if unlimited.UserService.modifyUser(org.eclipse.stardust.engine.api.runtime.User)void setValidTo(Date validTo)
validTo - the validity end date, or null if unlimited.UserService.modifyUser(org.eclipse.stardust.engine.api.runtime.User)
void setProperty(String name,
Serializable value)
name - the name of the property.value - the value of the property.void setAllProperties(Map<String,Object> properties)
properties - a Map containing name-value pair of custom properties.UserService.modifyUser(org.eclipse.stardust.engine.api.runtime.User)List<Grant> getAllGrants()
Grant objects.void addGrant(String id)
addGrant(ModelParticipantInfo participant) instead
id - the ID of the participant (role or organization) in the active model.UserService.modifyUser(org.eclipse.stardust.engine.api.runtime.User),
Grantvoid addGrant(ModelParticipantInfo participant)
participant - the participants (bound or not to a department) for which the grants will be added.
org.eclipse.stardust.common.error.InvalidArgumentException - if the participant is null.void removeGrant(String id)
removeGrant(ModelParticipantInfo participant) instead
id - the ID of the participant (role or organization) in the active model.UserService.modifyUser(org.eclipse.stardust.engine.api.runtime.User),
Grantvoid removeGrant(ModelParticipantInfo participant)
participant - the participants (bound or not to a department) for which the grants will be removed.
org.eclipse.stardust.common.error.InvalidArgumentException - if the participant is null.void removeAllGrants()
UserService.modifyUser(org.eclipse.stardust.engine.api.runtime.User),
GrantList<UserGroup> getAllGroups()
UserGroup objects.void joinGroup(String id)
UserService.modifyUser(User) is invoked.
id - The id of the user group to be joined.void leaveGroup(String id)
UserService.modifyUser(User) is invoked.
id - The id of the user group to be left from.PermissionState getPermission(String permissionId)
permissionId -
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||