|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IAggregatedUserLayoutStore
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.
Method Summary | |
---|---|
ALNode |
addUserLayoutNode(IPerson person,
UserProfile profile,
ALNode node)
Add the new user layout node. |
void |
deleteFragment(IPerson person,
java.lang.String fragmentId)
Deletes the fragment that has been loaded as a layout. |
boolean |
deleteUserLayoutNode(IPerson person,
UserProfile profile,
ALNode node)
Update the new user layout node. |
IAggregatedLayout |
getAggregatedLayout(IPerson person,
UserProfile profile)
Returns the user layout internal representation. |
ILayoutFragment |
getFragment(IPerson person,
java.lang.String fragmentId)
Returns the layout fragment as a user layout. |
java.util.Map |
getFragments(IPerson person)
Returns the fragment IDs/names which the user is an owner of |
java.lang.String |
getNextFragmentId()
Returns the next fragment ID |
int[] |
getPriorityRange(java.lang.String groupKey)
Returns the priority range defined for the given user group |
java.util.Collection |
getPublishGroups(IPerson person,
java.lang.String fragmentId)
Returns the user group keys which the fragment is published to |
java.util.Collection |
getSubscribableFragments(IPerson person)
Returns the list of Ids of the fragments that the user can subscribe to |
ALNode |
getUserLayoutNode(IPerson person,
UserProfile profile,
java.lang.String nodeId)
Gets the user layout node. |
void |
setAggregatedLayout(IPerson person,
UserProfile profile,
IAggregatedLayout layout)
Persists user layout document. |
void |
setFragment(IPerson person,
ILayoutFragment layoutImpl)
Persists the fragment |
void |
setPublishGroups(IGroupMember[] groups,
IPerson person,
java.lang.String fragmentId)
Persists the user groups which the fragment is published to |
boolean |
updateUserLayoutNode(IPerson person,
UserProfile profile,
ALNode node)
Update the new user layout node. |
Method Detail |
---|
ALNode addUserLayoutNode(IPerson person, UserProfile profile, ALNode node) throws PortalException
person
- an IPerson
object specifying the userprofile
- a user profile for which the layout is being storednode
- a ALNode
object specifying the node
ALNode
object specifying the node with the generated node ID
PortalException
- if an error occursboolean updateUserLayoutNode(IPerson person, UserProfile profile, ALNode node) throws PortalException
person
- an IPerson
object specifying the userprofile
- a user profile for which the layout is being storednode
- a ALNode
object specifying the node
PortalException
- if an error occursboolean deleteUserLayoutNode(IPerson person, UserProfile profile, ALNode node) throws PortalException
person
- an IPerson
object specifying the userprofile
- a user profile for which the layout is being storednode
- a ALNode
node ID specifying the node
PortalException
- if an error occursALNode getUserLayoutNode(IPerson person, UserProfile profile, java.lang.String nodeId) throws PortalException
person
- an IPerson
object specifying the userprofile
- a user profile for which the layout is being storednodeId
- a String
node ID specifying the node
ALNode
object
PortalException
- if an error occursIAggregatedLayout getAggregatedLayout(IPerson person, UserProfile profile) throws PortalException
person
- an IPerson
object specifying the userprofile
- a user profile for which the layout is being stored
IAggregatedLayout
object containing the internal representation of the user layout
PortalException
- if an error occursvoid setAggregatedLayout(IPerson person, UserProfile profile, IAggregatedLayout layout) throws PortalException
person
- an IPerson
object specifying the userprofile
- a user profile for which the layout is being storedlayout
- a IAggregatedLayout
containing an aggregated user layout
PortalException
- if an error occursvoid setFragment(IPerson person, ILayoutFragment layoutImpl) throws PortalException
person
- an IPerson
object specifying the userlayoutImpl
- a ILayoutFragment
object containing a fragment
PortalException
- if an error occursILayoutFragment getFragment(IPerson person, java.lang.String fragmentId) throws PortalException
person
- an IPerson
object specifying the userfragmentId
- a fragment ID
ILayoutFragment
object containing the internal representation of the user fragment
PortalException
- if an error occursvoid deleteFragment(IPerson person, java.lang.String fragmentId) throws PortalException
person
- an IPerson
object specifying the userfragmentId
- a fragment ID
PortalException
- if an error occursjava.util.Map getFragments(IPerson person) throws PortalException
person
- an IPerson
object specifying the user
Map
object containing the fragment IDs
PortalException
- if an error occursjava.util.Collection getSubscribableFragments(IPerson person) throws PortalException
person
- an IPerson
object specifying the user
Collection
a set of the fragment IDs
PortalException
- if an error occursjava.util.Collection getPublishGroups(IPerson person, java.lang.String fragmentId) throws PortalException
person
- an IPerson
object specifying the userfragmentId
- a String
value
Collection
object containing the group keys
PortalException
- if an error occursvoid setPublishGroups(IGroupMember[] groups, IPerson person, java.lang.String fragmentId) throws PortalException
groups
- an array of IGroupMember
objectsperson
- an IPerson
object specifying the userfragmentId
- a String
value
PortalException
- if an error occursjava.lang.String getNextFragmentId() throws PortalException
String
next fragment ID
PortalException
- if an error occursint[] getPriorityRange(java.lang.String groupKey) throws PortalException
groupKey
- a String
group key
PortalException
- if an error occurs
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |