com.sap.mdm.publishing2.commands
Class GetPaperPrintableLayoutCommand

java.lang.Object
  extended bycom.sap.mdm.commands.AbstractCommandBase
      extended bycom.sap.mdm.commands.AbstractCommand
          extended bycom.sap.mdm.publishing2.commands.GetPaperPrintableLayoutCommand
All Implemented Interfaces:
Command, PassportSupport

public class GetPaperPrintableLayoutCommand
extends AbstractCommand

This command Creates a Printable Layout for the data placed on Publication Pages in a form of XML document NOTE: This command requires connection already established.

Since:
7.1
See Also:
ConnectionPool, ConnectionPoolFactory

Constructor Summary
GetPaperPrintableLayoutCommand(ConnectionAccessor connection)
          Creates a new instance of this command.
 
Method Summary
 String getOutputXml()
          Returns the Output XML String.
 int getPublicationId()
          Returns the publicationId.
 int getSectionNodeId()
          Returns the sectionNodeId.
 void setNumberOfPages(int numberOfPages)
          Sets a numberOfPages (required).
 void setPublicationId(int id)
          Sets a publicationId (required).
 void setSectionNodeId(int sectionNodeId)
          Sets a sectionNodeId (required).
 void setStartingPageNumber(int startingPageNumber)
          Sets a startingPageNumber (required).
 
Methods inherited from class com.sap.mdm.commands.AbstractCommand
getSession, setSession
 
Methods inherited from class com.sap.mdm.commands.AbstractCommandBase
execute, getPassport, isCommandComplete, setPassport
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GetPaperPrintableLayoutCommand

public GetPaperPrintableLayoutCommand(ConnectionAccessor connection)
Creates a new instance of this command.

Parameters:
connection - the connections to the server.
Method Detail

setPublicationId

public void setPublicationId(int id)
Sets a publicationId (required).

Parameters:
id - obtained from GetPublicationListCommand

getPublicationId

public int getPublicationId()
Returns the publicationId.

Returns:
an Id of a current publication

setSectionNodeId

public void setSectionNodeId(int sectionNodeId)
Sets a sectionNodeId (required).

Parameters:
sectionNodeId - obtained from GetPublicationTreeCommand

getSectionNodeId

public int getSectionNodeId()
Returns the sectionNodeId.

Returns:
a sectionNodeId of a current section node

setStartingPageNumber

public void setStartingPageNumber(int startingPageNumber)
Sets a startingPageNumber (required).

Parameters:
startingPageNumber - obtained from GetPagesForSectionCommand, and represents the first page in the section for which the layout is requested

setNumberOfPages

public void setNumberOfPages(int numberOfPages)
Sets a numberOfPages (required).

Parameters:
numberOfPages - obtained from GetPagesForSectionCommand, and represents the number of pages starting from the page set in the method: 'setStartingPageNumber'

getOutputXml

public String getOutputXml()
Returns the Output XML String.

Returns:
an Output XML String


Copyright 2004-2007 by SAP AG. All Rights Reserved.

SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies (SAP Group) for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.