uPortal 2.4.1
API Documentation

org.jasig.portal.layout
Interface ILayoutFragment

All Superinterfaces:
IUserLayout
All Known Implementing Classes:
ALFragment

public interface ILayoutFragment
extends IUserLayout

An interface representing the user layout fragment.

Version:
$Revision: 1.3 $
Author:
Michael Ivanov

Method Summary
 java.lang.String getDescription()
          Returns a fragment description
 java.lang.String getFragmentRootId()
          Returns the fragment root Id.
 java.lang.String getFunctionalName()
          Returns a fragment functional name
 java.lang.String getName()
          Returns a fragment name
 
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
 

Method Detail

getName

public java.lang.String getName()
Returns a fragment name

Returns:
an String fragment name

getDescription

public java.lang.String getDescription()
Returns a fragment description

Returns:
an String fragment description

getFunctionalName

public java.lang.String getFunctionalName()
Returns a fragment functional name

Returns:
an String fragment name

getFragmentRootId

public java.lang.String getFragmentRootId()
                                   throws PortalException
Returns the fragment root Id.

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

uPortal 2.4.1
API Documentation