Package de.espirit.firstspirit.service.permission.groups

Interface GroupRoot

All Superinterfaces:

Group

public interface GroupRoot
extends Group

Interface representing a group root model belonging to the groups.xml file specified by the param (DOCUMENT_NAME.path) in service.ini of permission service. This interfaces provides methods to access and modify groups of this group root.

Since:

3.1.170

Method Summary

Modifier and Type	Method	Description
@Nullable Group	getGroupById(String id)	Returns the first occurrence of a group with the given id or null if no group exists with the given id.
@Nullable Users	getUsers()	Returns the users model object if defined for this
void	save()	Saves this group root model to the belonging xml file

Methods inherited from interface de.espirit.firstspirit.service.permission.groups.Group

appendChild, appendChild, clearChildren, getAllChildren, getAllChilds, getAllParents, getChildren, getId, getLevel, getName, getParent, hasId, isSelectable, removeChild, removeId, setId, setName, setSelectable

Method Details

save

void save()
   throws IOException

Saves this group root model to the belonging xml file

Throws:

IOException

Since:

3.1.170

getGroupById

@Nullable
@Nullable Group getGroupById(String id)

Returns the first occurrence of a group with the given id or null if no group exists with the given id.

Parameters:

id - the id to specify the group

Returns:

the group specified by the given id or null

Since:

3.1.170

getUsers

@Nullable
@Nullable Users getUsers()

Returns the users model object if defined for this

Since:

3.1.170