org.ovirt.engine.sdk.decorators

Class Roles

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

org.ovirt.engine.sdk.common.CollectionDecorator<Role,Roles,Role>

org.ovirt.engine.sdk.decorators.Roles

public class Roles
extends CollectionDecorator<Role,Roles,Role>

Roles providing relation and functional services

to Roles.

Constructor Summary

Constructors

Constructor and Description
Roles(HttpProxyBroker proxy)

Method Summary

Modifier and Type	Method and Description
Role	add(Role role) Adds Role object.
Role	add(Role role, String expect) Adds Role object.
Role	add(Role role, String expect, String correlationId) Adds Role object.
Role	get(UUID id) Fetches Role object by id.
Role	getById(String id) Fetches Role object by id.
List<Role>	list() Lists Role objects.
List<Role>	list(Integer max) Lists Role objects.

Methods inherited from class org.ovirt.engine.sdk.common.CollectionDecorator

get

Methods inherited from class java.lang.Object

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

Constructor Detail

Roles

public Roles(HttpProxyBroker proxy)

Parameters:

proxy - HttpProxyBroker

Method Detail

list

public List<Role> list()
                throws org.apache.http.client.ClientProtocolException,
                       ServerException,
                       IOException

Lists Role objects.

Specified by:

list in class CollectionDecorator<Role,Roles,Role>

Returns:

List of Role

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

get

public Role get(UUID id)
         throws org.apache.http.client.ClientProtocolException,
                ServerException,
                IOException

Fetches Role object by id.

Specified by:

get in class CollectionDecorator<Role,Roles,Role>

Parameters:

id - entity id

Returns:

Role

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

getById

public Role getById(String id)
             throws org.apache.http.client.ClientProtocolException,
                    ServerException,
                    IOException

Fetches Role object by id.

Specified by:

getById in class CollectionDecorator<Role,Roles,Role>

Parameters:

id - entity id

Returns:

Role

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

list

public List<Role> list(Integer max)
                throws org.apache.http.client.ClientProtocolException,
                       ServerException,
                       IOException

Lists Role objects.

Parameters:

max -

    [max results]
    

Returns:

List of Role

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

add

public Role add(Role role)
         throws org.apache.http.client.ClientProtocolException,
                ServerException,
                IOException

Adds Role object.

Parameters:

role - Role

    role.name
    role.permits.permit
    [role.description]
    [role.administrative]
    

Returns:

Role

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

add

public Role add(Role role,
                String expect)
         throws org.apache.http.client.ClientProtocolException,
                ServerException,
                IOException

Adds Role object.

Parameters:

role - Role

    role.name
    role.permits.permit
    [role.description]
    [role.administrative]
    

expect -

    [201-created]
    

Returns:

Role

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.

add

public Role add(Role role,
                String expect,
                String correlationId)
         throws org.apache.http.client.ClientProtocolException,
                ServerException,
                IOException

Adds Role object.

Parameters:

role - Role

    role.name
    role.permits.permit
    [role.description]
    [role.administrative]
    

expect -

    [201-created]
    

correlationId -

    [any string]
    

Returns:

Role

Throws:

org.apache.http.client.ClientProtocolException - Signals that HTTP/S protocol error has occurred.

ServerException - Signals that an oVirt api error has occurred.

IOException - Signals that an I/O exception of some sort has occurred.