|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IAggregatedUserLayoutManager
An aggregated-layout specific extension of the user layout manager interface. 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.
Field Summary | |
---|---|
static java.lang.String |
NEW_FRAGMENT
|
static int |
PRIORITY_COEFF
|
Method Summary | |
---|---|
java.lang.String |
createFragment(java.lang.String fragmentName,
java.lang.String fragmentDesc,
java.lang.String fragmentRootName)
Creates a new fragment and loads it as an user layout |
void |
deleteFragment()
Deletes the current fragment if the layout is a fragment |
void |
deleteFragment(java.lang.String fragmentId)
Removes the fragment |
ILayoutFragment |
getFragment(java.lang.String fragmentId)
Returns the fragment |
java.util.Collection |
getFragments()
Returns the fragment Ids of the owner associated with the current layout |
IALNodeDescription |
getNodeBeingAdded()
Returns the description of the node currently being added to the layout |
IALNodeDescription |
getNodeBeingMoved()
Returns the description of the node currently being moved in the layout |
java.util.Collection |
getPublishGroups(java.lang.String fragmentId)
Returns the user group keys which the fragment is published to |
java.util.Collection |
getSubscribableFragments()
Returns the list of Ids of the fragments that the user can subscribe to |
boolean |
isFragmentLoaded()
Returns true if any fragment is currently loaded into the layout manager, false - otherwise |
void |
loadFragment(java.lang.String fragmentId)
Loads the fragment as an user layout given by fragmentId |
void |
saveFragment()
Saves the current fragment if the layout is a fragment |
void |
saveFragment(ILayoutFragment fragment)
Saves the fragment in the store |
void |
setAutoCommit(boolean autoCommit)
Sets a layout manager to auto-commit mode that allows to update the database immediately |
void |
setPublishGroups(IGroupMember[] groups,
java.lang.String fragmentId)
Persists the user groups which the fragment is published to |
Methods inherited from interface org.jasig.portal.layout.IUserLayoutManager |
---|
addLayoutEventListener, addNode, canAddNode, canDeleteNode, canMoveNode, canUpdateNode, createNodeDescription, deleteNode, getCacheKey, getChildIds, getDepth, getLayoutId, getNextSiblingId, getNode, getParentId, getPreviousSiblingId, getRootFolderId, getSubscribeId, getUserLayout, getUserLayout, getUserLayout, getUserLayoutDOM, loadUserLayout, markAddTargets, markMoveTargets, moveNode, removeLayoutEventListener, saveUserLayout, setLayoutStore, setUserLayout, updateNode |
Field Detail |
---|
static final java.lang.String NEW_FRAGMENT
static final int PRIORITY_COEFF
Method Detail |
---|
void setAutoCommit(boolean autoCommit)
autoCommit
- a boolean valuevoid saveFragment() throws PortalException
PortalException
- if an error occursvoid deleteFragment() throws PortalException
PortalException
- if an error occursvoid loadFragment(java.lang.String fragmentId) throws PortalException
fragmentId
- a fragment ID
PortalException
- if an error occursvoid saveFragment(ILayoutFragment fragment) throws PortalException
fragment
- a ILayoutFragment
instance
PortalException
- if an error occursvoid deleteFragment(java.lang.String fragmentId) throws PortalException
fragmentId
- a fragment ID
PortalException
- if an error occursjava.util.Collection getFragments() throws PortalException
Collection
a set of the fragment IDs
PortalException
- if an error occursjava.util.Collection getSubscribableFragments() throws PortalException
Collection
a set of the fragment IDs
PortalException
- if an error occursILayoutFragment getFragment(java.lang.String fragmentId) throws PortalException
fragmentId
- a fragment ID
ILayoutFragment
a fragment
PortalException
- if an error occursboolean isFragmentLoaded() throws PortalException
PortalException
- if an error occursIALNodeDescription getNodeBeingAdded() throws PortalException
IALNodeDescription
object
PortalException
- if an error occursIALNodeDescription getNodeBeingMoved() throws PortalException
IALNodeDescription
object
PortalException
- if an error occursjava.lang.String createFragment(java.lang.String fragmentName, java.lang.String fragmentDesc, java.lang.String fragmentRootName) throws PortalException
fragmentName
- a fragment namefragmentDesc
- a fragment descriptionfragmentRootName
- a fragment root node name
PortalException
- if an error occursjava.util.Collection getPublishGroups(java.lang.String fragmentId) throws PortalException
fragmentId
- a String
value
Colection
object containing the group keys
PortalException
- if an error occursvoid setPublishGroups(IGroupMember[] groups, java.lang.String fragmentId) throws PortalException
groups
- an array of IGroupMember
objectsfragmentId
- a String
value
PortalException
- if an error occurs
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |