User (harbormaster 1.2 API)

java.lang.Object
- com.harbormaster.foundational.common.FrameworkBaseObject
- - com.harbormaster.foundational.business.bo.FrameworkHibernateBusinessObject
  - - com.harbormaster.entity.Base
    - - com.harbormaster.entity.User

All Implemented Interfaces:

IFrameworkBaseObject, Serializable
```
public class User
extends Base
```
Encapsulates the concept of data for a Harbormaster User.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`company`
`protected String`	`email`
`protected String`	`firstName`
`protected String`	`internalIdentifier`
`protected String`	`lastName`
`protected boolean`	`notifyFlag`
`protected String`	`password`
`protected String`	`userId`
`protected UserType`	`userType`

Fields inherited from class com.harbormaster.entity.Base
id

Fields inherited from class com.harbormaster.foundational.common.FrameworkBaseObject
serialVersionUID

Constructor Summary

Constructors
Constructor and Description

User()
Default Constructor

User(User object)
Constructor with a User.

Constructors
Constructor and Description
`User()` Default Constructor
`User(User object)` Constructor with a User.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`copy(User object)` Performs a deep copy.
`boolean`	`equals(Object object)` Comparison method to determine if the provided object is equivalent to this instance.
`String`	`generateInternalIdentifier()` Helper to generate the internal identifier
`String`	`getCompany()` Returns the company field.
`String`	`getEmail()` Returns the email field.
`String`	`getFirstName()` Returns the firstName field.
`String`	`getFullName()` construct full name from first and last
`String`	`getInternalIdentifier()` Returns the internalIdentifier field.
`String`	`getLastName()` Returns the lastName field.
`boolean`	`getNotifyFlag()` Returns the notifyFlag field.
`String`	`getObjectType()` Returns the type of the object
`String`	`getPassword()` Returns the password field.
`String`	`getUserId()` Returns the userId field.
`UserType`	`getUserType()` Returns the userType field.
`int`	`hashCode()`
`boolean`	`hasValidPaymentInfo()` Helper method used to determine if the user has valid payment info in place.
`void`	`setCompany(String company)` Assigns the company field with the provided argument.
`void`	`setEmail(String email)` Assigns the email field with the provided argument.
`void`	`setFirstName(String name)` Assigns the name field with the provided argument.
`void`	`setInternalIdentifier(String internalIdentifier)` Assigns the internalIdentifier field with the provided argument.
`void`	`setLastName(String name)` Assigns the lastName field with the provided argument.
`void`	`setNotifyFlag(boolean notifyFlag)` Assigns the notifyFlag with the provided argument.
`void`	`setPassword(String password)` Assigns the password field with the provided argument.
`void`	`setUserId(String userId)` Assigns the userId field with the provided argument.
`void`	`setUserType(UserType userType)` Assigns the userType with the provided argument.
`void`	`shallowCopy(User object)` Performs a shallow copy.
`String`	`toString()` Returns a string representation of the intrinsic attributes.

Methods inherited from class com.harbormaster.entity.Base
getId, getIdentity, setId

Methods inherited from class com.harbormaster.foundational.common.FrameworkBaseObject
logDebugMessage, logErrorMessage, logInfoMessage, logMessage, logWarnMessage

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - firstName
```
protected String firstName
```
  - lastName
```
protected String lastName
```
  - email
```
protected String email
```
  - company
```
protected String company
```
  - userId
```
protected String userId
```
  - password
```
protected String password
```
  - internalIdentifier
```
protected String internalIdentifier
```
  - notifyFlag
```
protected boolean notifyFlag
```
  - userType
```
protected UserType userType
```
- Constructor Detail
  - User
```
public User()
```
    Default Constructor
  - User
```
public User(User object)
```
    Constructor with a User. Internally calls copy using the provided argument.
    
    Parameters:
    
    object - source to seed from
- Method Detail
  - getFirstName
```
public String getFirstName()
```
    Returns the firstName field.
    
    Returns:
    
    first name
  - setFirstName
```
public void setFirstName(String name)
```
    Assigns the name field with the provided argument.
    
    Parameters:
    
    name - first name
  - getLastName
```
public String getLastName()
```
    Returns the lastName field.
    
    Returns:
    
    last name
  - setLastName
```
public void setLastName(String name)
```
    Assigns the lastName field with the provided argument.
    
    Parameters:
    
    name - last name
  - getFullName
```
public String getFullName()
```
    construct full name from first and last
    
    Returns:
    
    full name
  - getEmail
```
public String getEmail()
```
    Returns the email field.
    
    Returns:
    
    email
  - setEmail
