|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
---|
UserDef getUserDef() throws SiteAccessException
SiteAccessException
- throws this Exception if error metjava.util.List<java.lang.String> list() throws SiteAccessException
SiteAccessException
- throws this Exception if error metQueryResultWrapper<java.util.List<java.lang.String>> list(Condition query, boolean asc, int startindex, int count) throws SiteAccessException
query
- the query conditionasc
- the sort order of the name, true will be sorted ascendlystartindex
- the start indexcount
- the count of returnsSiteAccessException
- throws this Exception if error metjava.util.List<User> read(java.util.List<java.lang.String> usernames) throws SiteAccessException
usernames
- the username listSiteAccessException
- throws this Exception if error metQueryResultWrapper<java.util.List<User>> read(Condition query) throws SiteAccessException
query
- the Condition for reading the usersSiteAccessException
- throws this Exception if error metQueryResultWrapper<java.util.List<User>> read(Condition query, java.util.List<SortOrder> sortOrders, int startindex, int count) throws SiteAccessException
query
- the Condition for reading the users, we only support conditions for username, Locale and email for now for Locale, only equals is supportedsortOrders
- the list of SortOrders the results will be sorted upon, for now, only username, Locale and email are supportedstartindex
- the start index of the results >= 0, if <0 number specified, will treat as 0count
- the total number of results that will be returned, -1 or 0 would mean, everything will be returned from the start indexSiteAccessException
- throws this Exception if error metvoid create(java.util.List<User> users) throws SiteAccessException
users
- the list of Users to createSiteAccessException
- throws this Exception if error metvoid update(java.util.List<User> users) throws SiteAccessException
users
- the list of Content Server Users to updateSiteAccessException
- throws this Exception if error metvoid delete(java.util.List<java.lang.String> usernames) throws SiteAccessException
usernames
- the list of user names to deleteSiteAccessException
- throws this Exception if error met
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.