com.sap.mdm.publishing.commands
Class GetLivePrintableContentCommand

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

public class GetLivePrintableContentCommand
extends AbstractCommand

This command Creates a Printable Layout for LIVE Publication Nodes Data in a form of XML document NOTE: This command requires connection already established.

Since:
7.1
See Also:
ConnectionPool, ConnectionPoolFactory

Field Summary
 int MAX_NODES
           
 
Constructor Summary
GetLivePrintableContentCommand(ConnectionAccessor connection)
          Creates a new instance of this command.
 
Method Summary
 boolean addNodeIdToArray(int nodeId, int position)
          Adds a node to an array of nodes for which the layout is requested (required).
 String getOutputXml()
          Returns the Output XML String.
 int getPublicationId()
          Returns the publicationId.
 boolean setNodeIds(int[] nodeIds)
          Copies Node Id int array to the member m_nodeidsArray (required).
 void setPublicationId(int publicationId)
          Sets a publicationId (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
 

Field Detail

MAX_NODES

public int MAX_NODES
Constructor Detail

GetLivePrintableContentCommand

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

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

setPublicationId

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

Parameters:
publicationId - obtained from GetPublicationListCommand

getPublicationId

public int getPublicationId()
Returns the publicationId.

Returns:
an Id of a publication

addNodeIdToArray

public boolean addNodeIdToArray(int nodeId,
                                int position)
Adds a node to an array of nodes for which the layout is requested (required).

Parameters:
nodeId - valid nodeId obtained from the output of GetPublicationTreeCommand
position - an order number of the node being added (<=10 - limitation of the first version)
Returns:
boolean status (succeeded/failed), can fail if the position is out of range

setNodeIds

public boolean setNodeIds(int[] nodeIds)
Copies Node Id int array to the member m_nodeidsArray (required).

Parameters:
nodeIds - An int array, which needs to be formed from presentation nodes in a publication
Returns:
boolean status (succeeded/failed), can fail if the position is out of range

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.