org.ovirt.engine.sdk.decorators

Class Tags

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

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

org.ovirt.engine.sdk.decorators.Tags

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

Tags providing relation and functional services

to Tags.

Constructor Summary

Constructors

Constructor and Description
Tags(HttpProxyBroker proxy)

Method Summary

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

Tags

public Tags(HttpProxyBroker proxy)

Parameters:

proxy - HttpProxyBroker

Method Detail

list

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

Lists Tag objects.

Specified by:

list in class CollectionDecorator<Tag,Tags,Tag>

Returns:

List of Tag

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

Fetches Tag object by id.

Specified by:

get in class CollectionDecorator<Tag,Tags,Tag>

Parameters:

id - entity id

Returns:

Tag

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

Fetches Tag object by id.

Specified by:

getById in class CollectionDecorator<Tag,Tags,Tag>

Parameters:

id - entity id

Returns:

Tag

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

Lists Tag objects.

Parameters:

max -

    [max results]
    

Returns:

List of Tag

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

Adds Tag object.

Parameters:

tag - Tag

    tag.name
    [tag.description]
    [tag.parent.tag.id|name]
    

Returns:

Tag

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

Adds Tag object.

Parameters:

tag - Tag

    tag.name
    [tag.description]
    [tag.parent.tag.id|name]
    

correlationId -

    [any string]
    

Returns:

Tag

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.