org.openlowcode.design.module.roles

Class Group

java.lang.Object

org.openlowcode.tools.misc.Named

org.openlowcode.design.module.roles.Group

All Implemented Interfaces:

NamedInterface

public class Group
extends Named

This class allows the creation of a group for the module. It can be used in the design script of a module.

Author:

Open Lowcode SAS

Constructor Summary

Constructors

Constructor and Description
Group(java.lang.String name) creates a group with the given name (no description)
Group(java.lang.String name, java.lang.String description) creates a group with the given name and description
Group(java.lang.String name, TotalAuthority authority) creates a group, and assigns it to the total authority

Method Summary

Modifier and Type	Method and Description
int	getAuthoritiesindex()
TotalAuthority	getAuthority(int index) returns an authority assigned to this group
java.lang.String	getDescription()
int	getDomainAuthoritiesIndex()
ModuleDomainAuthority	getDomainAuthorityAt(int index) gets the domain authority at the given index
User	getMember(int index) gets the user member at the given index
int	getMemberindex() gets the number of users assigned to this group
boolean	isModuleadminismember()
void	setGroupInAuthority(TotalAuthority authority) adds the following total authority to the group
void	setGroupInDomainAuthority(ModuleDomainAuthority domainauthority) adds a domain authority to the group.
void	setModuleAdminAsMember() adds the module administrator as a member of the group

Methods inherited from class org.openlowcode.tools.misc.Named

changeName, cleanName, equals, getName

Methods inherited from class java.lang.Object

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

Constructor Detail

Group

public Group(java.lang.String name,
             java.lang.String description)

creates a group with the given name and description

Parameters:

name - a unique name of the group, should be a valid java field name

description - description of the group in plain language

Group

public Group(java.lang.String name)

creates a group with the given name (no description)

Parameters:

name - a unique name of the group, should be a valid java field name

Group

public Group(java.lang.String name,
             TotalAuthority authority)

creates a group, and assigns it to the total authority

Parameters:

name - a unique name of the group, should be a valid java field name

authority - authority that should be granted to the group

Method Detail

isModuleadminismember

public boolean isModuleadminismember()

Returns:

true if the module admin is a module of the group

getDescription

public java.lang.String getDescription()

Returns:

a plain language description of the group

setModuleAdminAsMember

public void setModuleAdminAsMember()

adds the module administrator as a member of the group

setGroupInAuthority

public void setGroupInAuthority(TotalAuthority authority)

adds the following total authority to the group

Parameters:

authority - authority to be granted to the group

setGroupInDomainAuthority

public void setGroupInDomainAuthority(ModuleDomainAuthority domainauthority)

adds a domain authority to the group. This means the group will have the authority to all the domains of the module

Parameters:

domainauthority - the domain authority to add to the group

getDomainAuthoritiesIndex

public int getDomainAuthoritiesIndex()

Returns:

the number of domain authorities granted for this group

getDomainAuthorityAt

public ModuleDomainAuthority getDomainAuthorityAt(int index)

gets the domain authority at the given index

Parameters:

index - index of the authority between 0 (included) and getDomainAuthoritiesIndex (excluded)

Returns:

the module domain authority at the given index

getAuthoritiesindex

public int getAuthoritiesindex()

Returns:

the number of total authorities granted to this group

getAuthority

public TotalAuthority getAuthority(int index)

returns an authority assigned to this group

Parameters:

index - a number between 0 (included) and getAuthoritiesindex (excluded)

Returns:

the total authority at the given index

getMemberindex

public int getMemberindex()

gets the number of users assigned to this group

Returns:

the number of users

getMember

public User getMember(int index)

gets the user member at the given index

Parameters:

index - a number between 0 (included) and getMemberindex (excluded)

Returns:

the user at the given index