| org.jasig.portal.layout.IUserLayoutStore
All known Subclasses: org.jasig.portal.layout.UserLayoutStoreMock, org.jasig.portal.layout.simple.RDBMUserLayoutStore, org.jasig.portal.layout.simple.OracleUserLayoutStore,
IUserLayoutStore | public interface IUserLayoutStore (Code) | | |
Method Summary | |
public Integer | addStructureStylesheetDescription(String stylesheetDescriptionURI, String stylesheetURI) | public UserProfile | addSystemProfile(UserProfile profile) add a new system profile to the database. | public Integer | addThemeStylesheetDescription(String stylesheetDescriptionURI, String stylesheetURI) | public UserProfile | addUserProfile(IPerson person, UserProfile profile) Creates a new user profile in the database. | public void | deleteSystemProfile(int profileId) | public void | deleteUserProfile(IPerson person, int profileId) | public String | generateNewChannelSubscribeId(IPerson person) | public String | generateNewFolderId(IPerson person) | public Hashtable | getMimeTypeList() | public StructureStylesheetDescription | getStructureStylesheetDescription(int stylesheetId) | public 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. | public Hashtable | getStructureStylesheetList() | public StructureStylesheetUserPreferences | getStructureStylesheetUserPreferences(IPerson person, int profileId, int stylesheetId) Obtain structure stylesheet user preferences
Parameters: person - User Parameters: profileId - profile id Parameters: stylesheetId - structure stylesheet id structure stylesheet user preferences. | public UserProfile | getSystemProfile(String userAgent) | public UserProfile | getSystemProfileById(int profileId) | public Hashtable | getSystemProfileList() | public ThemeStylesheetDescription | getThemeStylesheetDescription(int stylesheetId) | public Hashtable | getThemeStylesheetList(int structureStylesheetId) Obtains a list of theme stylesheets available for a particular structure stylesheet. | public Hashtable | getThemeStylesheetList() | public ThemeStylesheetUserPreferences | getThemeStylesheetUserPreferences(IPerson person, int profileId, int stylesheetId) Obtain theme stylesheet user preferences
Parameters: person - User Parameters: profileId - profile id Parameters: stylesheetId - theme stylesheet id theme stylesheet user preferences. | public Document | getUserLayout(IPerson Person, UserProfile profile) Retreive a user layout document. | public UserPreferences | getUserPreferences(IPerson person, UserProfile profile) | public UserProfile | getUserProfile(IPerson person, String userAgent) | public UserProfile | getUserProfileById(IPerson person, int profileId) Obtains a user profile by profile id. | public Hashtable | getUserProfileList(IPerson person) | public void | putUserPreferences(IPerson person, UserPreferences up) | public void | removeStructureStylesheetDescription(int stylesheetId) | public void | removeThemeStylesheetDescription(int stylesheetId) | public void | setStructureStylesheetUserPreferences(IPerson person, int profileId, StructureStylesheetUserPreferences fsup) | public void | setSystemBrowserMapping(String userAgent, int systemProfileId) | public void | setThemeStylesheetUserPreferences(IPerson person, int profileId, ThemeStylesheetUserPreferences ssup) | public void | setUserBrowserMapping(IPerson person, String userAgent, int profileId) | public void | setUserLayout(IPerson Person, UserProfile profile, Document layoutXML, boolean channelsAdded) Persist user layout document. | public boolean | updateStructureStylesheetDescription(String stylesheetDescriptionURI, String stylesheetURI, int stylesheetId) Updates an existing structure stylesheet description. | public void | updateSystemProfile(UserProfile profile) | public boolean | updateThemeStylesheetDescription(String stylesheetDescriptionURI, String stylesheetURI, int stylesheetId) Updates an existing theme stylesheet description. | public void | updateUserProfile(IPerson person, UserProfile profile) |
addStructureStylesheetDescription | public Integer addStructureStylesheetDescription(String stylesheetDescriptionURI, String stylesheetURI) throws Exception(Code) | | Registers new structure stylesheet with the portal database
Parameters: stylesheetDescriptionURI - Location of the stylesheet description XML file Parameters: stylesheetURI - Location of the actual stylesshet XML file id assigned to the stylesheet or null if the operation failed |
addSystemProfile | public UserProfile addSystemProfile(UserProfile profile) throws Exception(Code) | | 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) profile with an newly assigned id |
addThemeStylesheetDescription | public Integer addThemeStylesheetDescription(String stylesheetDescriptionURI, String stylesheetURI) throws Exception(Code) | | Registers a new theme stylesheet with the portal databases
Parameters: stylesheetDescriptionURI - Location of the stylesheet descriptionXML file Parameters: stylesheetURI - Location of the actual stylesheet XML file id assigned to the stylesheet or null if the operation failed |
addUserProfile | public UserProfile addUserProfile(IPerson person, UserProfile profile) throws Exception(Code) | | Creates a new user profile in the database.
In the process, new profileId is assigned to the profile
Parameters: person - User Parameters: profile - profile object (profile id in this object will beoverwritten) profile object with the profile id set to the newly generatedid |
deleteSystemProfile | public void deleteSystemProfile(int profileId) throws Exception(Code) | | remove system profile from the database
Parameters: profileId - profile id |
deleteUserProfile | public void deleteUserProfile(IPerson person, int profileId) throws Exception(Code) | | remove user profile from the database
Parameters: person - User Parameters: profileId - profile id |
generateNewChannelSubscribeId | public String generateNewChannelSubscribeId(IPerson person) throws Exception(Code) | | Generate an instance id for a channel being added to the user layout
Parameters: person - an IPerson value a String value exception: Exception - if an error occurs |
generateNewFolderId | public String generateNewFolderId(IPerson person) throws Exception(Code) | | Generate a folder id for a folder being added to the user layout
Parameters: person - an IPerson value a String value exception: Exception - if an error occurs |
getMimeTypeList | public Hashtable getMimeTypeList() throws Exception(Code) | | Obtains a list of mime types available on the installation
Returns a hasbtale mapping mime type strings to their worddescriptions (simple String) |
getStructureStylesheetDescription | public StructureStylesheetDescription getStructureStylesheetDescription(int stylesheetId) throws Exception(Code) | | Obtains a complete description of the structure stylesheet
Parameters: stylesheetId - id of the structure stylesheet a description of the structure stylesheet |
getStructureStylesheetList | public Hashtable getStructureStylesheetList(String mimeType) throws Exception(Code) | | 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 a Hashtable mapping stylesheet id (Integer objects) to StructureStylesheetDescription objects |
getStructureStylesheetUserPreferences | public StructureStylesheetUserPreferences getStructureStylesheetUserPreferences(IPerson person, int profileId, int stylesheetId) throws Exception(Code) | | Obtain structure stylesheet user preferences
Parameters: person - User Parameters: profileId - profile id Parameters: stylesheetId - structure stylesheet id 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. |
getSystemProfile | public UserProfile getSystemProfile(String userAgent) throws Exception(Code) | | retreive a system profile associated with a given browser
Parameters: userAgent - User-Agent header string profile object |
getSystemProfileById | public UserProfile getSystemProfileById(int profileId) throws Exception(Code) | | Obtain a system profile
Parameters: profileId - system profile id |
getSystemProfileList | public Hashtable getSystemProfileList() throws Exception(Code) | | obtain a list of system profiles
a Hashtable mapping system profile ids (Integer objects) to the UserProfile objects |
getThemeStylesheetDescription | public ThemeStylesheetDescription getThemeStylesheetDescription(int stylesheetId) throws Exception(Code) | | Obtains a complete description of a theme stylesheet
Parameters: stylesheetId - id of a theme stylesheet a description of a theme stylesheet |
getThemeStylesheetList | public Hashtable getThemeStylesheetList(int structureStylesheetId) throws Exception(Code) | | Obtains a list of theme stylesheets available for a particular structure stylesheet.
Parameters: structureStylesheetId - id of the structure stylehsset a Hashtable mapping stylesheet id (Integer objects) to ThemeStylesheetDescription objects |
getThemeStylesheetUserPreferences | public ThemeStylesheetUserPreferences getThemeStylesheetUserPreferences(IPerson person, int profileId, int stylesheetId) throws Exception(Code) | | Obtain theme stylesheet user preferences
Parameters: person - User Parameters: profileId - profile id Parameters: stylesheetId - theme stylesheet id 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. |
getUserLayout | public Document getUserLayout(IPerson Person, UserProfile profile) throws Exception(Code) | | Retreive a user layout document.
Parameters: Person - an IPerson object specifying the user Parameters: profile - a user profile a Document containing user layout (conforms to userLayout.dtd) exception: Exception - if an error occurs |
getUserProfile | public UserProfile getUserProfile(IPerson person, String userAgent) throws Exception(Code) | | Obtain user profile associated with a particular browser
Parameters: person - User Parameters: userAgent - User-Agent header string user profile or null if no user profiles are associated with the given user agent. |
getUserProfileById | public UserProfile getUserProfileById(IPerson person, int profileId) throws Exception(Code) | | Obtains a user profile by profile id.
Parameters: person - an IPerson object representing the user Parameters: profileId - profile id |
getUserProfileList | public Hashtable getUserProfileList(IPerson person) throws Exception(Code) | | retreive a list of profiles associated with a user
Parameters: person - User a Hashtable mapping user profile ids (Integer objects) to the UserProfile objects |
putUserPreferences | public void putUserPreferences(IPerson person, UserPreferences up) throws Exception(Code) | | save user preferences
Parameters: person - User Parameters: up - user preferences object |
removeStructureStylesheetDescription | public void removeStructureStylesheetDescription(int stylesheetId) throws Exception(Code) | | removes stylesheet description
Parameters: stylesheetId - id of the stylesheet |
removeThemeStylesheetDescription | public void removeThemeStylesheetDescription(int stylesheetId) throws Exception(Code) | | Removes theme stylesheet
Parameters: stylesheetId - id of the stylesheet |
setStructureStylesheetUserPreferences | public void setStructureStylesheetUserPreferences(IPerson person, int profileId, StructureStylesheetUserPreferences fsup) throws Exception(Code) | | Save structure stylesheet user pferences
Parameters: person - User Parameters: profileId - profile id Parameters: fsup - structure stylesheet user preferences |
setSystemBrowserMapping | public void setSystemBrowserMapping(String userAgent, int systemProfileId) throws Exception(Code) | | establish system profile browser mapping
Parameters: userAgent - User-Agent header string Parameters: systemProfileId - profile id of a profile to which givenuser-agent will be mapped |
setThemeStylesheetUserPreferences | public void setThemeStylesheetUserPreferences(IPerson person, int profileId, ThemeStylesheetUserPreferences ssup) throws Exception(Code) | | Save theme stylesheet user preferences
Parameters: person - User Parameters: profileId - profile id Parameters: ssup - structure stylesheet user preferneces |
setUserBrowserMapping | public void setUserBrowserMapping(IPerson person, String userAgent, int profileId) throws Exception(Code) | | establish a browser - user profile mapping
Parameters: person - User Parameters: userAgent - User-Agent header string Parameters: profileId - profile id to which given user agent will be mapped |
setUserLayout | public void setUserLayout(IPerson Person, UserProfile profile, Document layoutXML, boolean channelsAdded) throws Exception(Code) | | Persist user layout document.
Parameters: Person - an IPerson object specifying the user Parameters: profile - a user profile for which the layout is being stored Parameters: layoutXML - a Document containing user layout (conforming to userLayout.dtd) Parameters: channelsAdded - a boolean flag specifying if new channels have been added to the current user layout (for performance optimization purposes) exception: Exception - if an error occurs |
updateStructureStylesheetDescription | public boolean updateStructureStylesheetDescription(String stylesheetDescriptionURI, String stylesheetURI, int stylesheetId)(Code) | | Updates an existing structure stylesheet description.
Parameters: stylesheetDescriptionURI - Location of the stylesheet description XML file Parameters: stylesheetURI - Location of the actual stylesshet XML file Parameters: stylesheetId - the id of the existing stylesheet description true if the update successful |
updateSystemProfile | public void updateSystemProfile(UserProfile profile) throws Exception(Code) | | update system profile
Parameters: profile - profile object |
updateThemeStylesheetDescription | public boolean updateThemeStylesheetDescription(String stylesheetDescriptionURI, String stylesheetURI, int stylesheetId) throws Exception(Code) | | Updates an existing theme stylesheet description.
Parameters: stylesheetDescriptionURI - Location of the stylesheet description XML file Parameters: stylesheetURI - Location of the actual stylesshet XML file Parameters: stylesheetId - the id of the existing stylesheet description true if the update successful |
updateUserProfile | public void updateUserProfile(IPerson person, UserProfile profile) throws Exception(Code) | | update user profile
Parameters: person - User Parameters: profile - profile update |
|
|