org.ovirt.engine.sdk.decorators

Class Groups

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

org.ovirt.engine.sdk.common.CollectionDecorator<Group,Groups,Group>

org.ovirt.engine.sdk.decorators.Groups

public class Groups
extends CollectionDecorator<Group,Groups,Group>

Groups providing relation and functional services

to Groups.

Constructor Summary

Constructors

Constructor and Description
Groups(HttpProxyBroker proxy)

Method Summary

Modifier and Type	Method and Description
Group	add(Group group) Adds Group object.
Group	add(Group group, String correlationId) Adds Group object.
Group	get(UUID id) Fetches Group object by id.
Group	getById(String id) Fetches Group object by id.
List<Group>	list() Lists Group objects.
List<Group>	list(String query, Boolean caseSensitive, Integer max) Lists Group 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

Groups

public Groups(HttpProxyBroker proxy)

Parameters:

proxy - HttpProxyBroker

Method Detail

list

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

Lists Group objects.

Specified by:

list in class CollectionDecorator<Group,Groups,Group>

Returns:

List of Group

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

Fetches Group object by id.

Specified by:

get in class CollectionDecorator<Group,Groups,Group>

Parameters:

id - entity id

Returns:

Group

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

Fetches Group object by id.

Specified by:

getById in class CollectionDecorator<Group,Groups,Group>

Parameters:

id - entity id

Returns:

Group

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<Group> list(String query,
                        Boolean caseSensitive,
                        Integer max)
                 throws org.apache.http.client.ClientProtocolException,
                        ServerException,
                        IOException

Lists Group objects.

Parameters:

query -

    [search query]
    

caseSensitive -

    [true|false]
    

max -

    [max results]
    

Returns:

List of Group

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

Adds Group object.

Parameters:

group - Group

    group.name
    

Returns:

Group

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 Group add(Group group,
                 String correlationId)
          throws org.apache.http.client.ClientProtocolException,
                 ServerException,
                 IOException

Adds Group object.

Parameters:

group - Group

    group.name
    

correlationId -

    [any string]
    

Returns:

Group

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.