Package com.priint.pubserver.plannerapi.interfaces

Interface SpreadsServiceLocal

public interface SpreadsServiceLocal

Local interface for the Spreads service from the Planner API

Method Summary

Modifier and Type	Method	Description
Spread	getSpreadById(java.lang.Integer id)	Returns the spread at the specified ID
SpreadPreview	getSpreadPreview(java.lang.Integer spreadId, java.lang.String type)	Returns the spread preview for the specified spread
java.util.List<Spread>	getSpreads(java.lang.String documentId)	Returns spreads of the specified document

Method Detail

getSpreadById

Spread getSpreadById(java.lang.Integer id)
              throws PubServerException

Returns the spread at the specified ID

Parameters:

id - spread ID

Returns:

the spread

Throws:

ServiceException

PubServerException

See Also:

Spread

getSpreads

java.util.List<Spread> getSpreads(java.lang.String documentId)
                           throws PubServerException

Returns spreads of the specified document

Parameters:

documentId - document ID

Returns:

the list os spreads

Throws:

ServiceException

PubServerException

See Also:

Spread

getSpreadPreview

SpreadPreview getSpreadPreview(java.lang.Integer spreadId,
                               java.lang.String type)
                        throws PubServerException

Returns the spread preview for the specified spread

Parameters:

spreadId - spread ID

type - type of spred preview: db - preview from database, dbpt - preview from database with the page tempalte, meta - preview from meta data file

Returns:

the spread preview

Throws:

ServiceException

PubServerException

See Also:

SpreadPreview