org.ovirt.engine.sdk.decorators

Class TemplatePermissions

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

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

org.ovirt.engine.sdk.decorators.TemplatePermissions

public class TemplatePermissions
extends CollectionDecorator<Permission,Permissions,TemplatePermission>

TemplatePermissions providing relation and functional services

to Permissions.

Constructor Summary

Constructors

Constructor and Description
TemplatePermissions(HttpProxyBroker proxy, Template parent)

Method Summary

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

TemplatePermissions

public TemplatePermissions(HttpProxyBroker proxy,
                           Template parent)

Parameters:

proxy - HttpProxyBroker

parent - Template

Method Detail

list

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

Lists TemplatePermission objects.

Specified by:

list in class CollectionDecorator<Permission,Permissions,TemplatePermission>

Returns:

List of TemplatePermission

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

Fetches TemplatePermission object by id.

Specified by:

get in class CollectionDecorator<Permission,Permissions,TemplatePermission>

Parameters:

id - entity id

Returns:

TemplatePermission

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

Fetches TemplatePermission object by id.

Specified by:

getById in class CollectionDecorator<Permission,Permissions,TemplatePermission>

Parameters:

id - entity id

Returns:

TemplatePermission

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

Lists TemplatePermission objects.

Parameters:

max -

    [max results]
    

Returns:

List of TemplatePermission

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 TemplatePermission 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 template

      permission.user.id
      permission.role.id

    Overload 2:

      add a new role permission on the template

      permission.role.id
      permission.group.id
    

Returns:

TemplatePermission

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 TemplatePermission 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 template

      permission.user.id
      permission.role.id

    Overload 2:

      add a new role permission on the template

      permission.role.id
      permission.group.id
    

expect -

    [201-created]
    

Returns:

TemplatePermission

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 TemplatePermission 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 template

      permission.user.id
      permission.role.id

    Overload 2:

      add a new role permission on the template

      permission.role.id
      permission.group.id
    

expect -

    [201-created]
    

correlationId -

    [any string]
    

Returns:

TemplatePermission

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.