org.jasig.portal.layout
Interface IUserLayoutStore

All Known Implementing Classes:

RDBMDistributedLayoutStore, RDBMUserLayoutStore

public interface IUserLayoutStore

Method Summary

Integer	addStructureStylesheetDescription(String stylesheetDescriptionURI, String stylesheetURI) Registers new structure stylesheet with the portal database
UserProfile	addSystemProfile(UserProfile profile) add a new system profile to the database.
Integer	addThemeStylesheetDescription(String stylesheetDescriptionURI, String stylesheetURI) Registers a new theme stylesheet with the portal databases
UserProfile	addUserProfile(IPerson person, UserProfile profile) Creates a new user profile in the database.
void	deleteSystemProfile(int profileId) remove system profile from the database
void	deleteUserProfile(IPerson person, int profileId) remove user profile from the database
org.dom4j.Element	exportLayout(IPerson person, UserProfile profile) Returns an Element representing the user's layout and UserPreferences (but not portlet preferences) formatted for export.
String	generateNewChannelSubscribeId(IPerson person) Generate an instance id for a channel being added to the user layout
String	generateNewFolderId(IPerson person) Generate a folder id for a folder being added to the user layout
Hashtable	getMimeTypeList() Obtains a list of mime types available on the installation
StructureStylesheetDescription	getStructureStylesheetDescription(int stylesheetId) Obtains a complete description of the structure stylesheet
Hashtable	getStructureStylesheetList() Obtain a list of strcture stylesheet descriptions registered on the system
Hashtable	getStructureStylesheetList(String mimeType) Obtain a list of all structure stylesheet registered in the portal that (given a proper theme stylesheet choice) can support a given mime type.
StructureStylesheetUserPreferences	getStructureStylesheetUserPreferences(IPerson person, int profileId, int stylesheetId) Obtain structure stylesheet user preferences
UserProfile	getSystemProfile(String userAgent) retreive a system profile associated with a given browser
UserProfile	getSystemProfileByFname(String profileFname)
UserProfile	getSystemProfileById(int profileId) Obtain a system profile
Hashtable	getSystemProfileList() obtain a list of system profiles
ThemeStylesheetDescription	getThemeStylesheetDescription(int stylesheetId) Obtains a complete description of a theme stylesheet
Hashtable	getThemeStylesheetList() Obtain a list of theme stylesheet descriptions registered on the system
Hashtable	getThemeStylesheetList(int structureStylesheetId) Obtains a list of theme stylesheets available for a particular structure stylesheet.
ThemeStylesheetUserPreferences	getThemeStylesheetUserPreferences(IPerson person, int profileId, int stylesheetId) Obtain theme stylesheet user preferences
Document	getUserLayout(IPerson Person, UserProfile profile) Retrieve a user layout document.
UserPreferences	getUserPreferences(IPerson person, UserProfile profile) Retreive the entire UserPreferences object
UserProfile	getUserProfile(IPerson person, String userAgent) Obtain user profile associated with a particular browser
UserProfile	getUserProfileByFname(IPerson person, String profileFname) Obtains a user profile by profile functional name.
UserProfile	getUserProfileById(IPerson person, int profileId) Obtains a user profile by profile id.
Hashtable<Integer,UserProfile>	getUserProfileList(IPerson person) retreive a list of profiles associated with a user
void	importLayout(org.dom4j.Element layout) Performs the reverse of exportLayout.
void	putUserPreferences(IPerson person, UserPreferences up) save user preferences
void	removeStructureStylesheetDescription(int stylesheetId) removes stylesheet description
void	removeThemeStylesheetDescription(int stylesheetId) Removes theme stylesheet
void	setStructureStylesheetUserPreferences(IPerson person, int profileId, StructureStylesheetUserPreferences fsup) Save structure stylesheet user pferences
void	setSystemBrowserMapping(String userAgent, int systemProfileId) establish system profile browser mapping
void	setThemeStylesheetUserPreferences(IPerson person, int profileId, ThemeStylesheetUserPreferences ssup) Save theme stylesheet user preferences
void	setUserBrowserMapping(IPerson person, String userAgent, int profileId) establish a browser - user profile mapping
void	setUserLayout(IPerson Person, UserProfile profile, Document layoutXML, boolean channelsAdded) Persist user layout document.
boolean	updateStructureStylesheetDescription(String stylesheetDescriptionURI, String stylesheetURI, int stylesheetId) Updates an existing structure stylesheet description.
void	updateSystemProfile(UserProfile profile) update system profile
boolean	updateThemeStylesheetDescription(String stylesheetDescriptionURI, String stylesheetURI, int stylesheetId) Updates an existing theme stylesheet description.
void	updateUserProfile(IPerson person, UserProfile profile) update user profile

