org.ovirt.engine.sdk.decorators

Class UserTags

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

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

org.ovirt.engine.sdk.decorators.UserTags

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

UserTags providing relation and functional services

to Tags.

Constructor Summary

Constructors

Constructor and Description
UserTags(HttpProxyBroker proxy, User parent)

Method Summary

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

UserTags

public UserTags(HttpProxyBroker proxy,
                User parent)

Parameters:

proxy - HttpProxyBroker

parent - User

Method Detail

list

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

Lists UserTag objects.

Specified by:

list in class CollectionDecorator<Tag,Tags,UserTag>

Returns:

List of UserTag

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

Fetches UserTag object by id.

Specified by:

get in class CollectionDecorator<Tag,Tags,UserTag>

Parameters:

id - entity id

Returns:

UserTag

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

Fetches UserTag object by id.

Specified by:

getById in class CollectionDecorator<Tag,Tags,UserTag>

Parameters:

id - entity id

Returns:

UserTag

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

Lists UserTag objects.

Parameters:

max -

    [max results]
    

Returns:

List of UserTag

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

Adds Tag object.

Parameters:

tag - Tag

    tag.id|name
    

Returns:

UserTag

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

UserTag

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

UserTag

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.