com.gentics.contentnode.rest.model.request

Class SetPermsRequest

java.lang.Object

com.gentics.contentnode.rest.model.request.SetPermsRequest

All Implemented Interfaces:

Serializable

public class SetPermsRequest
extends Object
implements Serializable

Request to set permission bits

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	groupId ID of the group for which to set the permission
protected String	perm Permission bits and roles
protected Set<Integer>	roleIds Set of roles that should be set.
protected boolean	subGroups Set permissions also to the subgroups
protected boolean	subObjects Set permissions also to the subobjects

Constructor Summary

Constructors

Constructor and Description
SetPermsRequest() Create an empty instance

Method Summary

Modifier and Type	Method and Description
int	getGroupId() ID of the group
String	getPerm() Permission bits and roles
Set<Integer>	getRoleIds() The role IDs of roles that should be set when the request is completed.
boolean	isSubGroups() True to set permissions also to subgroups, false for only the given group
boolean	isSubObjects() True to set permissions also for subobjects, false for only the given object
SetPermsRequest	setGroupId(int groupId) Set the group ID
SetPermsRequest	setPerm(String perm) Set the permission bits and roles
SetPermsRequest	setRoleIds(Set<Integer> roleIds) Set set of role IDs to be set
SetPermsRequest	setSubGroups(boolean subGroups) Set whether to set permissions on the subgroups
SetPermsRequest	setSubObjects(boolean subObjects) Set whether to set permissions for the subobjects

Methods inherited from class java.lang.Object

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

Field Detail

perm

protected String perm

Permission bits and roles

groupId

protected int groupId

ID of the group for which to set the permission

subGroups

protected boolean subGroups

Set permissions also to the subgroups

subObjects

protected boolean subObjects

Set permissions also to the subobjects

roleIds

protected Set<Integer> roleIds

Set of roles that should be set. If null, no changes are made.

Constructor Detail

SetPermsRequest

public SetPermsRequest()

Create an empty instance

Method Detail

getPerm

public String getPerm()

Permission bits and roles

Returns:

permission bits and roles

setPerm

public SetPermsRequest setPerm(String perm)

Set the permission bits and roles

Parameters:

perm - permission bits and roles

Returns:

fluent API

getGroupId

public int getGroupId()

ID of the group

Returns:

ID of the group

setGroupId

public SetPermsRequest setGroupId(int groupId)

Set the group ID

Parameters:

groupId - group ID

Returns:

fluent API

isSubGroups

public boolean isSubGroups()

True to set permissions also to subgroups, false for only the given group

Returns:

true for subgroups, false if not

setSubGroups

public SetPermsRequest setSubGroups(boolean subGroups)

Set whether to set permissions on the subgroups

Parameters:

subGroups - true for subgroups, false if not

Returns:

fluent API

isSubObjects

public boolean isSubObjects()

True to set permissions also for subobjects, false for only the given object

Returns:

true for subobjects, false if not

setSubObjects

public SetPermsRequest setSubObjects(boolean subObjects)

Set whether to set permissions for the subobjects

Parameters:

subObjects - true for subobjects, false if not

Returns:

fluent API

getRoleIds

public Set<Integer> getRoleIds()

The role IDs of roles that should be set when the request is completed. All roles not mentioned are removed. If not set, no changes to the roles will be performed.

Returns:

the role ids

setRoleIds

public SetPermsRequest setRoleIds(Set<Integer> roleIds)

Set set of role IDs to be set

Parameters:

roleIds - Role-IDs to set or null if no change required

Returns:

fluent API