uPortal 2.4.1
API Documentation

org.jasig.portal.layout
Interface IAggregatedLayout

All Superinterfaces:
IUserLayout
All Known Implementing Classes:
AggregatedLayout

public interface IAggregatedLayout
extends IUserLayout

An aggregated-layout specific extension of the user layout interface

Version:
1.1
Author:
Michael Ivanov

Field Summary
static java.lang.String ADD_TARGET
           
static java.lang.String CHANNEL
           
static java.lang.String FOLDER
           
static java.lang.String FRAGMENT
           
static java.lang.String LAYOUT
           
static java.lang.String MOVE_TARGET
           
static java.lang.String PARAMETER
           
static java.lang.String RESTRICTION
           
 
Method Summary
 java.lang.String getFragmentId(java.lang.String nodeId)
          Returns an fragment Id for a given node.
 java.util.Set getFragmentIds()
          Returns a list of fragment Ids existing in the layout.
 java.lang.String getFragmentRootId(java.lang.String fragmentId)
          Returns an fragment root Id for a given fragment.
 
Methods inherited from interface org.jasig.portal.layout.IUserLayout
addLayoutEventListener, getCacheKey, getChildIds, getId, getNextSiblingId, getNodeDescription, getNodeId, getNodeIds, getParentId, getPreviousSiblingId, getRootId, removeLayoutEventListener, writeTo, writeTo, writeTo, writeTo
 

Field Detail

LAYOUT

public static final java.lang.String LAYOUT
See Also:
Constant Field Values

FRAGMENT

public static final java.lang.String FRAGMENT
See Also:
Constant Field Values

FOLDER

public static final java.lang.String FOLDER
See Also:
Constant Field Values

CHANNEL

public static final java.lang.String CHANNEL
See Also:
Constant Field Values

PARAMETER

public static final java.lang.String PARAMETER
See Also:
Constant Field Values

RESTRICTION

public static final java.lang.String RESTRICTION
See Also:
Constant Field Values

ADD_TARGET

public static final java.lang.String ADD_TARGET
See Also:
Constant Field Values

MOVE_TARGET

public static final java.lang.String MOVE_TARGET
See Also:
Constant Field Values
Method Detail

getFragmentIds

public java.util.Set getFragmentIds()
                             throws PortalException
Returns a list of fragment Ids existing in the layout.

Returns:
a Set of String fragment Ids.
Throws:
PortalException - if an error occurs

getFragmentId

public java.lang.String getFragmentId(java.lang.String nodeId)
                               throws PortalException
Returns an fragment Id for a given node. Returns null if the node is not part of any fragments.

Parameters:
nodeId - a String value
Returns:
a String fragment Id
Throws:
PortalException - if an error occurs

getFragmentRootId

public java.lang.String getFragmentRootId(java.lang.String fragmentId)
                                   throws PortalException
Returns an fragment root Id for a given fragment.

Parameters:
fragmentId - a String value
Returns:
a String fragment root Id
Throws:
PortalException - if an error occurs

uPortal 2.4.1
API Documentation