org.ovirt.engine.sdk.decorators

Class GroupTags

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

org.ovirt.engine.sdk.common.CollectionDecorator<Tag,Tags,GroupTag>

org.ovirt.engine.sdk.decorators.GroupTags

public class GroupTags
extends CollectionDecorator<Tag,Tags,GroupTag>

GroupTags providing relation and functional services

to Tags.

Constructor Summary

Constructors

Constructor and Description
GroupTags(HttpProxyBroker proxy, Group parent)

Method Summary

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

GroupTags

public GroupTags(HttpProxyBroker proxy,
                 Group parent)

Parameters:

proxy - HttpProxyBroker

parent - Group

Method Detail

list

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

Lists GroupTag objects.

Specified by:

list in class CollectionDecorator<Tag,Tags,GroupTag>

Returns:

List of GroupTag

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

Fetches GroupTag object by id.

Specified by:

get in class CollectionDecorator<Tag,Tags,GroupTag>

Parameters:

id - entity id

Returns:

GroupTag

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

Fetches GroupTag object by id.

Specified by:

getById in class CollectionDecorator<Tag,Tags,GroupTag>

Parameters:

id - entity id

Returns:

GroupTag

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

Lists GroupTag objects.

Parameters:

max -

    [max results]
    

Returns:

List of GroupTag

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

Adds Tag object.

Parameters:

tag - Tag

    tag.id|name
    

Returns:

GroupTag

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 GroupTag add(Tag tag,
                    String expect)
             throws org.apache.http.client.ClientProtocolException,
                    ServerException,
                    IOException

Adds Tag object.

Parameters:

tag - Tag

    tag.id|name
    

expect -

    [201-created]
    

Returns:

GroupTag

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

Adds Tag object.

Parameters:

tag - Tag

    tag.id|name
    

expect -

    [201-created]
    

correlationId -

    [any string]
    

Returns:

GroupTag

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.