org.ovirt.engine.sdk.decorators

Class VmPoolPermissions

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

org.ovirt.engine.sdk.common.CollectionDecorator<Permission,Permissions,VmPoolPermission>

org.ovirt.engine.sdk.decorators.VmPoolPermissions

public class VmPoolPermissions
extends CollectionDecorator<Permission,Permissions,VmPoolPermission>

VmPoolPermissions providing relation and functional services

to Permissions.

Constructor Summary

Constructors

Constructor and Description
VmPoolPermissions(HttpProxyBroker proxy, VmPool parent)

Method Summary

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

VmPoolPermissions

public VmPoolPermissions(HttpProxyBroker proxy,
                         VmPool parent)

Parameters:

proxy - HttpProxyBroker

parent - VmPool

Method Detail

list

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

Lists VmPoolPermission objects.

Specified by:

list in class CollectionDecorator<Permission,Permissions,VmPoolPermission>

Returns:

List of VmPoolPermission

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

Fetches VmPoolPermission object by id.

Specified by:

get in class CollectionDecorator<Permission,Permissions,VmPoolPermission>

Parameters:

id - entity id

Returns:

VmPoolPermission

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

Fetches VmPoolPermission object by id.

Specified by:

getById in class CollectionDecorator<Permission,Permissions,VmPoolPermission>

Parameters:

id - entity id

Returns:

VmPoolPermission

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

Lists VmPoolPermission objects.

Parameters:

max -

    [max results]
    

Returns:

List of VmPoolPermission

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 VmPoolPermission add(Permission permission)
                     throws org.apache.http.client.ClientProtocolException,
                            ServerException,
                            IOException

Adds Permission object.

Parameters:

permission - Permission

    Overload 1:

      add a new user level
      permission on the vm pool

      permission.user.id
      permission.role.id

    Overload 2:

      add a new group level
      permission on the vm pool

      permission.role.id
      permission.group.id
    

Returns:

VmPoolPermission

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 VmPoolPermission add(Permission permission,
                            String expect)
                     throws org.apache.http.client.ClientProtocolException,
                            ServerException,
                            IOException

Adds Permission object.

Parameters:

permission - Permission

    Overload 1:

      add a new user level
      permission on the vm pool

      permission.user.id
      permission.role.id

    Overload 2:

      add a new group level
      permission on the vm pool

      permission.role.id
      permission.group.id
    

expect -

    [201-created]
    

Returns:

VmPoolPermission

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

Adds Permission object.

Parameters:

permission - Permission

    Overload 1:

      add a new user level
      permission on the vm pool

      permission.user.id
      permission.role.id

    Overload 2:

      add a new group level
      permission on the vm pool

      permission.role.id
      permission.group.id
    

expect -

    [201-created]
    

correlationId -

    [any string]
    

Returns:

VmPoolPermission

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.