org.ovirt.engine.sdk.decorators

Class RolePermits

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

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

org.ovirt.engine.sdk.decorators.RolePermits

public class RolePermits
extends CollectionDecorator<Permit,Permits,RolePermit>

RolePermits providing relation and functional services

to Permits.

Constructor Summary

Constructors

Constructor and Description
RolePermits(HttpProxyBroker proxy, Role parent)

Method Summary

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

RolePermits

public RolePermits(HttpProxyBroker proxy,
                   Role parent)

Parameters:

proxy - HttpProxyBroker

parent - Role

Method Detail

list

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

Lists RolePermit objects.

Specified by:

list in class CollectionDecorator<Permit,Permits,RolePermit>

Returns:

List of RolePermit

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

Fetches RolePermit object by id.

Specified by:

get in class CollectionDecorator<Permit,Permits,RolePermit>

Parameters:

id - entity id

Returns:

RolePermit

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

Fetches RolePermit object by id.

Specified by:

getById in class CollectionDecorator<Permit,Permits,RolePermit>

Parameters:

id - entity id

Returns:

RolePermit

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

Lists RolePermit objects.

Parameters:

max -

    [max results]
    

Returns:

List of RolePermit

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

Adds Permit object.

Parameters:

permit - Permit

    permit.id|name
    

Returns:

RolePermit

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 RolePermit 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:

RolePermit

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 RolePermit 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:

RolePermit

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.