Class AnyGroup
java.lang.Object
eu.c6.gibraltar.api.common.CObject
eu.c6.gibraltar.api.managers.groups.AnyGroup
- All Implemented Interfaces:
ICObject,IAnyGroup,IApiGroupConstants,Serializable,Cloneable
The Class AnyGroup used to get, create or update groups.
- See Also:
-
Field Summary
Fields inherited from interface eu.c6.gibraltar.api.managers.groups.IApiGroupConstants
APPLICATIONS, DESCRIPTION, GROUPS, ID, MEMBERS, ROLES, USERSFields inherited from interface eu.c6.gibraltar.api.common.ICObject
CHARSET, FIELD_SEPARATOR_DOT, FIELD_SEPARATOR_PATH -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanList of applications assigned to this group is set.booleanDescription of group is set.booleanList of groups included in this group is set.booleanList of members included in this group is set.booleanList of group roles is set.booleanList of users included in this group is set.Gets the applications.Gets the description.Gets the groups included in this group.getId()Gets the id (group name).Gets the members.getRoles()Gets the list of roles.getUsers()Gets the users.voidsetApplications(List<String> applications) Sets the application names assigned to the group.voidsetDescription(String description) Sets the description.voidSets the groups included in this group.voidSets the id (group name).voidsetMembers(List<String> members) Sets the members list.voidSets the list of roles.voidSets the users.Methods inherited from class eu.c6.gibraltar.api.common.CObject
addIntoList, addValueIntoList, buildPath, clearList, clone, clone, clone, contains, containsField, convertFieldNameToJsonPath, convertJsonPathToFieldName, equals, get, getBoolean, getBoolean, getDate, getDate, getDouble, getDouble, getFieldNames, getFieldNamesFlattenList, getFieldNamesList, getInputStream, getInt, getInt, getList, getListNestedObject, getListNestedObject, getListNestedObject, getListNestedObjectByAttribute, getListNestedObjectByAttribute, getListSize, getListString, getLocalDateTime, getLocalDateTime, getLong, getLong, getNestedObject, getNestedObject, getNestedObject, getNestedObjectNamesList, getOutputStream, getReader, getString, getString, insertIntoList, isBoolean, isDate, isDateList, isDouble, isEmpty, isFieldEmpty, isInt, isJSONValid, isList, isNestedObject, isNestedObjectList, isString, load, load, merge, mergeDeep, parse, remove, removeFromList, removeValueFromList, replaceIntoList, resetField, set, set, set, set, set, set, set, set, set, setList, setNull, textValue, toFlattenMapValues, toJson, toMap, toString, toString
-
Constructor Details
-
AnyGroup
public AnyGroup()Instantiates a new any group.Once created you must set at least the group identifier.
-
AnyGroup
Instantiates a new any group using field values of object parameter.Used fields are :
- Parameters:
object- the object- See Also:
-
AnyGroup
public AnyGroup(com.fasterxml.jackson.databind.JsonNode jsonNode) Instantiates a new any group using field values of JSON object.Used fields are :
- Parameters:
jsonNode- the JSON object- See Also:
-
-
Method Details
-
getId
Description copied from interface:IAnyGroupGets the id (group name). -
setId
Description copied from interface:IAnyGroupSets the id (group name).Group identifier is required and must be only composed with lower case characters, underscore and number. Group identifier maximum length is 128 characters.
-
containsDescription
public boolean containsDescription()Description copied from interface:IAnyGroupDescription of group is set.- Specified by:
containsDescriptionin interfaceIAnyGroup- Returns:
- true, if group description is set.
-
getDescription
Description copied from interface:IAnyGroupGets the description.- Specified by:
getDescriptionin interfaceIAnyGroup- Returns:
- the description
-
setDescription
Description copied from interface:IAnyGroupSets the description.- Specified by:
setDescriptionin interfaceIAnyGroup- Parameters:
description- the new description
-
containsApplications
public boolean containsApplications()Description copied from interface:IAnyGroupList of applications assigned to this group is set.- Specified by:
containsApplicationsin interfaceIAnyGroup- Returns:
- true, if group applications is set.
-
getApplications
Description copied from interface:IAnyGroupGets the applications.- Specified by:
getApplicationsin interfaceIAnyGroup- Returns:
- the application names
-
setApplications
Description copied from interface:IAnyGroupSets the application names assigned to the group.- Specified by:
setApplicationsin interfaceIAnyGroup- Parameters:
applications- the new applications
-
containsRoles
public boolean containsRoles()Description copied from interface:IAnyGroupList of group roles is set.- Specified by:
containsRolesin interfaceIAnyGroup- Returns:
- true, if any group role is set.
-
getRoles
Description copied from interface:IAnyGroupGets the list of roles. -
setRoles
Description copied from interface:IAnyGroupSets the list of roles. -
containsGroups
public boolean containsGroups()Description copied from interface:IAnyGroupList of groups included in this group is set.- Specified by:
containsGroupsin interfaceIAnyGroup- Returns:
- true, if list of groups included is set
-
getGroups
Description copied from interface:IAnyGroupGets the groups included in this group. -
setGroups
Description copied from interface:IAnyGroupSets the groups included in this group.If you use this method you cannot use
IAnyGroup.setMembers(List). -
containsMembers
public boolean containsMembers()Description copied from interface:IAnyGroupList of members included in this group is set.Members list is a mixed list of users and groups. If you use this method you cannot use
IAnyGroup.containsUsers()orIAnyGroup.containsGroups()- Specified by:
containsMembersin interfaceIAnyGroup- Returns:
- true, if members in this group is set
-
getMembers
Description copied from interface:IAnyGroupGets the members. A member can be a user or a group.Members list is a mixed list of users and groups. If you use this method you cannot use
IAnyGroup.getUsers()orIAnyGroup.getGroups()- Specified by:
getMembersin interfaceIAnyGroup- Returns:
- the members
-
setMembers
Description copied from interface:IAnyGroupSets the members list.A member can be a user or a group. If you use this method you cannot use
IAnyGroup.setUsers(List)orIAnyGroup.setGroups(List).- Specified by:
setMembersin interfaceIAnyGroup- Parameters:
members- the new members
-
containsUsers
public boolean containsUsers()Description copied from interface:IAnyGroupList of users included in this group is set.- Specified by:
containsUsersin interfaceIAnyGroup- Returns:
- true, if list of users is set
-
getUsers
Description copied from interface:IAnyGroupGets the users. -
setUsers
Description copied from interface:IAnyGroupSets the users. If you use this method you cannot useIAnyGroup.setMembers(List).
-