```
public void setEmail(String email)
```
    Assigns the email field with the provided argument.
    
    Parameters:
    
    email - E-mail
  - getCompany
```
public String getCompany()
```
    Returns the company field.
    
    Returns:
    
    company name
  - setCompany
```
public void setCompany(String company)
```
    Assigns the company field with the provided argument.
    
    Parameters:
    
    company - name
  - getUserId
```
public String getUserId()
```
    Returns the userId field.
    
    Returns:
    
    user identfiier
  - setUserId
```
public void setUserId(String userId)
```
    Assigns the userId field with the provided argument.
    
    Parameters:
    
    userId - user identifier
  - getPassword
```
public String getPassword()
```
    Returns the password field.
    
    Returns:
    
    password
  - setPassword
```
public void setPassword(String password)
```
    Assigns the password field with the provided argument.
    
    Parameters:
    
    password - password to login to Harbormaster
  - getUserType
```
public UserType getUserType()
```
    Returns the userType field.
    
    Returns:
    
    UserType enumerator
  - setUserType
```
public void setUserType(UserType userType)
```
    Assigns the userType with the provided argument.
    
    Parameters:
    
    userType - UserType enumerator
  - getNotifyFlag
```
public boolean getNotifyFlag()
```
    Returns the notifyFlag field.
    
    Returns:
    
    notification indicator
  - setNotifyFlag
```
public void setNotifyFlag(boolean notifyFlag)
```
    Assigns the notifyFlag with the provided argument.
    
    Parameters:
    
    notifyFlag - notification indication
  - getInternalIdentifier
```
public String getInternalIdentifier()
```
    Returns the internalIdentifier field. Is a unique randomly generated identifier, separate from the id field, which likely comes from a persistence storage mechanism. Defaults to org.apache.commons.text.RandomStringGenerator.Builder().withinRange('a', 'z').build()
    
    Returns:
    
    internal identifier
  - setInternalIdentifier
```
public void setInternalIdentifier(String internalIdentifier)
```
    Assigns the internalIdentifier field with the provided argument. Is a unique randomly generated identifier, separate from the id field, which likely comes from a persistence storage mechanism. Defaults to org.apache.commons.text.RandomStringGenerator.Builder().withinRange('a', 'z').build()
    
    Parameters:
    
    internalIdentifier - internal identifier
  - shallowCopy
```
public void shallowCopy(User object)
```
    Performs a shallow copy.
    
    Parameters:
    
    object - source to copy from
  - copy
```
public void copy(User object)
```
    Performs a deep copy.
    
    Parameters:
    
    object - source to copy from
  - hasValidPaymentInfo
```
public boolean hasValidPaymentInfo()
```
    Helper method used to determine if the user has valid payment info in place. Once Billing and Payment abstractions are in place, use those here
    
    Returns:
    
    valid payment info indicator
  - toString
```
public String toString()
```
    Returns a string representation of the intrinsic attributes.
    
    Overrides:
    
    toString in class Base
    
    Returns:
    
    string representation of internal data
  - getObjectType
```
public String getObjectType()
```
    Returns the type of the object
    
    Specified by:
    
    getObjectType in class Base
    
    Returns:
    
    type this object is
  - equals
```
public boolean equals(Object object)
```
    Description copied from class: Base
    
    Comparison method to determine if the provided object is equivalent to this instance. It does so by ensuring it is non-null, of User type, and the id fields are equivalent.
    
    Overrides:
    
    equals in class Base
    
    Returns:
    
    boolean
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Base
  - generateInternalIdentifier
```
public String generateInternalIdentifier()
```
    Helper to generate the internal identifier
    
    Returns:
    
    internal identifier

Class User

Field Summary

Fields inherited from class com.harbormaster.entity.Base

Fields inherited from class com.harbormaster.foundational.common.FrameworkBaseObject

Constructor Summary

Method Summary

Methods inherited from class com.harbormaster.entity.Base

Methods inherited from class com.harbormaster.foundational.common.FrameworkBaseObject

Methods inherited from class java.lang.Object

Field Detail

firstName

lastName

email

company

userId

password

internalIdentifier

notifyFlag

userType

Constructor Detail

User

User

Method Detail

getFirstName

setFirstName

getLastName

setLastName

getFullName

getEmail

setEmail

getCompany

setCompany

getUserId

setUserId

getPassword

setPassword

getUserType

setUserType

getNotifyFlag

setNotifyFlag

getInternalIdentifier

setInternalIdentifier

shallowCopy

copy

hasValidPaymentInfo

toString

getObjectType

equals

hashCode

generateInternalIdentifier