|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
An interface for abstracting operations performed on the user layout.
Method Summary | |
boolean |
addLayoutEventListener(LayoutEventListener l)
Register a layout event listener |
IUserLayoutNodeDescription |
addNode(IUserLayoutNodeDescription node,
java.lang.String parentId,
java.lang.String nextSiblingId)
Add a new node to a current user layout. |
boolean |
canAddNode(IUserLayoutNodeDescription node,
java.lang.String parentId,
java.lang.String nextSiblingId)
Test if a particular node can be added at a given location. |
boolean |
canDeleteNode(java.lang.String nodeId)
Tests if a particular node can be deleted. |
boolean |
canMoveNode(java.lang.String nodeId,
java.lang.String parentId,
java.lang.String nextSiblingId)
Test if a particular node can be moved to a given location. |
boolean |
canUpdateNode(IUserLayoutNodeDescription node)
Test if a certain node can be updated. |
IUserLayoutNodeDescription |
createNodeDescription(int nodeType)
A factory method to create an empty IUserLayoutNodeDescription instance |
boolean |
deleteNode(java.lang.String nodeId)
Delete a node (folder or a channel) from a user layout. |
java.lang.String |
getCacheKey()
Return a cache key, uniqly corresponding to the composition and the structure of the user layout. |
java.util.Enumeration |
getChildIds(java.lang.String nodeId)
Returns a list of child node Ids for a given node. |
int |
getDepth(java.lang.String nodeId)
Returns the depth of a node in the layout tree. |
int |
getLayoutId()
Returns a layout Id associated with this manager/ |
java.lang.String |
getNextSiblingId(java.lang.String nodeId)
Determine an Id of a next sibling node. |
IUserLayoutNodeDescription |
getNode(java.lang.String nodeId)
Obtain a description of a node (channel or a folder) in a given user layout. |
java.lang.String |
getParentId(java.lang.String nodeId)
Returns an Id of a parent user layout node. |
java.lang.String |
getPreviousSiblingId(java.lang.String nodeId)
Determine an Id of a previous sibling node. |
java.lang.String |
getRootFolderId()
Returns an id of the root folder. |
java.lang.String |
getSubscribeId(java.lang.String fname)
Returns a subscription id using the supplied functional name. |
IUserLayout |
getUserLayout()
Gets a user layout (with appropriate markings). |
void |
getUserLayout(org.xml.sax.ContentHandler ch)
Output user layout (with appropriate markings) into a ContentHandler |
void |
getUserLayout(java.lang.String nodeId,
org.xml.sax.ContentHandler ch)
Output subtree of a user layout (with appropriate markings) defined by a particular node into a ContentHandler |
org.w3c.dom.Document |
getUserLayoutDOM()
|
void |
loadUserLayout()
Signal manager to load a user layout from a database |
void |
markAddTargets(IUserLayoutNodeDescription node)
Ask manager to output markings at the locations where a given node can be added. |
void |
markMoveTargets(java.lang.String nodeId)
Ask manager to output markings at the locations where a given node can be moved. |
boolean |
moveNode(java.lang.String nodeId,
java.lang.String parentId,
java.lang.String nextSiblingId)
Move a node (channel or folder) from one location to another. |
boolean |
removeLayoutEventListener(LayoutEventListener l)
Remove a registered layout event listener. |
void |
saveUserLayout()
Signal manager to persist user layout to a database |
void |
setLayoutStore(IUserLayoutStore ls)
Set a user layout store implementation. |
void |
setUserLayout(IUserLayout userLayout)
Sets a user layout (with appropriate markings). |
boolean |
updateNode(IUserLayoutNodeDescription node)
Update a given node. |
Method Detail |
public IUserLayout getUserLayout() throws PortalException
PortalException
- if an error occurspublic void setUserLayout(IUserLayout userLayout) throws PortalException
userLayout
- the user layout
PortalException
- if an error occurspublic void getUserLayout(org.xml.sax.ContentHandler ch) throws PortalException
ContentHandler
ch
- a ContentHandler
value
PortalException
- if an error occurspublic void getUserLayout(java.lang.String nodeId, org.xml.sax.ContentHandler ch) throws PortalException
ContentHandler
nodeId
- a String
a node determining a user layout subtree.ch
- a ContentHandler
value
PortalException
- if an error occurspublic void setLayoutStore(IUserLayoutStore ls)
ls
- an IUserLayoutStore
valuepublic void loadUserLayout() throws PortalException
PortalException
- if an error occurspublic void saveUserLayout() throws PortalException
PortalException
- if an error occurspublic IUserLayoutNodeDescription getNode(java.lang.String nodeId) throws PortalException
nodeId
- a String
channel subscribe id or folder id.
UserLayoutNodeDescription
value
PortalException
- if an error occurspublic IUserLayoutNodeDescription addNode(IUserLayoutNodeDescription node, java.lang.String parentId, java.lang.String nextSiblingId) throws PortalException
node
- an UserLayoutNodeDescription
value of a node to be added (Id doesn't have to be set)parentId
- a String
id of a folder to which the new node (channel or folder) should be added.nextSiblingId
- a String
an id of a sibling node (channel or folder) prior to which the new node should be inserted.
UserLayoutNodeDescription
value with a newly determined Id.
PortalException
- if an error occurspublic boolean moveNode(java.lang.String nodeId, java.lang.String parentId, java.lang.String nextSiblingId) throws PortalException
nodeId
- a String
value of a node Id.parentId
- a String
id of a folder to which the node should be moved.nextSiblingId
- a String
id of a sibling node (folder or channel) prior to which the node should be placed. (null
to append at the end)
boolean
value noting if the operation was successful
PortalException
- if an error occurspublic boolean deleteNode(java.lang.String nodeId) throws PortalException
nodeId
- a String
id (channel subscribe id or folder id)
boolean
value noting if the operation was successful
PortalException
- if an error occurspublic boolean updateNode(IUserLayoutNodeDescription node) throws PortalException
node
- an UserLayoutNodeDescription
value with a valid id.
boolean
value noting if the operation was successful
PortalException
- if an error occurspublic boolean canAddNode(IUserLayoutNodeDescription node, java.lang.String parentId, java.lang.String nextSiblingId) throws PortalException
node
- an UserLayoutNodeDescription
value describing the node to be added.parentId
- a String
id of a parent to which the node to be added.nextSiblingId
- a String
id of a sibling prior to which the node to be inserted. (null
to append at the end)
boolean
value
PortalException
- if an error occurspublic boolean canMoveNode(java.lang.String nodeId, java.lang.String parentId, java.lang.String nextSiblingId) throws PortalException
nodeId
- a String
id of a node to be moved.parentId
- a String
id of a parent to which the node to be moved.nextSiblingId
- a String
id of a sibling prior to which the node is to be inserted (null
to append at the end)
boolean
value
PortalException
- if an error occurspublic boolean canDeleteNode(java.lang.String nodeId) throws PortalException
nodeId
- a String
node id.
boolean
value
PortalException
- if an error occurspublic boolean canUpdateNode(IUserLayoutNodeDescription node) throws PortalException
node
- a IUserLayoutNodeDescription
node id.
boolean
value
PortalException
- if an error occurspublic void markAddTargets(IUserLayoutNodeDescription node) throws PortalException
getUserLayout
method is called.
node
- an UserLayoutNodeDescription
value or null
to stop outputting add markings.
PortalException
- if an error occurspublic void markMoveTargets(java.lang.String nodeId) throws PortalException
getUserLayout
method is called.
nodeId
- a String
value or null
to stop outputting move markings.
PortalException
- if an error occurspublic java.lang.String getParentId(java.lang.String nodeId) throws PortalException
nodeId
- a String
value
String
value
PortalException
- if an error occurspublic java.util.Enumeration getChildIds(java.lang.String nodeId) throws PortalException
nodeId
- a String
value
List
of String
child node Ids.
PortalException
- if an error occurspublic java.lang.String getNextSiblingId(java.lang.String nodeId) throws PortalException
nodeId
- a String
value
String
Id value of a next sibling node, or null
if this is the last sibling.
PortalException
- if an error occurspublic java.lang.String getPreviousSiblingId(java.lang.String nodeId) throws PortalException
nodeId
- a String
value
String
Id value of a previous sibling node, or null
if this is the first sibling.
PortalException
- if an error occurspublic java.lang.String getCacheKey() throws PortalException
String
value
PortalException
- if an error occurspublic boolean addLayoutEventListener(LayoutEventListener l)
l
- a LayoutEventListener
object
boolean
success statuspublic boolean removeLayoutEventListener(LayoutEventListener l)
l
- a LayoutEventListener
object
boolean
success statuspublic org.w3c.dom.Document getUserLayoutDOM() throws PortalException
PortalException
public int getLayoutId()
int
layout Id value;public java.lang.String getSubscribeId(java.lang.String fname) throws PortalException
fname
- the functional name to lookup
String
subscription id
PortalException
public java.lang.String getRootFolderId()
String
valuepublic int getDepth(java.lang.String nodeId) throws PortalException
nodeId
- a String
value
PortalException
- if an error occurspublic IUserLayoutNodeDescription createNodeDescription(int nodeType) throws PortalException
IUserLayoutNodeDescription
instance
nodeType
- a node type constant from IUserLayoutNodeDescription
interface
IUserLayoutNodeDescription
instance
PortalException
- if the error occurs.
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |