com.fatwire.assetapi.site
Interface UserManager

public interface UserManager

The manager class that does CRUD for user

Method Summary

void	create(java.util.List<User> users) Creates a list of Content Server Users
void	delete(java.util.List<java.lang.String> usernames) Deletes the list of Users from Content Server
UserDef	getUserDef() Gets the user definition for creation of Content Server user
java.util.List<java.lang.String>	list() Lists all the user names in Content Server
QueryResultWrapper<java.util.List<java.lang.String>>	list(Condition query, boolean asc, int startindex, int count) Lists all the user names that satisfying the query conditions
QueryResultWrapper<java.util.List<User>>	read(Condition query) Reads a list of Content Server users that satisfies the given Condition
QueryResultWrapper<java.util.List<User>>	read(Condition query, java.util.List<SortOrder> sortOrders, int startindex, int count) Reads a list of Content Server users that satisfies the given Condition
java.util.List<User>	read(java.util.List<java.lang.String> usernames) Reads a list of Content Server users with the user name
void	update(java.util.List<User> users) Updates a list of Content Server users

Method Detail

getUserDef

UserDef getUserDef()
                   throws SiteAccessException

Gets the user definition for creation of Content Server user

Returns:

the user definition

Throws:

SiteAccessException - throws this Exception if error met

list

java.util.List<java.lang.String> list()
                                      throws SiteAccessException

Lists all the user names in Content Server

Returns:

the list of user names

Throws:

SiteAccessException - throws this Exception if error met

list

QueryResultWrapper<java.util.List<java.lang.String>> list(Condition query,
                                                          boolean asc,
                                                          int startindex,
                                                          int count)
                                                          throws SiteAccessException

Lists all the user names that satisfying the query conditions

Parameters:

query - the query condition

asc - the sort order of the name, true will be sorted ascendly

startindex - the start index

count - the count of returns

Returns:

the String list of user names that satisfy the query conditions

Throws:

SiteAccessException - throws this Exception if error met

read

java.util.List<User> read(java.util.List<java.lang.String> usernames)
                          throws SiteAccessException

Reads a list of Content Server users with the user name

Parameters:

usernames - the username list

Returns:

the list of users for the given names

Throws:

SiteAccessException - throws this Exception if error met

read

QueryResultWrapper<java.util.List<User>> read(Condition query)
                                              throws SiteAccessException

Reads a list of Content Server users that satisfies the given Condition

Parameters:

query - the Condition for reading the users

Returns:

the list of users that satisfies the condition

Throws:

SiteAccessException - throws this Exception if error met

read

QueryResultWrapper<java.util.List<User>> read(Condition query,
                                              java.util.List<SortOrder> sortOrders,
                                              int startindex,
                                              int count)
                                              throws SiteAccessException

Reads a list of Content Server users that satisfies the given Condition

Parameters:

query - the Condition for reading the users, we only support conditions for username, Locale and email for now for Locale, only equals is supported

sortOrders - the list of SortOrders the results will be sorted upon, for now, only username, Locale and email are supported

startindex - the start index of the results >= 0, if <0 number specified, will treat as 0

count - the total number of results that will be returned, -1 or 0 would mean, everything will be returned from the start index

Returns:

the list of users that satisfies the condition

Throws:

SiteAccessException - throws this Exception if error met

create

void create(java.util.List<User> users)
            throws SiteAccessException

Creates a list of Content Server Users

Parameters:

users - the list of Users to create

Throws:

SiteAccessException - throws this Exception if error met

update

void update(java.util.List<User> users)
            throws SiteAccessException

Updates a list of Content Server users

Parameters:

users - the list of Content Server Users to update

Throws:

SiteAccessException - throws this Exception if error met

delete

void delete(java.util.List<java.lang.String> usernames)
            throws SiteAccessException

Deletes the list of Users from Content Server

Parameters:

usernames - the list of user names to delete

Throws:

SiteAccessException - throws this Exception if error met