ApplicationUser (Apache Isis Ext - Sec Man API 2.0.0-M4)

All Superinterfaces:: HasAtPath, org.apache.isis.applib.services.HasUsername

public interface ApplicationUser
extends org.apache.isis.applib.services.HasUsername, HasAtPath

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`ApplicationUser.ActionDomainEvent`
`static class`	`ApplicationUser.AddRoleDomainEvent`
`static class`	`ApplicationUser.CollectionDomainEvent<T>`
`static class`	`ApplicationUser.DeleteDomainEvent`
`static class`	`ApplicationUser.LockDomainEvent`
`static class`	`ApplicationUser.NewDelegateUserDomainEvent`
`static class`	`ApplicationUser.NewLocalUserDomainEvent`
`static class`	`ApplicationUser.PropertyDomainEvent<T>`
`static class`	`ApplicationUser.RemoveRoleDomainEvent`
`static class`	`ApplicationUser.ResetPasswordDomainEvent`
`static class`	`ApplicationUser.UnlockDomainEvent`
`static class`	`ApplicationUser.UpdateAccountTypeDomainEvent`
`static class`	`ApplicationUser.UpdateAtPathDomainEvent`
`static class`	`ApplicationUser.UpdateEmailAddressDomainEvent`
`static class`	`ApplicationUser.UpdateFaxNumberDomainEvent`
`static class`	`ApplicationUser.UpdateNameDomainEvent`
`static class`	`ApplicationUser.UpdatePasswordDomainEvent`
`static class`	`ApplicationUser.UpdatePhoneNumberDomainEvent`
`static class`	`ApplicationUser.UpdateUsernameDomainEvent`
`static class`	`ApplicationUser.UserDuplicateDomainEvent`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`MAX_LENGTH_EMAIL_ADDRESS`
`static int`	`MAX_LENGTH_FAMILY_NAME`
`static int`	`MAX_LENGTH_GIVEN_NAME`
`static int`	`MAX_LENGTH_KNOWN_AS`
`static int`	`MAX_LENGTH_PHONE_NUMBER`
`static int`	`MAX_LENGTH_USERNAME`

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`AccountType`	`getAccountType()`
`String`	`getEmailAddress()`
`String`	`getEncryptedPassword()`
`String`	`getFamilyName()`
`String`	`getFaxNumber()`
`String`	`getGivenName()`
`String`	`getKnownAs()`
`String`	`getName()`
`ApplicationPermissionValueSet`	`getPermissionSet()`
`String`	`getPhoneNumber()`
`SortedSet<? extends ApplicationRole>`	`getRoles()`
`ApplicationUserStatus`	`getStatus()`
`default String`	`iconName()`
`boolean`	`isForSelfOrRunAsAdministrator()`
`boolean`	`isHasPassword()`
`default boolean`	`isLocalAccount()`
`void`	`setAccountType(AccountType accountType)`
`void`	`setAtPath(String atPath)`
`void`	`setEmailAddress(String emailAddress)`
`void`	`setEncryptedPassword(String encryptedPassword)`
`void`	`setFamilyName(String familyName)`
`void`	`setFaxNumber(String faxNumber)`
`void`	`setGivenName(String givenName)`
`void`	`setKnownAs(String knownAs)`
`void`	`setPhoneNumber(String phoneNumber)`
`void`	`setStatus(ApplicationUserStatus disabled)`
`void`	`setUsername(String username)`
`default String`	`title()` having a title() method (rather than using @Title annotation) is necessary as a workaround to be able to use wrapperFactory#unwrap(...) method, which is otherwise broken in Isis 1.6.0

Methods inherited from interface org.apache.isis.applib.services.HasUsername
getUsername

Methods inherited from interface org.apache.isis.extensions.secman.api.tenancy.HasAtPath
getAtPath

Field Detail
- MAX_LENGTH_USERNAME
```
static final int MAX_LENGTH_USERNAME
```
  See Also:
  
  Constant Field Values
- MAX_LENGTH_FAMILY_NAME
```
static final int MAX_LENGTH_FAMILY_NAME
```
  See Also:
  
  Constant Field Values
- MAX_LENGTH_GIVEN_NAME
```
static final int MAX_LENGTH_GIVEN_NAME
```
  See Also:
  
  Constant Field Values
- MAX_LENGTH_KNOWN_AS
```
static final int MAX_LENGTH_KNOWN_AS
```
  See Also:
  
  Constant Field Values
- MAX_LENGTH_EMAIL_ADDRESS
```
static final int MAX_LENGTH_EMAIL_ADDRESS
```
  See Also:
  
  Constant Field Values
- MAX_LENGTH_PHONE_NUMBER
```
static final int MAX_LENGTH_PHONE_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

title
```
default String title()
```
having a title() method (rather than using @Title annotation) is necessary as a workaround to be able to use wrapperFactory#unwrap(...) method, which is otherwise broken in Isis 1.6.0

iconName
```
default String iconName()
```

getName
```
String getName()
```

getEncryptedPassword
```
String getEncryptedPassword()
```

getAccountType
```
AccountType getAccountType()
```

setAccountType

void setAccountType(AccountType accountType)

getPermissionSet

ApplicationPermissionValueSet getPermissionSet()

getRoles

SortedSet<? extends ApplicationRole> getRoles()

getStatus
```
ApplicationUserStatus getStatus()
```

setStatus

void setStatus(ApplicationUserStatus disabled)

setAtPath
```
void setAtPath(String atPath)
```

getEmailAddress
```
String getEmailAddress()
```

setEmailAddress

void setEmailAddress(String emailAddress)

getFaxNumber
```
String getFaxNumber()
```

setFaxNumber
```
void setFaxNumber(String faxNumber)
```

getFamilyName
```
String getFamilyName()
```

setFamilyName
```
void setFamilyName(String familyName)
```

getGivenName
```
String getGivenName()
```

setGivenName
```
void setGivenName(String givenName)
```

getKnownAs
```
String getKnownAs()
```

setKnownAs
```
void setKnownAs(String knownAs)
```

getPhoneNumber
```
String getPhoneNumber()
```

setPhoneNumber

void setPhoneNumber(String phoneNumber)

setUsername
```
void setUsername(String username)
```

setEncryptedPassword

void setEncryptedPassword(String encryptedPassword)

isForSelfOrRunAsAdministrator

boolean isForSelfOrRunAsAdministrator()

isHasPassword
```
boolean isHasPassword()
```

isLocalAccount
```
default boolean isLocalAccount()
```

Interface ApplicationUser

Nested Class Summary

Field Summary

Method Summary

Methods inherited from interface org.apache.isis.applib.services.HasUsername

Methods inherited from interface org.apache.isis.extensions.secman.api.tenancy.HasAtPath

Field Detail

MAX_LENGTH_USERNAME

MAX_LENGTH_FAMILY_NAME

MAX_LENGTH_GIVEN_NAME

MAX_LENGTH_KNOWN_AS

MAX_LENGTH_EMAIL_ADDRESS

MAX_LENGTH_PHONE_NUMBER

Method Detail

title

iconName

getName

getEncryptedPassword

getAccountType

setAccountType

getPermissionSet

getRoles

getStatus

setStatus

setAtPath

getEmailAddress

setEmailAddress

getFaxNumber

setFaxNumber

getFamilyName

setFamilyName

getGivenName

setGivenName

getKnownAs

setKnownAs

getPhoneNumber

setPhoneNumber

setUsername

setEncryptedPassword

isForSelfOrRunAsAdministrator

isHasPassword

isLocalAccount