Method Detail

getUserLayout

Document getUserLayout(IPerson Person,
                       UserProfile profile)
                       throws Exception

Retrieve a user layout document.

Parameters:

Person - an IPerson object specifying the user

profile - a user profile

Returns:

a Document containing user layout (conforms to userLayout.dtd)

Throws:

Exception - if an error occurs

exportLayout

org.dom4j.Element exportLayout(IPerson person,
                               UserProfile profile)

Returns an Element representing the user's layout and UserPreferences (but not portlet preferences) formatted for export. This element must have an element name of <layout>. Exported documents must not reference database identifiers and should exclude unnecessary items like channel publishing parameters, etc. Layout store implementations are may return null for users that don't have layout or preferences customizations.

Parameters:

person - An IPerson object specifying the user

profile - A valid profile for person

Returns:

A streamlined Document containing user layout and UserPreferences data

Throws:

Exception - if an error occurs

importLayout

void importLayout(org.dom4j.Element layout)

Performs the reverse of exportLayout. The specified element must have an element name of <layout> and contain both content and UserPreferences data.

Parameters:

layout - XML representing a user's layout and UserPreferences

setUserLayout

void setUserLayout(IPerson Person,
                   UserProfile profile,
                   Document layoutXML,
                   boolean channelsAdded)
                   throws Exception

Persist user layout document.

Parameters:

Person - an IPerson object specifying the user

profile - a user profile for which the layout is being stored

layoutXML - a Document containing user layout (conforming to userLayout.dtd)

channelsAdded - a boolean flag specifying if new channels have been added to the current user layout (for performance optimization purposes)

Throws:

Exception - if an error occurs

getUserProfile

UserProfile getUserProfile(IPerson person,
                           String userAgent)
                           throws Exception

Obtain user profile associated with a particular browser

Parameters:

person - User

userAgent - User-Agent header string

Returns:

user profile or null if no user profiles are associated with the given user agent.

Throws:

Exception

updateUserProfile

void updateUserProfile(IPerson person,
                       UserProfile profile)
                       throws Exception

update user profile

Parameters:

person - User

profile - profile update

Throws:

Exception

deleteUserProfile

void deleteUserProfile(IPerson person,
                       int profileId)
                       throws Exception

remove user profile from the database

Parameters:

person - User

profileId - profile id

Throws:

Exception

addUserProfile

UserProfile addUserProfile(IPerson person,
                           UserProfile profile)
                           throws Exception

Creates a new user profile in the database. In the process, new profileId is assigned to the profile

Parameters:

person - User

profile - profile object (profile id in this object will be overwritten)

Returns:

profile object with the profile id set to the newly generated id

Throws:

Exception

getUserProfileById

UserProfile getUserProfileById(IPerson person,
                               int profileId)
                               throws Exception

Obtains a user profile by profile id.

Parameters:

person - an IPerson object representing the user

profileId - profile id

Throws:

Exception

getUserProfileByFname

UserProfile getUserProfileByFname(IPerson person,
                                  String profileFname)
                                  throws Exception

Obtains a user profile by profile functional name.

Parameters:

person - an IPerson object representing the user

profileFname - profile functional name

Throws:

Exception

getUserProfileList

Hashtable<Integer,UserProfile> getUserProfileList(IPerson person)
                                                  throws Exception

retreive a list of profiles associated with a user

Parameters:

person - User

Returns:

a Hashtable mapping user profile ids (Integer objects) to the UserProfile objects

Throws:

Exception

getSystemProfile

UserProfile getSystemProfile(String userAgent)
                             throws Exception

retreive a system profile associated with a given browser

Parameters:

userAgent - User-Agent header string

Returns:

profile object

Throws:

Exception

updateSystemProfile

void updateSystemProfile(UserProfile profile)
                         throws Exception

update system profile

Parameters:

profile - profile object

Throws:

Exception

deleteSystemProfile

void deleteSystemProfile(int profileId)
                         throws Exception

remove system profile from the database

Parameters:

profileId - profile id

Throws:

Exception

addSystemProfile

UserProfile addSystemProfile(UserProfile profile)
                             throws Exception

