org.ovirt.engine.sdk.decorators

Class TemplateTags

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

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

org.ovirt.engine.sdk.decorators.TemplateTags

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

TemplateTags providing relation and functional services

to Tags.

Constructor Summary

Constructors

Constructor and Description
TemplateTags(HttpProxyBroker proxy, Template parent)

Method Summary

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

TemplateTags

public TemplateTags(HttpProxyBroker proxy,
                    Template parent)

Parameters:

proxy - HttpProxyBroker

parent - Template

Method Detail

list

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

Lists TemplateTag objects.

Specified by:

list in class CollectionDecorator<Tag,Tags,TemplateTag>

Returns:

List of TemplateTag

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

Fetches TemplateTag object by id.

Specified by:

get in class CollectionDecorator<Tag,Tags,TemplateTag>

Parameters:

id - entity id

Returns:

TemplateTag

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

Fetches TemplateTag object by id.

Specified by:

getById in class CollectionDecorator<Tag,Tags,TemplateTag>

Parameters:

id - entity id

Returns:

TemplateTag

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

Lists TemplateTag objects.

Parameters:

max -

    [max results]
    

Returns:

List of TemplateTag

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

Adds Tag object.

Parameters:

tag - Tag

    tag.id|name
    

Returns:

TemplateTag

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 TemplateTag 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:

TemplateTag

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 TemplateTag 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:

TemplateTag

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.