AuthenticationService  v0.2.0
Public Member Functions | Public Attributes | Properties | List of all members
Joutsen.AuthenticationService.UserModification Class Reference

A class representing the json data structure to modify a user. More...

Public Member Functions

 UserModification (String username, bool? active=null, String newUsername=null)
 Creates a new instance. More...
 
ErrorMessage Validate ()
 Validates the state of the model. More...
 

Public Attributes

const String VALIDATION_ERROR_MESSAGE = "The newUsername or active is required and cannnot be empty or consist only of whitespaces."
 

Properties

bool IsActive [get]
 THe new active state of the user. More...
 
String Username [get]
 The name identifying the user. More...
 
String NewUsername [get]
 The name the username is changed to. More...
 

Detailed Description

A class representing the json data structure to modify a user.

Since
0.2.0

Constructor & Destructor Documentation

◆ UserModification()

Joutsen.AuthenticationService.UserModification.UserModification ( String  username,
bool?  active = null,
String  newUsername = null 
)

Creates a new instance.

Member Function Documentation

◆ Validate()

ErrorMessage Joutsen.AuthenticationService.UserModification.Validate ( )

Validates the state of the model.

Implements Joutsen.AuthenticationService.ValidatableModel.

Member Data Documentation

◆ VALIDATION_ERROR_MESSAGE

const String Joutsen.AuthenticationService.UserModification.VALIDATION_ERROR_MESSAGE = "The newUsername or active is required and cannnot be empty or consist only of whitespaces."

Property Documentation

◆ IsActive

bool Joutsen.AuthenticationService.UserModification.IsActive
get

THe new active state of the user.

◆ NewUsername

String Joutsen.AuthenticationService.UserModification.NewUsername
get

The name the username is changed to.

◆ Username

String Joutsen.AuthenticationService.UserModification.Username
get

The name identifying the user.