org.ovirt.engine.sdk.decorators

Class Users

java.lang.Object

org.ovirt.engine.sdk.common.Decorator

org.ovirt.engine.sdk.common.CollectionDecorator<User,Users,User>

org.ovirt.engine.sdk.decorators.Users

public class Users
extends CollectionDecorator<User,Users,User>

Users providing relation and functional services

to Users.

Constructor Summary

Constructors

Constructor and Description
Users(HttpProxyBroker proxy)

Method Summary

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

Users

public Users(HttpProxyBroker proxy)

Parameters:

proxy - HttpProxyBroker

Method Detail

list

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

Lists User objects.

Specified by:

list in class CollectionDecorator<User,Users,User>

Returns:

List of User

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

Fetches User object by id.

Specified by:

get in class CollectionDecorator<User,Users,User>

Parameters:

id - entity id

Returns:

User

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

Fetches User object by id.

Specified by:

getById in class CollectionDecorator<User,Users,User>

Parameters:

id - entity id

Returns:

User

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

Lists User objects.

Parameters:

query -

    [search query]
    

caseSensitive -

    [true|false]
    

max -

    [max results]
    

Returns:

List of User

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

Adds User object.

Parameters:

user - User

    user.user_name
    user.domain.id|name
    

Returns:

User

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

Adds User object.

Parameters:

user - User

    user.user_name
    user.domain.id|name
    

expect -

    [201-created]
    

Returns:

User

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

Adds User object.

Parameters:

user - User

    user.user_name
    user.domain.id|name
    

expect -

    [201-created]
    

correlationId -

    [any string]
    

Returns:

User

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.