org.ovirt.engine.sdk.decorators

Class UserRolePermits

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

org.ovirt.engine.sdk.common.CollectionDecorator<Permit,Permits,UserRolePermit>

org.ovirt.engine.sdk.decorators.UserRolePermits

public class UserRolePermits
extends CollectionDecorator<Permit,Permits,UserRolePermit>

UserRolePermits providing relation and functional services

to Permits.

Constructor Summary

Constructors

Constructor and Description
UserRolePermits(HttpProxyBroker proxy, UserRole parent)

Method Summary

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

UserRolePermits

public UserRolePermits(HttpProxyBroker proxy,
                       UserRole parent)

Parameters:

proxy - HttpProxyBroker

parent - UserRole

Method Detail

list

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

Lists UserRolePermit objects.

Specified by:

list in class CollectionDecorator<Permit,Permits,UserRolePermit>

Returns:

List of UserRolePermit

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

Fetches UserRolePermit object by id.

Specified by:

get in class CollectionDecorator<Permit,Permits,UserRolePermit>

Parameters:

id - entity id

Returns:

UserRolePermit

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

Fetches UserRolePermit object by id.

Specified by:

getById in class CollectionDecorator<Permit,Permits,UserRolePermit>

Parameters:

id - entity id

Returns:

UserRolePermit

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

Lists UserRolePermit objects.

Parameters:

max -

    [max results]
    

Returns:

List of UserRolePermit

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 UserRolePermit add(Permit permit)
                   throws org.apache.http.client.ClientProtocolException,
                          ServerException,
                          IOException

Adds Permit object.

Parameters:

permit - Permit

    permit.id|name
    

Returns:

UserRolePermit

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 UserRolePermit add(Permit permit,
                          String expect)
                   throws org.apache.http.client.ClientProtocolException,
                          ServerException,
                          IOException

Adds Permit object.

Parameters:

permit - Permit

    permit.id|name
    

expect -

    [201-created]
    

Returns:

UserRolePermit

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

Adds Permit object.

Parameters:

permit - Permit

    permit.id|name
    

expect -

    [201-created]
    

correlationId -

    [any string]
    

Returns:

UserRolePermit

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.