Package overit.geocall.basic.bl.usertype

Class BOUserType

java.lang.Object

overit.geocall.model.DynO

overit.geocall.basic.bl.usertype.BOUserType

All Implemented Interfaces:

ConstraintValidator<DynO.Valid,DynO>, Serializable, overit.geocall.timezone.model.TimeZoned

@EntityRef(UserTypeEntity.class)
public class BOUserType
extends DynO

This class represent a business object for all information concerning a user's type.
It will be used to map data from a DTO to fields of the TUSER table in the database.

Since:

9.1

See Also:

• Serialized Form

GCApi:

bo

Nested Class Summary

Nested classes/interfaces inherited from class overit.geocall.model.DynO

DynO.SpanFields, DynO.SpanTable, DynO.Valid

Constructor Summary

Constructors

Constructor	Description
BOUserType()

Method Summary

Modifier and Type	Method	Description
void	addFunction(String function)	Add a permission's function to the current set.
final String	getCode()	Gets the code for the user's type.
final LocalizedString	getDescription()	Gets the user's type description.
final Long	getFactory()	Gets the user type's factory.
final Set<String>	getFunctions()	Gets the user's type permissions.
final Long	getId()	Gets the user's id.
final Boolean	getIsActive()	Deprecated, for removal: This API element is subject to removal in a future version. use isActive() Gets if the user type is active or not.
final Boolean	getIsCompanyAdmin()	Deprecated, for removal: This API element is subject to removal in a future version. use isCompanyAdmin() Gets if the user's type is a tenant admin or not.
final Boolean	getIsSuper()	Deprecated, for removal: This API element is subject to removal in a future version. use isSuper() Gets if the user's type is a system admin or not.
final Long	getMaxInactiveInterval()	Gets the user's type max inactive interval.
final Long	getOrdering()	Gets the user's type ordering.
final Long	getProfile()	Gets the profile's id.
final String	getRsAuth()	Gets the user type's resources authorization policy.
final Boolean	isActive()	Gets if the user type is active or not.
final Boolean	isCompanyAdmin()	Deprecated, for removal: This API element is subject to removal in a future version. Use isTenantAdmin() instead
final Boolean	isSuper()	Deprecated, for removal: This API element is subject to removal in a future version. Use isSystemAdmin() instead
final Boolean	isSystemAdmin()	Gets if the user's type is a system admin or not.
final Boolean	isTenantAdmin()	Gets if the user's type is a tenant admin or not.
final void	setActive(Boolean isActive)	Sets if the user is active or not.
final void	setCode(String code)	Sets the user's type code.
final void	setCompanyAdmin(Boolean isCompanyAdmin)	Deprecated, for removal: This API element is subject to removal in a future version. Use setTenantAdmin(Boolean) instead
final void	setDescription(LocalizedString description)	Sets the user's type description.
final void	setFactory(Long factory)	Sets the user type's factory.
final void	setFunctions(Set<String> functions)	Sets the user's type permissions.
final void	setId(Long id)	Sets the user's id.
final void	setIsActive(Boolean isActive)	Deprecated, for removal: This API element is subject to removal in a future version. use setActive(Boolean) Sets if the user is active or not.
final void	setIsCompanyAdmin(Boolean isCompanyAdmin)	Deprecated, for removal: This API element is subject to removal in a future version. use setCompanyAdmin(Boolean) Sets if the user's type is a tenant admin or not.
final void	setIsSuper(Boolean isSuper)	Deprecated, for removal: This API element is subject to removal in a future version. use setSuper(Boolean) Sets if the user's type is a system admin or not.
final void	setMaxInactiveInterval(Long maxInactiveInterval)	Sets the user's type max inactive interval.
final void	setOrdering(Long ordering)	Sets the user's type ordering.
final void	setProfile(Long profile)	Sets the profile's id.
final void	setRsAuth(String rsAuth)	Sets the user type's resources authorization policy.
final void	setSuper(Boolean isSuper)	Deprecated, for removal: This API element is subject to removal in a future version. Use setSystemAdmin(Boolean) instead
final void	setSystemAdmin(Boolean systemAdmin)	Sets if the user's type is a system admin or not.
final void	setTenantAdmin(Boolean tenantAdmin)	Sets if the user's type is a tenant admin or not.

Methods inherited from class overit.geocall.model.DynO

addExtension, extract, extract, fields, from, from, getCriteria, getCriteriaNotExploded, getExtension, getFakeFilter, getUnknownAttributes, getUnknownCriteria, getVariant, getZone, insert, insert, isValid, make, removeCriteria, removeExtensionAttribute, setCriteria, setCriteriaNotExploded, setExtension, setFakeFilter, setUnknownAttributes, setUnknownCriteria, setVariant, setZone, toFlatMap, toFlatMap, toMap, toMap, toString, update, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface jakarta.validation.ConstraintValidator

initialize

Methods inherited from interface overit.geocall.timezone.model.TimeZoned

hasZone

Constructor Details

BOUserType

public BOUserType()

Method Details

getId

public final Long getId()

Gets the user's id.

Returns:

The user's id.

setId

public final void setId(Long id)

Sets the user's id.

Parameters:

id - The user's id to set.

getFactory

public final Long getFactory()

Gets the user type's factory.

Returns:

The user type's factory.

setFactory

public final void setFactory(Long factory)

Sets the user type's factory.

Parameters:

factory - The user type's factory to set.

getDescription

public final LocalizedString getDescription()

Gets the user's type description.

Returns:

The user's type description.

setDescription

public final void setDescription(LocalizedString description)

Sets the user's type description.

Parameters:

description - The user's type description to set.

getOrdering

public final Long getOrdering()

Gets the user's type ordering.

Returns:

The user's type ordering.

setOrdering

