|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Method Summary | |
java.lang.Integer |
addStructureStylesheetDescription(java.lang.String stylesheetDescriptionURI,
java.lang.String stylesheetURI)
Registers new structure stylesheet with the portal 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)
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 |
java.lang.String |
generateNewChannelSubscribeId(IPerson person)
Generate an instance id for a channel being added to the user layout |
java.lang.String |
generateNewFolderId(IPerson person)
Generate a folder id for a folder being added to the user layout |
java.util.Hashtable |
getMimeTypeList()
Obtains a list of mime types available on the installation |
StructureStylesheetDescription |
getStructureStylesheetDescription(int stylesheetId)
Obtains a complete description of the structure stylesheet |
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 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(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)
Obtains a complete description of a theme stylesheet |
java.util.Hashtable |
getThemeStylesheetList()
Obtain a list of theme stylesheet descriptions registered on the system |
java.util.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 |
org.w3c.dom.Document |
getUserLayout(IPerson Person,
UserProfile profile)
Retreive a user layout document. |
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 fsup)
Save structure stylesheet user pferences |
void |
setSystemBrowserMapping(java.lang.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,
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)
Persist user layout document. |
boolean |
updateStructureStylesheetDescription(java.lang.String stylesheetDescriptionURI,
java.lang.String stylesheetURI,
int stylesheetId)
Updates an existing structure stylesheet description. |
void |
updateSystemProfile(UserProfile profile)
update system profile |
boolean |
updateThemeStylesheetDescription(java.lang.String stylesheetDescriptionURI,
java.lang.String stylesheetURI,
int stylesheetId)
Updates an existing theme stylesheet description. |
void |
updateUserProfile(IPerson person,
UserProfile profile)
update user profile |
Method Detail |
public org.w3c.dom.Document getUserLayout(IPerson Person, UserProfile profile) throws java.lang.Exception
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 void setUserLayout(IPerson Person, UserProfile profile, org.w3c.dom.Document layoutXML, boolean channelsAdded) throws java.lang.Exception
Person
- an IPerson
object specifying the userprofile
- a user profile for which the layout is being storedlayoutXML
- 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)
java.lang.Exception
- if an error occurspublic UserProfile getUserProfile(IPerson person, java.lang.String userAgent) throws java.lang.Exception
person
- UseruserAgent
- User-Agent header string
null
if no user profiles are associated with the given user agent.
java.lang.Exception
public void updateUserProfile(IPerson person, UserProfile profile) throws java.lang.Exception
person
- Userprofile
- profile update
java.lang.Exception
public void deleteUserProfile(IPerson person, int profileId) throws java.lang.Exception
person
- UserprofileId
- profile id
java.lang.Exception
public UserProfile addUserProfile(IPerson person, UserProfile profile) throws java.lang.Exception
person
- Userprofile
- profile object (profile id in this object will be
overwritten)
java.lang.Exception
public UserProfile getUserProfileById(IPerson person, int profileId) throws java.lang.Exception
person
- an IPerson
object representing the userprofileId
- profile id
java.lang.Exception
public java.util.Hashtable getUserProfileList(IPerson person) throws java.lang.Exception
person
- User
Hashtable
mapping user profile ids (Integer
objects) to the UserProfile
objects
java.lang.Exception
public UserProfile getSystemProfile(java.lang.String userAgent) throws java.lang.Exception
userAgent
- User-Agent header string
java.lang.Exception
public void updateSystemProfile(UserProfile profile) throws java.lang.Exception
profile
- profile object
java.lang.Exception
public void deleteSystemProfile(int profileId) throws java.lang.Exception
profileId
- profile id
java.lang.Exception
public UserProfile addSystemProfile(UserProfile profile) throws java.lang.Exception
profile
- profile object (profile id within will be overwritten)
java.lang.Exception
public UserProfile getSystemProfileById(int profileId) throws java.lang.Exception
profileId
- system profile id
java.lang.Exception
public java.util.Hashtable getSystemProfileList() throws java.lang.Exception
Hashtable
mapping system profile ids (Integer
objects) to the UserProfile
objects
java.lang.Exception
public void setUserBrowserMapping(IPerson person, java.lang.String userAgent, int profileId) throws java.lang.Exception
person
- UseruserAgent
- User-Agent header stringprofileId
- profile id to which given user agent will be mapped
java.lang.Exception
public void setSystemBrowserMapping(java.lang.String userAgent, int systemProfileId) throws java.lang.Exception
userAgent
- User-Agent header stringsystemProfileId
- profile id of a profile to which given
user-agent will be mapped
java.lang.Exception
public UserPreferences getUserPreferences(IPerson person, UserProfile profile) throws java.lang.Exception
person
- Userprofile
- profile
java.lang.Exception
public void putUserPreferences(IPerson person, UserPreferences up) throws java.lang.Exception
person
- Userup
- user preferences object
java.lang.Exception
public StructureStylesheetUserPreferences getStructureStylesheetUserPreferences(IPerson person, int profileId, int stylesheetId) throws java.lang.Exception
person
- UserprofileId
- profile idstylesheetId
- structure stylesheet id
java.lang.Exception
public ThemeStylesheetUserPreferences getThemeStylesheetUserPreferences(IPerson person, int profileId, int stylesheetId) throws java.lang.Exception
person
- UserprofileId
- profile idstylesheetId
- theme stylesheet id
java.lang.Exception
public void setStructureStylesheetUserPreferences(IPerson person, int profileId, StructureStylesheetUserPreferences fsup) throws java.lang.Exception
person
- UserprofileId
- profile idfsup
- structure stylesheet user preferences
java.lang.Exception
public void setThemeStylesheetUserPreferences(IPerson person, int profileId, ThemeStylesheetUserPreferences ssup) throws java.lang.Exception
person
- UserprofileId
- profile idssup
- structure stylesheet user preferneces
java.lang.Exception
public java.lang.String generateNewChannelSubscribeId(IPerson person) throws java.lang.Exception
person
- an IPerson
value
String
value
java.lang.Exception
- if an error occurspublic java.lang.String generateNewFolderId(IPerson person) throws java.lang.Exception
person
- an IPerson
value
String
value
java.lang.Exception
- if an error occurspublic java.util.Hashtable getStructureStylesheetList(java.lang.String mimeType) throws java.lang.Exception
mimeType
- mime type that should be supported
Hashtable
mapping stylesheet id (Integer
objects) to StructureStylesheetDescription
objects
java.lang.Exception
public java.util.Hashtable getThemeStylesheetList(int structureStylesheetId) throws java.lang.Exception
structureStylesheetId
- id of the structure stylehsset
Hashtable
mapping stylesheet id (Integer
objects) to ThemeStylesheetDescription
objects
java.lang.Exception
public java.util.Hashtable getStructureStylesheetList() throws java.lang.Exception
Hashtable
mapping stylesheet id (Integer
objects) to StructureStylesheetDescription
objects
java.lang.Exception
public java.util.Hashtable getThemeStylesheetList() throws java.lang.Exception
Hashtable
mapping stylesheet id (Integer
objects) to ThemeStylesheetDescription
objects
java.lang.Exception
public java.util.Hashtable getMimeTypeList() throws java.lang.Exception
java.lang.Exception
public StructureStylesheetDescription getStructureStylesheetDescription(int stylesheetId) throws java.lang.Exception
stylesheetId
- id of the structure stylesheet
java.lang.Exception
public ThemeStylesheetDescription getThemeStylesheetDescription(int stylesheetId) throws java.lang.Exception
stylesheetId
- id of a theme stylesheet
java.lang.Exception
public void removeStructureStylesheetDescription(int stylesheetId) throws java.lang.Exception
stylesheetId
- id of the stylesheet
java.lang.Exception
public void removeThemeStylesheetDescription(int stylesheetId) throws java.lang.Exception
stylesheetId
- id of the stylesheet
java.lang.Exception
public java.lang.Integer addStructureStylesheetDescription(java.lang.String stylesheetDescriptionURI, java.lang.String stylesheetURI) throws java.lang.Exception
stylesheetDescriptionURI
- Location of the stylesheet description XML filestylesheetURI
- Location of the actual stylesshet XML file
java.lang.Exception
public boolean updateStructureStylesheetDescription(java.lang.String stylesheetDescriptionURI, java.lang.String stylesheetURI, int stylesheetId)
stylesheetDescriptionURI
- Location of the stylesheet description XML filestylesheetURI
- Location of the actual stylesshet XML filestylesheetId
- the id of the existing stylesheet description
public boolean updateThemeStylesheetDescription(java.lang.String stylesheetDescriptionURI, java.lang.String stylesheetURI, int stylesheetId) throws java.lang.Exception
stylesheetDescriptionURI
- Location of the stylesheet description XML filestylesheetURI
- Location of the actual stylesshet XML filestylesheetId
- the id of the existing stylesheet description
java.lang.Exception
public java.lang.Integer addThemeStylesheetDescription(java.lang.String stylesheetDescriptionURI, java.lang.String stylesheetURI) throws java.lang.Exception
stylesheetDescriptionURI
- Location of the stylesheet description
XML filestylesheetURI
- Location of the actual stylesheet XML file
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 |