org.ovirt.engine.sdk.decorators

Class GroupRoles

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

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

org.ovirt.engine.sdk.decorators.GroupRoles

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

GroupRoles providing relation and functional services

to Roles.

Constructor Summary

Constructors

Constructor and Description
GroupRoles(HttpProxyBroker proxy, Group parent)

Method Summary

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

GroupRoles

public GroupRoles(HttpProxyBroker proxy,
                  Group parent)

Parameters:

proxy - HttpProxyBroker

parent - Group

Method Detail

list

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

Lists GroupRole objects.

Specified by:

list in class CollectionDecorator<Role,Roles,GroupRole>

Returns:

List of GroupRole

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

Fetches GroupRole object by id.

Specified by:

get in class CollectionDecorator<Role,Roles,GroupRole>

Parameters:

id - entity id

Returns:

GroupRole

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

Fetches GroupRole object by id.

Specified by:

getById in class CollectionDecorator<Role,Roles,GroupRole>

Parameters:

id - entity id

Returns:

GroupRole

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

Lists GroupRole objects.

Parameters:

max -

    [max results]
    

Returns:

List of GroupRole

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

Adds Role object.

Parameters:

permit - Permit

    permit.id|name
    

Returns:

GroupRole

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

GroupRole

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

GroupRole

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.