|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jasig.portal.RDBMUserLayoutStore
SQL implementation for the 2.x relational database model
Constructor Summary | |
RDBMUserLayoutStore()
|
Method Summary | |
java.lang.Integer |
addStructureStylesheetDescription(java.lang.String stylesheetDescriptionURI,
java.lang.String stylesheetURI)
Add a structure stylesheet description |
java.lang.Integer |
addStructureStylesheetDescription(StructureStylesheetDescription ssd)
Registers a NEW structure stylesheet with the database. |
UserProfile |
addSystemProfile(UserProfile profile)
add a new system profile to the database. |
java.lang.Integer |
addThemeStylesheetDescription(java.lang.String stylesheetDescriptionURI,
java.lang.String stylesheetURI)
Add theme stylesheet description |
java.lang.Integer |
addThemeStylesheetDescription(ThemeStylesheetDescription tsd)
Registers a NEW theme stylesheet with the database. |
UserProfile |
addUserProfile(IPerson person,
UserProfile profile)
Add a user profile |
void |
deleteSystemProfile(int profileId)
remove system profile from the database |
void |
deleteUserProfile(IPerson person,
int profileId)
remove user profile from the database |
static void |
dumpDoc(org.w3c.dom.Node node,
java.lang.String indent)
Dump a document tree structure on stdout |
java.lang.String |
generateNewChannelSubscribeId(IPerson person)
Return the next available channel structure id for a user |
java.lang.String |
generateNewFolderId(IPerson person)
Return the next available folder structure id for a user |
java.util.Hashtable |
getMimeTypeList()
CoreStyleSheet |
StructureStylesheetDescription |
getStructureStylesheetDescription(int stylesheetId)
Obtain structure stylesheet description object for a given structure stylesheet id. |
java.lang.Integer |
getStructureStylesheetId(java.lang.String ssName)
Obtain ID for known structure stylesheet name |
java.util.Hashtable |
getStructureStylesheetList()
Obtain a list of strcture stylesheet descriptions registered on the system |
java.util.Hashtable |
getStructureStylesheetList(java.lang.String mimeType)
Obtain a list of structure stylesheet descriptions that have stylesheets for a given mime type. |
StructureStylesheetUserPreferences |
getStructureStylesheetUserPreferences(IPerson person,
int profileId,
int stylesheetId)
Obtain structure stylesheet user preferences |
UserProfile |
getSystemProfile(java.lang.String userAgent)
retreive a system profile associated with a given browser |
UserProfile |
getSystemProfileById(int profileId)
Obtain a system profile |
java.util.Hashtable |
getSystemProfileList()
obtain a list of system profiles |
ThemeStylesheetDescription |
getThemeStylesheetDescription(int stylesheetId)
Obtain theme stylesheet description object for a given theme stylesheet id. |
java.lang.Integer |
getThemeStylesheetId(java.lang.String tsName)
Obtain ID for known theme stylesheet name |
java.util.Hashtable |
getThemeStylesheetList()
Obtain a list of theme stylesheet descriptions registered on the system |
java.util.Hashtable |
getThemeStylesheetList(int structureStylesheetId)
Obtain a list of theme stylesheet descriptions for a given structure stylesheet |
ThemeStylesheetUserPreferences |
getThemeStylesheetUserPreferences(IPerson person,
int profileId,
int stylesheetId)
Obtain theme stylesheet user preferences |
org.w3c.dom.Document |
getUserLayout(IPerson person,
UserProfile profile)
Retreive a user layout document. |
UserPreferences |
getUserPreferences(IPerson person,
int profileId)
|
UserPreferences |
getUserPreferences(IPerson person,
UserProfile profile)
Retreive the entire UserPreferences object |
UserProfile |
getUserProfile(IPerson person,
java.lang.String userAgent)
Obtain user profile associated with a particular browser |
UserProfile |
getUserProfileById(IPerson person,
int profileId)
Obtains a user profile by profile id. |
java.util.Hashtable |
getUserProfileList(IPerson person)
retreive a list of profiles associated with a user |
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 ssup)
Save structure stylesheet user pferences |
void |
setSystemBrowserMapping(java.lang.String userAgent,
int profileId)
establish system profile browser mapping |
void |
setThemeStylesheetUserPreferences(IPerson person,
int profileId,
ThemeStylesheetUserPreferences tsup)
Save theme stylesheet user preferences |
void |
setUserBrowserMapping(IPerson person,
java.lang.String userAgent,
int profileId)
establish a browser - user profile mapping |
void |
setUserLayout(IPerson person,
UserProfile profile,
org.w3c.dom.Document layoutXML,
boolean channelsAdded)
Save the user layout. |
boolean |
updateStructureStylesheetDescription(java.lang.String stylesheetDescriptionURI,
java.lang.String stylesheetURI,
int stylesheetId)
Update the structure stylesheet description |
void |
updateStructureStylesheetDescription(StructureStylesheetDescription ssd)
Updates an existing structure stylesheet description with a new one. |
void |
updateSystemProfile(UserProfile profile)
update system profile |
boolean |
updateThemeStylesheetDescription(java.lang.String stylesheetDescriptionURI,
java.lang.String stylesheetURI,
int stylesheetId)
Update the theme stylesheet description. |
void |
updateThemeStylesheetDescription(ThemeStylesheetDescription tsd)
Updates an existing structure stylesheet description with a new one. |
void |
updateUserProfile(IPerson person,
UserProfile profile)
update user profile |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public RDBMUserLayoutStore() throws java.lang.Exception
Method Detail |
public java.lang.Integer addStructureStylesheetDescription(StructureStylesheetDescription ssd) throws java.lang.Exception
ssd
- the Stylesheet description object
Integer
id for the registered Stylesheet description object
java.lang.Exception
public java.lang.Integer addThemeStylesheetDescription(ThemeStylesheetDescription tsd) throws java.lang.Exception
tsd
- Stylesheet description object
Integer
id of the registered Theme Stylesheet if successful;
null
otherwise.
java.lang.Exception
public boolean updateThemeStylesheetDescription(java.lang.String stylesheetDescriptionURI, java.lang.String stylesheetURI, int stylesheetId)
updateThemeStylesheetDescription
in interface IUserLayoutStore
stylesheetDescriptionURI
- stylesheetURI
- stylesheetId
-
public boolean updateStructureStylesheetDescription(java.lang.String stylesheetDescriptionURI, java.lang.String stylesheetURI, int stylesheetId)
updateStructureStylesheetDescription
in interface IUserLayoutStore
stylesheetDescriptionURI
- stylesheetURI
- stylesheetId
-
public java.lang.Integer addStructureStylesheetDescription(java.lang.String stylesheetDescriptionURI, java.lang.String stylesheetURI)
addStructureStylesheetDescription
in interface IUserLayoutStore
stylesheetDescriptionURI
- stylesheetURI
-
Integer
id of the registered Structure Stylesheet description object if successful;
null
otherwise.public java.lang.Integer addThemeStylesheetDescription(java.lang.String stylesheetDescriptionURI, java.lang.String stylesheetURI)
addThemeStylesheetDescription
in interface IUserLayoutStore
stylesheetDescriptionURI
- stylesheetURI
-
Integer
id of the registered Theme Stylesheet if successful;
null
otherwise.public UserProfile addUserProfile(IPerson person, UserProfile profile) throws java.lang.Exception
addUserProfile
in interface IUserLayoutStore
person
- profile
-
java.lang.Exception
public void deleteUserProfile(IPerson person, int profileId) throws java.lang.Exception
IUserLayoutStore
deleteUserProfile
in interface IUserLayoutStore
person
- UserprofileId
- profile id
java.lang.Exception
public static final void dumpDoc(org.w3c.dom.Node node, java.lang.String indent)
node
- indent
- public java.util.Hashtable getMimeTypeList() throws java.lang.Exception
getMimeTypeList
in interface IUserLayoutStore
java.lang.Exception
public java.lang.String generateNewChannelSubscribeId(IPerson person) throws java.lang.Exception
generateNewChannelSubscribeId
in interface IUserLayoutStore
person
-
java.lang.Exception
- if an error occurspublic java.lang.String generateNewFolderId(IPerson person) throws java.lang.Exception
generateNewFolderId
in interface IUserLayoutStore
person
-
String
that is the next free structure ID
java.lang.Exception
public StructureStylesheetDescription getStructureStylesheetDescription(int stylesheetId) throws java.lang.Exception
getStructureStylesheetDescription
in interface IUserLayoutStore
stylesheetId
- the id of the structure stylesheet
java.lang.Exception
public java.lang.Integer getStructureStylesheetId(java.lang.String ssName) throws java.lang.Exception
ssName
- name of the structure stylesheet
java.lang.Exception
public java.util.Hashtable getStructureStylesheetList(java.lang.String mimeType) throws java.lang.Exception
getStructureStylesheetList
in interface IUserLayoutStore
mimeType
-
java.lang.Exception
public java.util.Hashtable getStructureStylesheetList() throws java.lang.Exception
getStructureStylesheetList
in interface IUserLayoutStore
Hashtable
mapping stylesheet id (Integer
objects) to StructureStylesheetDescription
objects
java.lang.Exception
public StructureStylesheetUserPreferences getStructureStylesheetUserPreferences(IPerson person, int profileId, int stylesheetId) throws java.lang.Exception
IUserLayoutStore
getStructureStylesheetUserPreferences
in interface IUserLayoutStore
person
- UserprofileId
- profile idstylesheetId
- structure stylesheet id
java.lang.Exception
public ThemeStylesheetDescription getThemeStylesheetDescription(int stylesheetId) throws java.lang.Exception
getThemeStylesheetDescription
in interface IUserLayoutStore
stylesheetId
- the id of the theme stylesheet
java.lang.Exception
public java.lang.Integer getThemeStylesheetId(java.lang.String tsName) throws java.lang.Exception
tsName
- name of the theme stylesheet
java.lang.Exception
public java.util.Hashtable getThemeStylesheetList(int structureStylesheetId) throws java.lang.Exception
getThemeStylesheetList
in interface IUserLayoutStore
structureStylesheetId
-
java.lang.Exception
public java.util.Hashtable getThemeStylesheetList() throws java.lang.Exception
getThemeStylesheetList
in interface IUserLayoutStore
Hashtable
mapping stylesheet id (Integer
objects) to ThemeStylesheetDescription
objects
java.lang.Exception
public ThemeStylesheetUserPreferences getThemeStylesheetUserPreferences(IPerson person, int profileId, int stylesheetId) throws java.lang.Exception
IUserLayoutStore
getThemeStylesheetUserPreferences
in interface IUserLayoutStore
person
- UserprofileId
- profile idstylesheetId
- theme stylesheet id
java.lang.Exception
public org.w3c.dom.Document getUserLayout(IPerson person, UserProfile profile) throws java.lang.Exception
IUserLayoutStore
getUserLayout
in interface IUserLayoutStore
person
- an IPerson
object specifying the userprofile
- a user profile
Document
containing user layout (conforms to userLayout.dtd)
java.lang.Exception
- if an error occurspublic UserProfile getUserProfileById(IPerson person, int profileId) throws java.lang.Exception
IUserLayoutStore
getUserProfileById
in interface IUserLayoutStore
person
- an IPerson
object representing the userprofileId
- profile id
java.lang.Exception
public java.util.Hashtable getUserProfileList(IPerson person) throws java.lang.Exception
IUserLayoutStore
getUserProfileList
in interface IUserLayoutStore
person
- User
Hashtable
mapping user profile ids (Integer
objects) to the UserProfile
objects
java.lang.Exception
public void removeStructureStylesheetDescription(int stylesheetId) throws java.lang.Exception
IUserLayoutStore
removeStructureStylesheetDescription
in interface IUserLayoutStore
stylesheetId
- id of the stylesheet
java.lang.Exception
public void removeThemeStylesheetDescription(int stylesheetId) throws java.lang.Exception
IUserLayoutStore
removeThemeStylesheetDescription
in interface IUserLayoutStore
stylesheetId
- id of the stylesheet
java.lang.Exception
public void setStructureStylesheetUserPreferences(IPerson person, int profileId, StructureStylesheetUserPreferences ssup) throws java.lang.Exception
IUserLayoutStore
setStructureStylesheetUserPreferences
in interface IUserLayoutStore
person
- UserprofileId
- profile idssup
- structure stylesheet user preferences
java.lang.Exception
public void setThemeStylesheetUserPreferences(IPerson person, int profileId, ThemeStylesheetUserPreferences tsup) throws java.lang.Exception
IUserLayoutStore
setThemeStylesheetUserPreferences
in interface IUserLayoutStore
person
- UserprofileId
- profile idtsup
- structure stylesheet user preferneces
java.lang.Exception
public void setUserBrowserMapping(IPerson person, java.lang.String userAgent, int profileId) throws java.lang.Exception
IUserLayoutStore
setUserBrowserMapping
in interface IUserLayoutStore
person
- UseruserAgent
- User-Agent header stringprofileId
- profile id to which given user agent will be mapped
java.lang.Exception
public void setUserLayout(IPerson person, UserProfile profile, org.w3c.dom.Document layoutXML, boolean channelsAdded) throws java.lang.Exception
setUserLayout
in interface IUserLayoutStore
person
- profile
- layoutXML
- channelsAdded
- a boolean flag specifying if new channels have been added to the current user layout (for performance optimization purposes)
java.lang.Exception
public void updateStructureStylesheetDescription(StructureStylesheetDescription ssd) throws java.lang.Exception
ssd
- new stylesheet description
java.lang.Exception
public void updateThemeStylesheetDescription(ThemeStylesheetDescription tsd) throws java.lang.Exception
tsd
- new theme stylesheet description
java.lang.Exception
public void updateUserProfile(IPerson person, UserProfile profile) throws java.lang.Exception
IUserLayoutStore
updateUserProfile
in interface IUserLayoutStore
person
- Userprofile
- profile update
java.lang.Exception
public void setSystemBrowserMapping(java.lang.String userAgent, int profileId) throws java.lang.Exception
IUserLayoutStore
setSystemBrowserMapping
in interface IUserLayoutStore
userAgent
- User-Agent header stringprofileId
- profile id of a profile to which given
user-agent will be mapped
java.lang.Exception
public UserProfile getUserProfile(IPerson person, java.lang.String userAgent) throws java.lang.Exception
IUserLayoutStore
getUserProfile
in interface IUserLayoutStore
person
- UseruserAgent
- User-Agent header string
null
if no user profiles are associated with the given user agent.
java.lang.Exception
public UserProfile getSystemProfile(java.lang.String userAgent) throws java.lang.Exception
IUserLayoutStore
getSystemProfile
in interface IUserLayoutStore
userAgent
- User-Agent header string
java.lang.Exception
public UserProfile getSystemProfileById(int profileId) throws java.lang.Exception
IUserLayoutStore
getSystemProfileById
in interface IUserLayoutStore
profileId
- system profile id
java.lang.Exception
public java.util.Hashtable getSystemProfileList() throws java.lang.Exception
IUserLayoutStore
getSystemProfileList
in interface IUserLayoutStore
Hashtable
mapping system profile ids (Integer
objects) to the UserProfile
objects
java.lang.Exception
public void updateSystemProfile(UserProfile profile) throws java.lang.Exception
IUserLayoutStore
updateSystemProfile
in interface IUserLayoutStore
profile
- profile object
java.lang.Exception
public UserProfile addSystemProfile(UserProfile profile) throws java.lang.Exception
IUserLayoutStore
addSystemProfile
in interface IUserLayoutStore
profile
- profile object (profile id within will be overwritten)
java.lang.Exception
public void deleteSystemProfile(int profileId) throws java.lang.Exception
IUserLayoutStore
deleteSystemProfile
in interface IUserLayoutStore
profileId
- profile id
java.lang.Exception
public UserPreferences getUserPreferences(IPerson person, int profileId) throws java.lang.Exception
java.lang.Exception
public UserPreferences getUserPreferences(IPerson person, UserProfile profile) throws java.lang.Exception
IUserLayoutStore
getUserPreferences
in interface IUserLayoutStore
person
- Userprofile
- profile
java.lang.Exception
public void putUserPreferences(IPerson person, UserPreferences up) throws java.lang.Exception
IUserLayoutStore
putUserPreferences
in interface IUserLayoutStore
person
- Userup
- user preferences object
java.lang.Exception
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |