jetbrains.buildServer.serverSide.auth
Interface Role

public interface Role

Presents user role in TeamCity.

Method Summary

void	addIncludedRole(Role includedRole) Includes includedRole to the role
void	addPermissions(Permission... permissions) Adds permissions to the role
java.lang.String	getId() Returns id of the role
Role[]	getIncludedRoles() Returns roles which are included in this role
java.lang.String	getName() Returns name of the role
Permissions	getOwnPermissions() Return only own permissions of the role without inherited permissions
Permissions	getPermissions() Returns permissions of the role
boolean	isProjectAssociationSupported() Returns true if this role can be associated with a particular project.
void	removeIncludedRole(Role includedRole) Excludes includedRole from the role
void	removePermission(Permission permission) Removes permission from the role

Method Detail

getId

@NotNull
java.lang.String getId()

Returns id of the role

Returns:

id of the role

getName

@NotNull
java.lang.String getName()

Returns name of the role

Returns:

name of the role

getPermissions

@NotNull
Permissions getPermissions()

Returns permissions of the role

Returns:

permissions of the role

getOwnPermissions

@NotNull
Permissions getOwnPermissions()

Return only own permissions of the role without inherited permissions

Returns:

own permissions of the role

getIncludedRoles

@NotNull
Role[] getIncludedRoles()

Returns roles which are included in this role

Returns:

included roles

isProjectAssociationSupported

boolean isProjectAssociationSupported()

Returns true if this role can be associated with a particular project. This means that this role contains at least one permission that can be associated with a project.

Returns:

true if this role can be associated with a project

addPermissions

void addPermissions(@NotNull
                    Permission... permissions)

Adds permissions to the role

Parameters:

permissions - permissions

removePermission

void removePermission(@NotNull
                      Permission permission)

Removes permission from the role

Parameters:

permission - permission

addIncludedRole

void addIncludedRole(@NotNull
                     Role includedRole)

Includes includedRole to the role

Parameters:

includedRole - role to include

removeIncludedRole

void removeIncludedRole(@NotNull
                        Role includedRole)

Excludes includedRole from the role

Parameters:

includedRole - role to include