Java Doc for AggregatedLayoutManager.java in  » Portal » uPortal_rel-2-6-1-GA » org » jasig » portal » layout » alm » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation 1.  6.0 JDK Core 2.  6.0 JDK Modules 3.  6.0 JDK Modules com.sun 4.  6.0 JDK Modules com.sun.java 5.  6.0 JDK Modules sun 6.  6.0 JDK Platform 7.  Ajax 8.  Apache Harmony Java SE 9.  Aspect oriented 10.  Authentication Authorization 11.  Blogger System 12.  Build 13.  Byte Code 14.  Cache 15.  Chart 16.  Chat 17.  Code Analyzer 18.  Collaboration 19.  Content Management System 20.  Database Client 21.  Database DBMS 22.  Database JDBC Connection Pool 23.  Database ORM 24.  Development 25.  EJB Server geronimo 26.  EJB Server GlassFish 27.  EJB Server JBoss 4.2.1 28.  EJB Server resin 3.1.5 29.  ERP CRM Financial 30.  ESB 31.  Forum 32.  GIS 33.  Graphic Library 34.  Groupware 35.  HTML Parser 36.  IDE 37.  IDE Eclipse 38.  IDE Netbeans 39.  Installer 40.  Internationalization Localization 41.  Inversion of Control 42.  Issue Tracking 43.  J2EE 44.  JBoss 45.  JMS 46.  JMX 47.  Library 48.  Mail Clients 49.  Net 50.  Parser 51.  PDF 52.  Portal 53.  Profiler 54.  Project Management 55.  Report 56.  RSS RDF 57.  Rule Engine 58.  Science 59.  Scripting 60.  Search Engine 61.  Security 62.  Sevlet Container 63.  Source Control 64.  Swing Library 65.  Template Engine 66.  Test Coverage 67.  Testing 68.  UML 69.  Web Crawler 70.  Web Framework 71.  Web Mail 72.  Web Server 73.  Web Services 74.  Web Services apache cxf 2.0.1 75.  Web Services AXIS2 76.  Wiki Engine 77.  Workflow Engines 78.  XML 79.  XML UI Java Java Tutorial Java Open Source Jar File Download Java Articles Java Products Java by API Photoshop Tutorials Maya Tutorials Flash Tutorials 3ds-Max Tutorials Illustrator Tutorials GIMP Tutorials C# / C Sharp C# / CSharp Tutorial C# / CSharp Open Source ASP.Net ASP.NET Tutorial JavaScript DHTML JavaScript Tutorial JavaScript Reference HTML / CSS HTML CSS Reference C / ANSI-C C Tutorial C++ C++ Tutorial Ruby PHP Python Python Tutorial Python Open Source SQL Server / T-SQL SQL Server / T-SQL Tutorial Oracle PL / SQL Oracle PL/SQL Tutorial PostgreSQL SQL / MySQL MySQL Tutorial VB.Net VB.Net Tutorial Flash / Flex / ActionScript VBA / Excel / Access / Word XML XML Tutorial Microsoft Office PowerPoint 2007 Tutorial Microsoft Office Excel 2007 Tutorial Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Portal » uPortal_rel 2 6 1 GA » org.jasig.portal.layout.alm   Source Cross Reference   Class Diagram   Java Document (Java Doc)   java.lang.Object    org.jasig.portal.layout.alm.AggregatedLayoutManager AggregatedLayoutManager public class AggregatedLayoutManager implements IAggregatedUserLayoutManager(Code) An implementation of Aggregated User Layout Manager Interface defining common operations on user layout nodes, that is channels and folders. 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 $ Constructor Summary public   AggregatedLayoutManager(IPerson person, UserProfile userProfile)      public   AggregatedLayoutManager(IPerson person, UserProfile userProfile, IUserLayoutStore layoutStore)      Method Summary public  boolean addLayoutEventListener(LayoutEventListener l)      public synchronized  IUserLayoutNodeDescription addNode(IUserLayoutNodeDescription nodeDesc, String parentId, String nextSiblingId)      public  boolean canAddNode(IUserLayoutNodeDescription nodeDesc, String parentId, String nextSiblingId)      public  boolean canDeleteNode(String nodeId)      public  boolean canMoveNode(String nodeId, String parentId, String nextSiblingId)      public  boolean canUpdateNode(IUserLayoutNodeDescription nodeDescription)      protected  boolean changeSiblingNodesOrder(String firstNodeId)      protected  boolean changeSiblingNodesPriorities(String nodeId)      protected  boolean changeSiblingNodesPriorities(Vector nodes)      protected synchronized  boolean changeSiblingNodesPriorities(ALNode node, String parentNodeId, String nextNodeId)      public  String createFragment(String fragmentName, String fragmentDesc, String fragmentRootName)      public  IUserLayoutNodeDescription createNodeDescription(int nodeType)      public  void deleteFragment(String fragmentId)      public  void deleteFragment()      public synchronized  boolean deleteNode(String nodeId)      public  String getCacheKey()      Return a cache key, uniqly corresponding to the composition and the structure of the user layout. public  Enumeration getChildIds(String nodeId)      Returns a list of child node Ids for a given node. public  int getDepth(String nodeId)      public  ILayoutFragment getFragment(String fragmentId)      public  Collection getFragments()      public  int getLayoutId()      Returns an Id of the current user layout. public  String getLostFolderXML()      public  String getNextSiblingId(String nodeId)      Determine an Id of a next sibling node. public  IUserLayoutNodeDescription getNode(String nodeId)      public  IALNodeDescription getNodeBeingAdded()      public  IALNodeDescription getNodeBeingMoved()      public  String getParentId(String nodeId)      Returns an Id of a parent user layout node. public  String getPreviousSiblingId(String nodeId)      Determine an Id of a previous sibling node. public static  PriorityRestriction getPriorityRestriction(ALNode node)      Return a priority restriction for the given node. public  Collection getPublishGroups(String fragmentId)      public  String getRootFolderId()      Returns an id of the root folder. public  Collection getSubscribableFragments()      public  String getSubscribeId(String fname)      Returns a subscription id given a functional name. Parameters:   fname - the functional name to lookup. public  IUserLayout getUserLayout()      public  void getUserLayout(ContentHandler contentHandler)      public  void getUserLayout(String nodeId, ContentHandler contentHandler)      public  Document getUserLayoutDOM()      public  boolean isFragmentLoaded()      public  void loadFragment(String fragmentId)      public  void loadUserLayout()      public  void markAddTargets(IUserLayoutNodeDescription nodeDesc)      public  void markMoveTargets(String nodeId)      public synchronized  boolean moveNode(String nodeId, String parentId, String nextSiblingId)      Moves a node to a place in the tree denoted by parent and next sibling. protected  void moveWrongNodesToLostFolder()      public  void processLayoutParameters(IPerson person, UserPreferences userPrefs, HttpServletRequest req)      public  boolean removeLayoutEventListener(LayoutEventListener l)      public  void saveFragment(ILayoutFragment fragment)      public  void saveFragment(ILayoutFragment fragment, UserPreferences userPrefs)      public  void saveFragment()      public  void saveFragment(UserPreferences userPrefs)      public  void saveUserLayout()      public  void saveUserLayout(UserPreferences userPrefs)      public  void setAutoCommit(boolean autoCommit)      public  void setLayoutStore(IUserLayoutStore layoutStore)      public  void setPublishGroups(IGroupMember[] groups, String fragmentId)      public  void setUserLayout(IUserLayout layout)      public  void setUserLayoutDOM(Document domLayout)      public synchronized  boolean updateNode(IUserLayoutNodeDescription nodeDesc)      Constructor Detail AggregatedLayoutManager public AggregatedLayoutManager(IPerson person, UserProfile userProfile) throws PortalException(Code) AggregatedLayoutManager public AggregatedLayoutManager(IPerson person, UserProfile userProfile, IUserLayoutStore layoutStore) throws Exception(Code) Method Detail addLayoutEventListener public boolean addLayoutEventListener(LayoutEventListener l)(Code) addNode public synchronized IUserLayoutNodeDescription addNode(IUserLayoutNodeDescription nodeDesc, String parentId, String nextSiblingId) throws PortalException(Code) canAddNode public boolean canAddNode(IUserLayoutNodeDescription nodeDesc, String parentId, String nextSiblingId) throws PortalException(Code) canDeleteNode public boolean canDeleteNode(String nodeId) throws PortalException(Code) canMoveNode public boolean canMoveNode(String nodeId, String parentId, String nextSiblingId) throws PortalException(Code) canUpdateNode public boolean canUpdateNode(IUserLayoutNodeDescription nodeDescription) throws PortalException(Code) changeSiblingNodesOrder protected boolean changeSiblingNodesOrder(String firstNodeId) throws PortalException(Code) Change the sibling nodes order depending on their priority values Parameters:   firstNodeId - a String first node ID in the sibling line a boolean value exception:   PortalException - if an error occurs changeSiblingNodesPriorities protected boolean changeSiblingNodesPriorities(String nodeId) throws PortalException(Code) Change if it's possible priority values for all the sibling nodes Parameters:   nodeId - a String any node ID from the sibling line to be checked a boolean value exception:   PortalException - if an error occurs changeSiblingNodesPriorities protected boolean changeSiblingNodesPriorities(Vector nodes) throws PortalException(Code) Change if it's possible priority values for all the sibling nodes defined by the collection Parameters:   nodes - a Vector instance with ALNode objects a boolean value exception:   PortalException - if an error occurs changeSiblingNodesPriorities protected synchronized boolean changeSiblingNodesPriorities(ALNode node, String parentNodeId, String nextNodeId) throws PortalException(Code) Change priority values for all the sibling nodes when trying to add a new node Parameters:   node - a ALNode a node to be added Parameters:   parentNodeId - a String parent node ID Parameters:   nextNodeId - a String next sibling node ID a boolean value exception:   PortalException - if an error occurs createFragment public String createFragment(String fragmentName, String fragmentDesc, String fragmentRootName) throws PortalException(Code) createNodeDescription public IUserLayoutNodeDescription createNodeDescription(int nodeType) throws PortalException(Code) A factory method to create an empty IUserLayoutNodeDescription instance Parameters:   nodeType - a node type value an IUserLayoutNodeDescription instance exception:   PortalException - if the error occurs. deleteFragment public void deleteFragment(String fragmentId) throws PortalException(Code) deleteFragment public void deleteFragment() throws PortalException(Code) Deletes the current fragment if the layout is a fragment exception:   PortalException - if an error occurs deleteNode public synchronized boolean deleteNode(String nodeId) throws PortalException(Code) getCacheKey public String getCacheKey() throws PortalException(Code) Return a cache key, uniqly corresponding to the composition and the structure of the user layout. a String value exception:   PortalException - if an error occurs getChildIds public Enumeration getChildIds(String nodeId) throws PortalException(Code) Returns a list of child node Ids for a given node. Parameters:   nodeId - a String value a Enumeration of String child node Ids. exception:   PortalException - if an error occurs getDepth public int getDepth(String nodeId) throws PortalException(Code) Gets the tree depth for a given node Parameters:   nodeId - a String node ID a depth value exception:   PortalException - if an error occurs getFragment public ILayoutFragment getFragment(String fragmentId) throws PortalException(Code) getFragments public Collection getFragments() throws PortalException(Code) getLayoutId public int getLayoutId()(Code) Returns an Id of the current user layout. a int value getLostFolderXML public String getLostFolderXML() throws PortalException(Code) getNextSiblingId public String getNextSiblingId(String nodeId) throws PortalException(Code) Determine an Id of a next sibling node. Parameters:   nodeId - a String node ID a String Id value of a next sibling node, or null if this is the last sibling. exception:   PortalException - if an error occurs getNode public IUserLayoutNodeDescription getNode(String nodeId) throws PortalException(Code) getNodeBeingAdded public IALNodeDescription getNodeBeingAdded() throws PortalException(Code) Returns the description of the node currently being added to the layout node an IALNodeDescription object exception:   PortalException - if an error occurs getNodeBeingMoved public IALNodeDescription getNodeBeingMoved() throws PortalException(Code) Returns the description of the node currently being moved in the layout node an IALNodeDescription object exception:   PortalException - if an error occurs getParentId public String getParentId(String nodeId) throws PortalException(Code) Returns an Id of a parent user layout node. The user layout root node always has ID= IUserLayout.ROOT_NODE_NAME Parameters:   nodeId - a String value a String value exception:   PortalException - if an error occurs getPreviousSiblingId public String getPreviousSiblingId(String nodeId) throws PortalException(Code) Determine an Id of a previous sibling node. Parameters:   nodeId - a String node ID a String Id value of a previous sibling node, or null if this is the first sibling. exception:   PortalException - if an error occurs getPriorityRestriction public static PriorityRestriction getPriorityRestriction(ALNode node) throws PortalException(Code) Return a priority restriction for the given node. a PriorityRestriction object exception:   PortalException - if an error occurs getPublishGroups public Collection getPublishGroups(String fragmentId) throws PortalException(Code) Returns the user group keys which the fragment is published to Parameters:   fragmentId - a String value a Collection object containing the group keys exception:   PortalException - if an error occurs getRootFolderId public String getRootFolderId()(Code) Returns an id of the root folder. a String value getSubscribableFragments public Collection getSubscribableFragments() throws PortalException(Code) Returns the list of Ids of the fragments that the user can subscribe to Collection a set of the fragment IDs exception:   PortalException - if an error occurs getSubscribeId public String getSubscribeId(String fname) throws PortalException(Code) Returns a subscription id given a functional name. Parameters:   fname - the functional name to lookup. a String subscription id. getUserLayout public IUserLayout getUserLayout() throws PortalException(Code) getUserLayout public void getUserLayout(ContentHandler contentHandler) throws PortalException(Code) Output a tree of a user layout (with appropriate markings) defined by a particular node into a ContentHandler Parameters:   contentHandler - a ContentHandler value exception:   PortalException - if an error occurs getUserLayout public void getUserLayout(String nodeId, ContentHandler contentHandler) throws PortalException(Code) Output subtree of a user layout (with appropriate markings) defined by a particular node into a ContentHandler Parameters:   nodeId - a String a node determining a user layout subtree. Parameters:   contentHandler - a ContentHandler value exception:   PortalException - if an error occurs getUserLayoutDOM public Document getUserLayoutDOM() throws PortalException(Code) isFragmentLoaded public boolean isFragmentLoaded() throws PortalException(Code) Returns true if any fragment is currently loaded into the layout manager, false - otherwise a boolean value exception:   PortalException - if an error occurs loadFragment public void loadFragment(String fragmentId) throws PortalException(Code) loadUserLayout public void loadUserLayout() throws PortalException(Code) markAddTargets public void markAddTargets(IUserLayoutNodeDescription nodeDesc) throws PortalException(Code) markMoveTargets public void markMoveTargets(String nodeId) throws PortalException(Code) moveNode public synchronized boolean moveNode(String nodeId, String parentId, String nextSiblingId) throws PortalException(Code) Moves a node to a place in the tree denoted by parent and next sibling. Parameters:   nodeId - node to be moved Parameters:   parentId - parent of where nodeId should be moved Parameters:   nextSiblingId - nextSibling of where nodeId should be moved moveWrongNodesToLostFolder protected void moveWrongNodesToLostFolder() throws PortalException(Code) Moves the nodes to the lost folder if they don't satisfy their restrictions exception:   PortalException - if an error occurs processLayoutParameters public void processLayoutParameters(IPerson person, UserPreferences userPrefs, HttpServletRequest req) throws PortalException(Code) removeLayoutEventListener public boolean removeLayoutEventListener(LayoutEventListener l)(Code) saveFragment public void saveFragment(ILayoutFragment fragment) throws PortalException(Code) saveFragment public void saveFragment(ILayoutFragment fragment, UserPreferences userPrefs) throws PortalException(Code) saveFragment public void saveFragment() throws PortalException(Code) saveFragment public void saveFragment(UserPreferences userPrefs) throws PortalException(Code) saveUserLayout public void saveUserLayout() throws PortalException(Code) saveUserLayout public void saveUserLayout(UserPreferences userPrefs) throws PortalException(Code) setAutoCommit public void setAutoCommit(boolean autoCommit)(Code) Sets a layout manager to auto-commit mode that allows to update the database immediately Parameters:   autoCommit - a boolean value setLayoutStore public void setLayoutStore(IUserLayoutStore layoutStore)(Code) setPublishGroups public void setPublishGroups(IGroupMember[] groups, String fragmentId) throws PortalException(Code) Persists the user groups which the fragment is published to Parameters:   groups - an array of IGroupMember objects Parameters:   fragmentId - a String value exception:   PortalException - if an error occurs setUserLayout public void setUserLayout(IUserLayout layout) throws PortalException(Code) setUserLayoutDOM public void setUserLayoutDOM(Document domLayout) throws PortalException(Code) updateNode public synchronized boolean updateNode(IUserLayoutNodeDescription nodeDesc) throws PortalException(Code) Methods inherited from java.lang.Object native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc) public boolean equals(Object obj)(Code)(Java Doc) protected void finalize() throws Throwable(Code)(Java Doc) final native public Class getClass()(Code)(Java Doc) native public int hashCode()(Code)(Java Doc) final native public void notify()(Code)(Java Doc) final native public void notifyAll()(Code)(Java Doc) public String toString()(Code)(Java Doc) final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc) final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc) final public void wait() throws InterruptedException(Code)(Java Doc)