RoleService (oVirt Java SDK 4.4.6 API)

All Superinterfaces:

Service

All Known Implementing Classes:

RoleServiceImpl
```
public interface RoleService
extends Service
```

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static interface`	`RoleService.GetRequest`	Get the role.
`static interface`	`RoleService.GetResponse`	Get the role.
`static interface`	`RoleService.RemoveRequest`	Removes the role.
`static interface`	`RoleService.RemoveResponse`	Removes the role.
`static interface`	`RoleService.UpdateRequest`	Updates a role.
`static interface`	`RoleService.UpdateResponse`	Updates a role.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`RoleService.GetRequest`	`get()`	Get the role.
`PermitsService`	`permitsService()`	Sub-resource locator method, returns permits service.
`RoleService.RemoveRequest`	`remove()`	Removes the role.
`Service`	`service(String path)`	Service locator method, returns individual service on which the URI is dispatched.
`RoleService.UpdateRequest`	`update()`	Updates a role.

- Method Detail
  - get
```
RoleService.GetRequest get()
```
    Get the role. [source] ---- GET /ovirt-engine/api/roles/123 ---- You will receive XML response like this one: [source,xml] ---- MyRole MyRole description true false ----
  - remove
```
RoleService.RemoveRequest remove()
```
    Removes the role. To remove the role you need to know its id, then send request like this: [source] ---- DELETE /ovirt-engine/api/roles/{role_id} ----
  - update
```
RoleService.UpdateRequest update()
```
    Updates a role. You are allowed to update `name`, `description` and `administrative` attributes after role is created. Within this endpoint you can't add or remove roles permits you need to use <> that manages permits of role. For example to update role's `name`, `description` and `administrative` attributes send a request like this: [source] ---- PUT /ovirt-engine/api/roles/123 ---- With a request body like this: [source,xml] ---- MyNewRoleName My new description of the role true ----
  - permitsService
```
PermitsService permitsService()
```
    Sub-resource locator method, returns permits service.
  - service
```
Service service(String path)
```
    Service locator method, returns individual service on which the URI is dispatched.