| org.jasig.portal.layout.alm.IAggregatedUserLayoutStore
All known Subclasses: org.jasig.portal.layout.alm.AggregatedUserLayoutStore,
| IAggregatedUserLayoutStore | | public interface IAggregatedUserLayoutStore extends IUserLayoutStore(Code) | | IAggregatedUserLayoutStore defines the base methods working with aggregated user layout store.
Prior to uPortal 2.5, this class existed in the package org.jasig.portal.layout.
It was moved to its present package to reflect that it is part of Aggregated
Layouts.
author:
Michael Ivanov
version:
$Revision: 36812 $ |
| Method Summary | |
| public ALNode | addUserLayoutNode(IPerson person, UserProfile profile, ALNode node)
Add the new user layout node. | | public void | deleteFragment(IPerson person, String fragmentId)
Deletes the fragment that has been loaded as a layout. | | public IAggregatedLayout | getAggregatedLayout(IPerson person, UserProfile profile)
Returns the user layout internal representation. | | public ILayoutFragment | getFragment(IPerson person, String fragmentId)
Returns the layout fragment as a user layout. | | public Map | getFragments(IPerson person)
| | public String | getNextFragmentId()
| | public int[] | getPriorityRange(String groupKey)
| | public Collection | getPublishGroups(IPerson person, String fragmentId)
| | public Collection | getSubscribableFragments(IPerson person)
| | public void | setAggregatedLayout(IPerson person, UserProfile profile, IAggregatedLayout layout)
Persists user layout document. | | public void | setFragment(IPerson person, ILayoutFragment layoutImpl, UserPreferences userPrefs)
| | public void | setPublishGroups(IGroupMember[] groups, IPerson person, String fragmentId)
|
| addUserLayoutNode | | public ALNode addUserLayoutNode(IPerson person, UserProfile profile, ALNode node) throws PortalException(Code) | | Add the new user layout node.
Parameters:
person - an IPerson object specifying the user
Parameters:
profile - a user profile for which the layout is being stored
Parameters:
node - a ALNode object specifying the node a ALNode object specifying the node with the generated node ID
exception:
PortalException - if an error occurs |
| deleteFragment | | public void deleteFragment(IPerson person, String fragmentId) throws PortalException(Code) | | Deletes the fragment that has been loaded as a layout.
Parameters:
person - an IPerson object specifying the user
Parameters:
fragmentId - a fragment ID
exception:
PortalException - if an error occurs |
| getAggregatedLayout | | public IAggregatedLayout getAggregatedLayout(IPerson person, UserProfile profile) throws PortalException(Code) | | Returns the user layout internal representation.
Parameters:
person - an IPerson object specifying the user
Parameters:
profile - a user profile for which the layout is being stored a IAggregatedLayout object containing the internal representation of the user layout
exception:
PortalException - if an error occurs |
| getFragment | | public ILayoutFragment getFragment(IPerson person, String fragmentId) throws PortalException(Code) | | Returns the layout fragment as a user layout.
Parameters:
person - an IPerson object specifying the user
Parameters:
fragmentId - a fragment ID a ILayoutFragment object containing the internal representation of the user fragment
exception:
PortalException - if an error occurs |
| getFragments | | public Map getFragments(IPerson person) throws PortalException(Code) | | Returns the fragment IDs/names which the user is an owner of
Parameters:
person - an IPerson object specifying the user a Map object containing the fragment IDs
exception:
PortalException - if an error occurs |
| getPriorityRange | | public int[] getPriorityRange(String groupKey) throws PortalException(Code) | | Returns the priority range defined for the given user group
Parameters:
groupKey - a String group key a int array containing the min and max priority values
exception:
PortalException - if an error occurs |
| getPublishGroups | | public Collection getPublishGroups(IPerson person, String fragmentId) throws PortalException(Code) | | Returns the user group keys which the fragment is published to
Parameters:
person - an IPerson object specifying the user
Parameters:
fragmentId - a String value a Collection object containing the group keys
exception:
PortalException - if an error occurs |
| getSubscribableFragments | | public Collection getSubscribableFragments(IPerson person) throws PortalException(Code) | | Returns the list of Ids of the fragments that the user can subscribe to
Parameters:
person - an IPerson object specifying the user Collection a set of the fragment IDs
exception:
PortalException - if an error occurs |
| setAggregatedLayout | | public void setAggregatedLayout(IPerson person, UserProfile profile, IAggregatedLayout layout) throws PortalException(Code) | | Persists user layout document.
Parameters:
person - an IPerson object specifying the user
Parameters:
profile - a user profile for which the layout is being stored
Parameters:
layout - a IAggregatedLayout containing an aggregated user layout
exception:
PortalException - if an error occurs |
| setFragment | | public void setFragment(IPerson person, ILayoutFragment layoutImpl, UserPreferences userPrefs) throws PortalException(Code) | | Persists the fragment
Parameters:
person - an IPerson object specifying the user
Parameters:
layoutImpl - a ILayoutFragment object containing a fragment
Parameters:
userPrefs - a UserPreferences object containing user preferences for column width persistance
exception:
PortalException - if an error occurs |
| setPublishGroups | | public void setPublishGroups(IGroupMember[] groups, IPerson person, String fragmentId) throws PortalException(Code) | | Persists the user groups which the fragment is published to
Parameters:
groups - an array of IGroupMember objects
Parameters:
person - an IPerson object specifying the user
Parameters:
fragmentId - a String value
exception:
PortalException - if an error occurs |
|
|