Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.roller.model
Interface UserManager  view UserManager download UserManager.java


public interface UserManager

Manages storage, retrieval, and querying of user, website, and page data.


Method Summary
 void addUser(org.roller.pojos.UserData user, java.lang.String theme, java.util.HashMap page)
          Add a new user with pages, bookmarks, folders...
 void deleteUser(org.roller.pojos.UserData data)
          Delete the user and all "dependant" objects
 java.lang.String exportUser(java.lang.String userName)
          Export user data in Roller's internal XML format
 java.lang.String fixPageLink(org.roller.pojos.PageData data)
          Fix page link using page name
 org.roller.pojos.PageData getPageByLink(java.lang.String u, java.lang.String p)
          Get user's page by link
 org.roller.pojos.PageData getPageByName(java.lang.String u, java.lang.String p)
          Get user's page by name
 org.roller.pojos.PageData[] getPages(java.lang.String userName)
          Get users pages
 org.roller.pojos.UserData getUser(java.lang.String userName)
          Get user object by user name (only enabled users)
 org.roller.pojos.UserData getUser(java.lang.String userName, boolean enabledOnly)
          Get user object by user name, optionally include dis-enabled users
 org.roller.pojos.UserData getUserById(java.lang.String userId)
          Get user object by user id (only enabled users)
 org.roller.pojos.UserData getUserById(java.lang.String userId, boolean enabledOnly)
          Get user object by user id, optionally include dis-enabled users
 org.roller.pojos.UserData[] getUsers()
          Get all enabled users
 org.roller.pojos.UserData[] getUsers(boolean enabledOnly)
          Get all users, optionally include dis-enabled users
 org.roller.pojos.WebsiteData getWebsite(java.lang.String userName)
          Get website object by user name
 org.roller.pojos.WebsiteData getWebsite(java.lang.String userName, boolean enabledOnly)
           
 void release()
          Release any resources used
 void removePage(java.lang.String id)
           
 void removeRole(java.lang.String id)
           
 void removeUser(java.lang.String id)
           
 void removeWebsite(java.lang.String id)
           
 org.roller.pojos.PageData retrievePage(java.lang.String id)
           
 org.roller.pojos.PageData retrievePageReadOnly(java.lang.String id)
          Retrieve the Page in read-only mode (does hibernate support this?).
 org.roller.pojos.RoleData retrieveRole(java.lang.String id)
           
 org.roller.pojos.UserData retrieveUser(java.lang.String id)
           
 org.roller.pojos.WebsiteData retrieveWebsite(java.lang.String id)
           
 void storePage(org.roller.pojos.PageData data)
           
 void storeRole(org.roller.pojos.RoleData data)
           
 void storeUser(org.roller.pojos.UserData data)
           
 void storeWebsite(org.roller.pojos.WebsiteData data)
           
 

Method Detail

release

public void release()
Release any resources used


getUsers

public org.roller.pojos.UserData[] getUsers()
                                     throws org.roller.RollerException
Get all enabled users


getUsers

public org.roller.pojos.UserData[] getUsers(boolean enabledOnly)
                                     throws org.roller.RollerException
Get all users, optionally include dis-enabled users


getUser

public org.roller.pojos.UserData getUser(java.lang.String userName)
                                  throws org.roller.RollerException
Get user object by user name (only enabled users)


getUser

public org.roller.pojos.UserData getUser(java.lang.String userName,
                                         boolean enabledOnly)
                                  throws org.roller.RollerException
Get user object by user name, optionally include dis-enabled users


getUserById

public org.roller.pojos.UserData getUserById(java.lang.String userId)
                                      throws org.roller.RollerException
Get user object by user id (only enabled users)


getUserById

public org.roller.pojos.UserData getUserById(java.lang.String userId,
                                             boolean enabledOnly)
                                      throws org.roller.RollerException
Get user object by user id, optionally include dis-enabled users


deleteUser

public void deleteUser(org.roller.pojos.UserData data)
                throws org.roller.RollerException
Delete the user and all "dependant" objects


addUser

public void addUser(org.roller.pojos.UserData user,
                    java.lang.String theme,
                    java.util.HashMap page)
             throws org.roller.RollerException
Add a new user with pages, bookmarks, folders...


exportUser

public java.lang.String exportUser(java.lang.String userName)
                            throws org.roller.RollerException
Export user data in Roller's internal XML format


retrieveUser

public org.roller.pojos.UserData retrieveUser(java.lang.String id)
                                       throws org.roller.RollerException

storeUser

public void storeUser(org.roller.pojos.UserData data)
               throws org.roller.RollerException

removeUser

public void removeUser(java.lang.String id)
                throws org.roller.RollerException

retrieveRole

public org.roller.pojos.RoleData retrieveRole(java.lang.String id)
                                       throws org.roller.RollerException

storeRole

public void storeRole(org.roller.pojos.RoleData data)
               throws org.roller.RollerException

removeRole

public void removeRole(java.lang.String id)
                throws org.roller.RollerException

getWebsite

public org.roller.pojos.WebsiteData getWebsite(java.lang.String userName)
                                        throws org.roller.RollerException
Get website object by user name


getWebsite

public org.roller.pojos.WebsiteData getWebsite(java.lang.String userName,
                                               boolean enabledOnly)
                                        throws org.roller.RollerException

retrieveWebsite

public org.roller.pojos.WebsiteData retrieveWebsite(java.lang.String id)
                                             throws org.roller.RollerException

storeWebsite

public void storeWebsite(org.roller.pojos.WebsiteData data)
                  throws org.roller.RollerException

removeWebsite

public void removeWebsite(java.lang.String id)
                   throws org.roller.RollerException

getPageByName

public org.roller.pojos.PageData getPageByName(java.lang.String u,
                                               java.lang.String p)
                                        throws org.roller.RollerException
Get user's page by name


getPageByLink

public org.roller.pojos.PageData getPageByLink(java.lang.String u,
                                               java.lang.String p)
                                        throws org.roller.RollerException
Get user's page by link


fixPageLink

public java.lang.String fixPageLink(org.roller.pojos.PageData data)
                             throws org.roller.RollerException
Fix page link using page name


getPages

public org.roller.pojos.PageData[] getPages(java.lang.String userName)
                                     throws org.roller.RollerException
Get users pages


retrievePage

public org.roller.pojos.PageData retrievePage(java.lang.String id)
                                       throws org.roller.RollerException

storePage

public void storePage(org.roller.pojos.PageData data)
               throws org.roller.RollerException

removePage

public void removePage(java.lang.String id)
                throws org.roller.RollerException

retrievePageReadOnly

public org.roller.pojos.PageData retrievePageReadOnly(java.lang.String id)
                                               throws org.roller.RollerException
Retrieve the Page in read-only mode (does hibernate support this?).