add a new system profile to the database. During this process, a new profile id will be assigned to the profile.

Parameters:

profile - profile object (profile id within will be overwritten)

Returns:

profile with an newly assigned id

Throws:

Exception

getSystemProfileById

UserProfile getSystemProfileById(int profileId)
                                 throws Exception

Obtain a system profile

Parameters:

profileId - system profile id

Throws:

Exception

getSystemProfileByFname

UserProfile getSystemProfileByFname(String profileFname)
                                    throws Exception

Throws:

Exception

getSystemProfileList

Hashtable getSystemProfileList()
                               throws Exception

obtain a list of system profiles

Returns:

a Hashtable mapping system profile ids (Integer objects) to the UserProfile objects

Throws:

Exception

setUserBrowserMapping

void setUserBrowserMapping(IPerson person,
                           String userAgent,
                           int profileId)
                           throws Exception

establish a browser - user profile mapping

Parameters:

person - User

userAgent - User-Agent header string

profileId - profile id to which given user agent will be mapped

Throws:

Exception

setSystemBrowserMapping

void setSystemBrowserMapping(String userAgent,
                             int systemProfileId)
                             throws Exception

establish system profile browser mapping

Parameters:

userAgent - User-Agent header string

systemProfileId - profile id of a profile to which given user-agent will be mapped

Throws:

Exception

getUserPreferences

UserPreferences getUserPreferences(IPerson person,
                                   UserProfile profile)
                                   throws Exception

Retreive the entire UserPreferences object

Parameters:

person - User

profile - profile

Returns:

user preferences

Throws:

Exception

putUserPreferences

void putUserPreferences(IPerson person,
                        UserPreferences up)
                        throws Exception

save user preferences

Parameters:

person - User

up - user preferences object

Throws:

Exception

getStructureStylesheetUserPreferences

StructureStylesheetUserPreferences getStructureStylesheetUserPreferences(IPerson person,
                                                                         int profileId,
                                                                         int stylesheetId)
                                                                         throws Exception

Obtain structure stylesheet user preferences

Parameters:

person - User

profileId - profile id

stylesheetId - structure stylesheet id

Returns:

structure stylesheet user preferences. null is returned only if userId, profileId or stylesheet with an appropriate name do not exist. If all of the parameters are valid, but the user does not have any user preference settings associated with this stylesheet, return contains stylesheet preference object filled in with the defaults defined in stylesheet description.

Throws:

Exception

getThemeStylesheetUserPreferences

ThemeStylesheetUserPreferences getThemeStylesheetUserPreferences(IPerson person,
                                                                 int profileId,
                                                                 int stylesheetId)
                                                                 throws Exception

Obtain theme stylesheet user preferences

Parameters:

person - User

profileId - profile id

stylesheetId - theme stylesheet id

Returns:

theme stylesheet user preferences. null is returned only if userId, profileId or stylesheet with an appropriate name do not exist. If all of the parameters are valid, but the user does not have any user preference settings associated with this stylesheet, return contains stylesheet preference object filled in with the defaults defined in stylesheet description.

Throws:

Exception

setStructureStylesheetUserPreferences

void setStructureStylesheetUserPreferences(IPerson person,
                                           int profileId,
                                           StructureStylesheetUserPreferences fsup)
                                           throws Exception

Save structure stylesheet user pferences

Parameters:

person - User

profileId - profile id

fsup - structure stylesheet user preferences

Throws:

Exception

setThemeStylesheetUserPreferences

void setThemeStylesheetUserPreferences(IPerson person,
                                       int profileId,
                                       ThemeStylesheetUserPreferences ssup)
                                       throws Exception

Save theme stylesheet user preferences

Parameters:

person - User

profileId - profile id

ssup - structure stylesheet user preferneces

Throws:

Exception

generateNewChannelSubscribeId

String generateNewChannelSubscribeId(IPerson person)
                                     throws Exception

Generate an instance id for a channel being added to the user layout

Parameters:

person - an IPerson value

Returns:

a String value

Throws:

Exception - if an error occurs

generateNewFolderId

String generateNewFolderId(IPerson person)
                           throws Exception

Generate a folder id for a folder being added to the user layout

Parameters:

person - an IPerson value

Returns:

a String value

Throws:

Exception - if an error occurs

getStructureStylesheetList

Hashtable getStructureStylesheetList(String mimeType)
                                     throws Exception