public final void setOrdering(Long ordering)

Sets the user's type ordering.

Parameters:

ordering - The user's type ordering to set.

getMaxInactiveInterval

public final Long getMaxInactiveInterval()

Gets the user's type max inactive interval.

Returns:

The user's type max inactive interval.

setMaxInactiveInterval

public final void setMaxInactiveInterval(Long maxInactiveInterval)

Sets the user's type max inactive interval.

Parameters:

maxInactiveInterval - The user's type max inactive interval to set.

getIsActive

@Deprecated(forRemoval=true)
public final Boolean getIsActive()

Deprecated, for removal: This API element is subject to removal in a future version.

use isActive() Gets if the user type is active or not.

Returns:

If the user is active or not.

setIsActive

@Deprecated(forRemoval=true)
public final void setIsActive(Boolean isActive)

Deprecated, for removal: This API element is subject to removal in a future version.

use setActive(Boolean) Sets if the user is active or not.

Parameters:

isActive - true if the user is active, false otherwise.

isActive

public final Boolean isActive()

Gets if the user type is active or not.

Returns:

If the user is active or not.

setActive

public final void setActive(Boolean isActive)

Sets if the user is active or not.

Parameters:

isActive - true if the user is active, false otherwise.

getCode

public final String getCode()

Gets the code for the user's type.

Returns:

The code for the user's type.

setCode

public final void setCode(String code)

Sets the user's type code.

Parameters:

code - The user's type code to set.

getRsAuth

public final String getRsAuth()

Gets the user type's resources authorization policy.

Returns:

The user type's resources authorization policy.

setRsAuth

public final void setRsAuth(String rsAuth)

Sets the user type's resources authorization policy.

Parameters:

rsAuth - The user type's resources authorization policy to set.

getIsSuper

@Deprecated(forRemoval=true)
public final Boolean getIsSuper()

Deprecated, for removal: This API element is subject to removal in a future version.

use isSuper() Gets if the user's type is a system admin or not.

Returns:

If the user's type is a system admin or not.

setIsSuper

@Deprecated(forRemoval=true)
public final void setIsSuper(Boolean isSuper)

Deprecated, for removal: This API element is subject to removal in a future version.

use setSuper(Boolean) Sets if the user's type is a system admin or not.

Parameters:

isSuper - true if the user's type is a system admin, false otherwise.

isSuper

@Deprecated(since="12.0",
            forRemoval=true)
public final Boolean isSuper()

Deprecated, for removal: This API element is subject to removal in a future version.

Use isSystemAdmin() instead

Gets if the user's type is a system admin or not.

Returns:

If the user's type is a system admin or not.

setSuper

@Deprecated(since="12.0",
            forRemoval=true)
public final void setSuper(Boolean isSuper)

Deprecated, for removal: This API element is subject to removal in a future version.

Use setSystemAdmin(Boolean) instead

Sets if the user's type is a system admin or not.

Parameters:

isSuper - true if the user's type is a system admin, false otherwise.

isSystemAdmin

public final Boolean isSystemAdmin()

Gets if the user's type is a system admin or not.

Returns:

If the user's type is a system admin or not.

setSystemAdmin

public final void setSystemAdmin(Boolean systemAdmin)

Sets if the user's type is a system admin or not.

Parameters:

systemAdmin - true if the user's type is a system admin, false otherwise.

getIsCompanyAdmin

@Deprecated(forRemoval=true)
public final Boolean getIsCompanyAdmin()

Deprecated, for removal: This API element is subject to removal in a future version.

use isCompanyAdmin() Gets if the user's type is a tenant admin or not.

Returns:

If the user's type is a tenant admin or not.

setIsCompanyAdmin

@Deprecated(forRemoval=true)
public final void setIsCompanyAdmin(Boolean isCompanyAdmin)

Deprecated, for removal: This API element is subject to removal in a future version.

use setCompanyAdmin(Boolean) Sets if the user's type is a tenant admin or not.

Parameters:

isCompanyAdmin - true if the user's type is a tenant admin, false otherwise.

isCompanyAdmin

@Deprecated(since="12.0",
            forRemoval=true)
public final Boolean isCompanyAdmin()

Deprecated, for removal: This API element is subject to removal in a future version.

Use isTenantAdmin() instead

Gets if the user's type is a tenant admin or not.

Returns:

If the user's type is a tenant admin or not.

setCompanyAdmin

@Deprecated(since="12.0",
            forRemoval=true)
public final void setCompanyAdmin(Boolean isCompanyAdmin)

Deprecated, for removal: This API element is subject to removal in a future version.

Use setTenantAdmin(Boolean) instead

Sets if the user's type is a tenant admin or not.

Parameters:

isCompanyAdmin - true if the user's type is a tenant admin, false otherwise.

isTenantAdmin

public final Boolean isTenantAdmin()

Gets if the user's type is a tenant admin or not.

Returns:

If the user's type is a tenant admin or not.

setTenantAdmin

public final void setTenantAdmin(Boolean tenantAdmin)

Sets if the user's type is a tenant admin or not.

Parameters:

tenantAdmin - true if the user's type is a tenant admin, false otherwise.

getFunctions

public final Set<String> getFunctions()

Gets the user's type permissions.

Returns:

The user's type permissions.

setFunctions

public final void setFunctions(Set<String> functions)

Sets the user's type permissions.

Parameters:

functions - List of persmissions to set.

addFunction

public void addFunction(String function)

Add a permission's function to the current set.

Parameters:

function - the function that will be added

Throws:

NullPointerException - if the specified element is null

getProfile

public final Long getProfile()

Gets the profile's id.

Returns:

profile's id.

setProfile

public final void setProfile(Long profile)

Sets the profile's id.

Parameters:

profile - The profile's id to set.