com.sap.mdm.data.commands
Class AddSyndicationRecordIdsCommand

java.lang.Object
  extended bycom.sap.mdm.commands.AbstractCommandBase
      extended bycom.sap.mdm.commands.AbstractCommand
          extended bycom.sap.mdm.session.AbstractSessionCommand
              extended bycom.sap.mdm.session.AbstractUserSessionCommand
                  extended bycom.sap.mdm.data.commands.AddSyndicationRecordIdsCommand
All Implemented Interfaces:
Command, PassportSupport

public class AddSyndicationRecordIdsCommand
extends AbstractUserSessionCommand

A command for syndicating records. A work unit is created and is identified by the file prefix.

Syndication is the process of distributing master data objects to all known remote systems. For more information, see Syndication.

Note:
The port specified need to be set to manual for the processing type.

See Also:
CancelSyndicationCommand, SyndicatePortCommand, EventDispatcher, GetPortDataFilesCommand, GetPortListCommand, GetRemoteSystemListCommand

Constructor Summary
AddSyndicationRecordIdsCommand(ConnectionAccessor connection)
          Constructor.
AddSyndicationRecordIdsCommand(UserSessionContext ctx)
          Creates a new instance of this command by context.
 
Method Summary
 String getFilePrefix()
          Returns the file prefix.
 PortId getPortId()
          Returns the port Id.
 RecordId[] getRecordIds()
          Returns the record Ids.
 RemoteSystemId getRemoteSystemId()
          Returns the remote system Id.
 void setFilePrefix(String filePrefix)
          Sets the file prefix (required).
 void setPortId(PortId portId)
          Sets the port Id (required).
 void setRecordIds(RecordId[] recordIds)
          Sets the record Ids (required).
 void setRemoteSystemId(RemoteSystemId remoteSystemId)
          Sets the remote system Id (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

AddSyndicationRecordIdsCommand

public AddSyndicationRecordIdsCommand(ConnectionAccessor connection)
Constructor.

Parameters:
connection - the connection to the MDM server

AddSyndicationRecordIdsCommand

public AddSyndicationRecordIdsCommand(UserSessionContext ctx)
                               throws ConnectionException,
                                      SessionException
Creates a new instance of this command by context.

Parameters:
ctx - the user session context.
Method Detail

getPortId

public PortId getPortId()
Returns the port Id.

Returns:
a port Id

setPortId

public void setPortId(PortId portId)
Sets the port Id (required). The records are set for this remote system and port. The port specified need to be set to manual for the processing type.

Parameters:
portId - a port Id

getRemoteSystemId

public RemoteSystemId getRemoteSystemId()
Returns the remote system Id.

Returns:
a remote system Id

setRemoteSystemId

public void setRemoteSystemId(RemoteSystemId remoteSystemId)
Sets the remote system Id (required). The records are set for this remote system and port.

Parameters:
remoteSystemId - the remoteSystemId to set

getFilePrefix

public String getFilePrefix()
Returns the file prefix.

Returns:
a file prefix

setFilePrefix

public void setFilePrefix(String filePrefix)
Sets the file prefix (required). The syndicated files will have this prefix. Depending on how the syndicated files are consume, syndicated files can potentially be overwritten if a GUID is not used as the file prefix.

Parameters:
filePrefix - a file prefix

getRecordIds

public RecordId[] getRecordIds()
Returns the record Ids.

Returns:
record Ids

setRecordIds

public void setRecordIds(RecordId[] recordIds)
Sets the record Ids (required). The Syndicator will use these records for syndicating.

Parameters:
recordIds - record Ids


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.