Obtain a list of all structure stylesheet registered in the portal that (given a proper theme stylesheet choice) can support a given mime type. Even though structure stylesheets themselves do not carry any mime type specification, the choice of available theme stylesheets determines if a certain structure is available for a given mime type.

Parameters:

mimeType - mime type that should be supported

Returns:

a Hashtable mapping stylesheet id (Integer objects) to StructureStylesheetDescription objects

Throws:

Exception

getThemeStylesheetList

Hashtable getThemeStylesheetList(int structureStylesheetId)
                                 throws Exception

Obtains a list of theme stylesheets available for a particular structure stylesheet.

Parameters:

structureStylesheetId - id of the structure stylehsset

Returns:

a Hashtable mapping stylesheet id (Integer objects) to ThemeStylesheetDescription objects

Throws:

Exception

getStructureStylesheetList

Hashtable getStructureStylesheetList()
                                     throws Exception

Obtain a list of strcture stylesheet descriptions registered on the system

Returns:

a Hashtable mapping stylesheet id (Integer objects) to StructureStylesheetDescription objects

Throws:

Exception

getThemeStylesheetList

Hashtable getThemeStylesheetList()
                                 throws Exception

Obtain a list of theme stylesheet descriptions registered on the system

Returns:

a Hashtable mapping stylesheet id (Integer objects) to ThemeStylesheetDescription objects

Throws:

Exception

getMimeTypeList

Hashtable getMimeTypeList()
                          throws Exception

Obtains a list of mime types available on the installation

Returns:

Returns a hasbtale mapping mime type strings to their word descriptions (simple String)

Throws:

Exception

getStructureStylesheetDescription

StructureStylesheetDescription getStructureStylesheetDescription(int stylesheetId)
                                                                 throws Exception

Obtains a complete description of the structure stylesheet

Parameters:

stylesheetId - id of the structure stylesheet

Returns:

a description of the structure stylesheet

Throws:

Exception

getThemeStylesheetDescription

ThemeStylesheetDescription getThemeStylesheetDescription(int stylesheetId)
                                                         throws Exception

Obtains a complete description of a theme stylesheet

Parameters:

stylesheetId - id of a theme stylesheet

Returns:

a description of a theme stylesheet

Throws:

Exception

removeStructureStylesheetDescription

void removeStructureStylesheetDescription(int stylesheetId)
                                          throws Exception

removes stylesheet description

Parameters:

stylesheetId - id of the stylesheet

Throws:

Exception

removeThemeStylesheetDescription

void removeThemeStylesheetDescription(int stylesheetId)
                                      throws Exception

Removes theme stylesheet

Parameters:

stylesheetId - id of the stylesheet

Throws:

Exception

addStructureStylesheetDescription

Integer addStructureStylesheetDescription(String stylesheetDescriptionURI,
                                          String stylesheetURI)
                                          throws Exception

Registers new structure stylesheet with the portal database

Parameters:

stylesheetDescriptionURI - Location of the stylesheet description XML file

stylesheetURI - Location of the actual stylesshet XML file

Returns:

id assigned to the stylesheet or null if the operation failed

Throws:

Exception

updateStructureStylesheetDescription

boolean updateStructureStylesheetDescription(String stylesheetDescriptionURI,
                                             String stylesheetURI,
                                             int stylesheetId)

Updates an existing structure stylesheet description.

Parameters:

stylesheetDescriptionURI - Location of the stylesheet description XML file

stylesheetURI - Location of the actual stylesshet XML file

stylesheetId - the id of the existing stylesheet description

Returns:

true if the update successful

updateThemeStylesheetDescription

boolean updateThemeStylesheetDescription(String stylesheetDescriptionURI,
                                         String stylesheetURI,
                                         int stylesheetId)
                                         throws Exception

Updates an existing theme stylesheet description.

Parameters:

stylesheetDescriptionURI - Location of the stylesheet description XML file

stylesheetURI - Location of the actual stylesshet XML file

stylesheetId - the id of the existing stylesheet description

Returns:

true if the update successful

Throws:

Exception

addThemeStylesheetDescription

Integer addThemeStylesheetDescription(String stylesheetDescriptionURI,
                                      String stylesheetURI)
                                      throws Exception

Registers a new theme stylesheet with the portal databases

Parameters:

stylesheetDescriptionURI - Location of the stylesheet description XML file

stylesheetURI - Location of the actual stylesheet XML file

Returns:

id assigned to the stylesheet or null if the operation failed

Throws:

Exception