Package io.goobi.viewer.model.cms.itemfunctionality

Class TocFunctionality

java.lang.Object

io.goobi.viewer.model.cms.itemfunctionality.TocFunctionality

All Implemented Interfaces:

Functionality

public class TocFunctionality
extends Object
implements Functionality

TocFunctionality class.

Author:

Florian Alpers

Constructor Summary

Constructors

Constructor	Description
TocFunctionality(TocFunctionality blueprint)	Constructor for TocFunctionality.
TocFunctionality(String pi)	Constructor for TocFunctionality.

Method Summary

Modifier and Type	Method	Description
String	getBannerUrl(int width, int height)	getBannerUrl.
StructElement	getDocStruct()	Getter for the field docStruct.
int	getPageNo()	getPageNo.
String	getPi()	Getter for the field pi.
TOC	getToc()	Getter for the field toc.
void	setPageNo(int pageNo)	setPageNo.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TocFunctionality

public TocFunctionality(String pi)

Constructor for TocFunctionality.

Parameters:

pi - a String object.

TocFunctionality

public TocFunctionality(TocFunctionality blueprint)

Constructor for TocFunctionality.

Parameters:

blueprint - a TocFunctionality object.

Method Details

getBannerUrl

public String getBannerUrl(int width,
 int height)
                    throws IndexUnreachableException,
PresentationException,
DAOException,
ViewerConfigurationException

getBannerUrl.

Parameters:

width - a int.

height - a int.

Returns:

a String object.

Throws:

IndexUnreachableException - if any.

PresentationException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

getToc

public TOC getToc()
           throws PresentationException,
IndexUnreachableException,
DAOException,
ViewerConfigurationException

Getter for the field toc.

Returns:

a TOC object.

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

DAOException - if any.

ViewerConfigurationException - if any.

getDocStruct

public StructElement getDocStruct()
                           throws IndexUnreachableException,
PresentationException

Getter for the field docStruct.

Returns:

a StructElement object.

Throws:

IndexUnreachableException - if any.

PresentationException - if any.

getPi

public String getPi()

Getter for the field pi.

Returns:

the piPeriodical

setPageNo

public void setPageNo(int pageNo)

setPageNo.

Specified by:

setPageNo in interface Functionality

Parameters:

pageNo - a int.

getPageNo

public int getPageNo()

getPageNo.

Specified by:

getPageNo in interface Functionality

Returns:

a int.