Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.jasig.portal.layout.alm
Interface ILayoutFragment

All Superinterfaces:
  IUserLayout

All Known Implementing Classes:
  ALFragment

    public interface ILayoutFragment

extends IUserLayout

An interface representing the user layout fragment. 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.

Version:
  $Revision: 1.1 $
Author:
  Michael Ivanov

Field Summary

Fields inherited from interface org.jasig.portal.layout.IUserLayout
`ROOT_NODE_NAME`

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

    java.lang.String getName()

  Returns a fragment name

  Returns:
    an `String` fragment name

### getDescription

    java.lang.String getDescription()

  Returns a fragment description

  Returns:
    an `String` fragment description

### getFunctionalName

    java.lang.String getFunctionalName()

  Returns a fragment functional name

  Returns:
    an `String` fragment name

### getFragmentRootId

    java.lang.String getFragmentRootId()
                                       throws PortalException

  Returns the fragment root Id.

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

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD