|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
An aggregated-layout specific extension of the user layout manager interface
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 |
int |
getRestrictionMask()
Gets a restriction mask that logically multiplies one of the types from RestrictionTypes and
is responsible for filtering restrictions for the layout output to ContentHandler or DOM |
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 |
void |
setRestrictionMask(int restrictionMask)
Sets a restriction mask that logically multiplies one of the types from RestrictionTypes and
is responsible for filtering restrictions for the layout output to ContentHandler or DOM |
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 |
public static final java.lang.String NEW_FRAGMENT
public static final int PRIORITY_COEFF
Method Detail |
public void setRestrictionMask(int restrictionMask)
RestrictionTypes
and
is responsible for filtering restrictions for the layout output to ContentHandler or DOM
restrictionMask
- a restriction maskpublic int getRestrictionMask()
RestrictionTypes
and
is responsible for filtering restrictions for the layout output to ContentHandler or DOM
public void setAutoCommit(boolean autoCommit)
autoCommit
- a boolean valuepublic void saveFragment() throws PortalException
PortalException
- if an error occurspublic void deleteFragment() throws PortalException
PortalException
- if an error occurspublic void loadFragment(java.lang.String fragmentId) throws PortalException
fragmentId
- a fragment ID
PortalException
- if an error occurspublic void saveFragment(ILayoutFragment fragment) throws PortalException
fragment
- a ILayoutFragment
instance
PortalException
- if an error occurspublic void deleteFragment(java.lang.String fragmentId) throws PortalException
fragmentId
- a fragment ID
PortalException
- if an error occurspublic java.util.Collection getFragments() throws PortalException
Collection
a set of the fragment IDs
PortalException
- if an error occurspublic java.util.Collection getSubscribableFragments() throws PortalException
Collection
a set of the fragment IDs
PortalException
- if an error occurspublic ILayoutFragment getFragment(java.lang.String fragmentId) throws PortalException
fragmentId
- a fragment ID
ILayoutFragment
a fragment
PortalException
- if an error occurspublic boolean isFragmentLoaded() throws PortalException
PortalException
- if an error occurspublic IALNodeDescription getNodeBeingAdded() throws PortalException
IALNodeDescription
object
PortalException
- if an error occurspublic IALNodeDescription getNodeBeingMoved() throws PortalException
IALNodeDescription
object
PortalException
- if an error occurspublic java.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 occurspublic java.util.Collection getPublishGroups(java.lang.String fragmentId) throws PortalException
fragmentId
- a String
value
Colection
object containing the group keys
PortalException
- if an error occurspublic void setPublishGroups(IGroupMember[] groups, java.lang.String fragmentId) throws PortalException
groups
- an array of IGroupMember
objectsfragmentId
- a String
value
PortalException
- if an error occurs
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |