org.ovirt.engine.sdk.decorators

Class DiskProfilePermissions

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

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

org.ovirt.engine.sdk.decorators.DiskProfilePermissions

public class DiskProfilePermissions
extends CollectionDecorator<Permission,Permissions,DiskProfilePermission>

DiskProfilePermissions providing relation and functional services

to Permissions.

Constructor Summary

Constructors

Constructor and Description
DiskProfilePermissions(HttpProxyBroker proxy, DiskProfile parent)

Method Summary

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

DiskProfilePermissions

public DiskProfilePermissions(HttpProxyBroker proxy,
                              DiskProfile parent)

Parameters:

proxy - HttpProxyBroker

parent - DiskProfile

Method Detail

list

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

Lists DiskProfilePermission objects.

Specified by:

list in class CollectionDecorator<Permission,Permissions,DiskProfilePermission>

Returns:

List of DiskProfilePermission

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

Fetches DiskProfilePermission object by id.

Specified by:

get in class CollectionDecorator<Permission,Permissions,DiskProfilePermission>

Parameters:

id - entity id

Returns:

DiskProfilePermission

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

Fetches DiskProfilePermission object by id.

Specified by:

getById in class CollectionDecorator<Permission,Permissions,DiskProfilePermission>

Parameters:

id - entity id

Returns:

DiskProfilePermission

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

Lists DiskProfilePermission objects.

Parameters:

max -

    [max results]
    

Returns:

List of DiskProfilePermission

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 DiskProfilePermission 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 disk profile
      in the system

      permission.user.id
      permission.role.id

    Overload 2:

      add a new group level
      permission on the disk profile
      in the system

      permission.group.id
      permission.role.id
    

Returns:

DiskProfilePermission

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 DiskProfilePermission 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 disk profile
      in the system

      permission.user.id
      permission.role.id

    Overload 2:

      add a new group level
      permission on the disk profile
      in the system

      permission.group.id
      permission.role.id
    

expect -

    [201-created]
    

Returns:

DiskProfilePermission

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 DiskProfilePermission 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 disk profile
      in the system

      permission.user.id
      permission.role.id

    Overload 2:

      add a new group level
      permission on the disk profile
      in the system

      permission.group.id
      permission.role.id
    

expect -

    [201-created]
    

correlationId -

    [any string]
    

Returns:

DiskProfilePermission

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.