org.ovirt.engine.sdk.decorators

Class UserRoles

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

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

org.ovirt.engine.sdk.decorators.UserRoles

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

UserRoles providing relation and functional services

to Roles.

Constructor Summary

Constructors

Constructor and Description
UserRoles(HttpProxyBroker proxy, User parent)

Method Summary

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

UserRoles

public UserRoles(HttpProxyBroker proxy,
                 User parent)

Parameters:

proxy - HttpProxyBroker

parent - User

Method Detail

list

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

Lists UserRole objects.

Specified by:

list in class CollectionDecorator<Role,Roles,UserRole>

Returns:

List of UserRole

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 UserRole get(UUID id)
             throws org.apache.http.client.ClientProtocolException,
                    ServerException,
                    IOException

Fetches UserRole object by id.

Specified by:

get in class CollectionDecorator<Role,Roles,UserRole>

Parameters:

id - entity id

Returns:

UserRole

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 UserRole getById(String id)
                 throws org.apache.http.client.ClientProtocolException,
                        ServerException,
                        IOException

Fetches UserRole object by id.

Specified by:

getById in class CollectionDecorator<Role,Roles,UserRole>

Parameters:

id - entity id

Returns:

UserRole

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<UserRole> list(Integer max)
                    throws org.apache.http.client.ClientProtocolException,
                           ServerException,
                           IOException

Lists UserRole objects.

Parameters:

max -

    [max results]
    

Returns:

List of UserRole

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 UserRole add(Role role)
             throws org.apache.http.client.ClientProtocolException,
                    ServerException,
                    IOException

Adds Role object.

Parameters:

permit - Permit

    permit.id|name
    

Returns:

UserRole

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 UserRole add(Role role,
                    String expect)
             throws org.apache.http.client.ClientProtocolException,
                    ServerException,
                    IOException

Adds Role object.

Parameters:

permit - Permit

    permit.id|name
    

expect -

    [201-created]
    

Returns:

UserRole

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 UserRole add(Role role,
                    String expect,
                    String correlationId)
             throws org.apache.http.client.ClientProtocolException,
                    ServerException,
                    IOException

Adds Role object.

Parameters:

permit - Permit

    permit.id|name
    

expect -

    [201-created]
    

correlationId -

    [any string]
    

Returns:

UserRole

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.