com.sap.mdm.repository.commands
Class GetPortDataFilesCommand

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.AbstractRepositorySessionCommand
                  extended bycom.sap.mdm.repository.commands.GetPortDataFilesCommand
All Implemented Interfaces:
Command, PassportSupport

public class GetPortDataFilesCommand
extends AbstractRepositorySessionCommand

Retrieves the data files processed by the syndication server.

In normal operations, there is a desire to distribute master data to other remote systems. MDM Syndication allows for completely restructure the record data to fit the needs of any remote system without modifying the source data itself.

This command allows the user to grab the end result of the syndication to be consume by the remote systems.

For more information, see Syndication.

See Also:
AddSyndicationRecordIdsCommand, SyndicatePortCommand, EventDispatcher, GetPortListCommand, GetRemoteSystemListCommand

Constructor Summary
GetPortDataFilesCommand(ConnectionAccessor connection)
          Creates a new instance of this command.
GetPortDataFilesCommand(RepositorySessionContext ctx)
          Creates a new instance of this command by context.
 
Method Summary
 String getFilePrefix()
          Returns the file prefix.
 PortDataFile[] getFiles()
          Returns the data files retrieved from a port.
 PortId getPortId()
          Returns the port Id.
 RemoteSystemId getRemoteSystemId()
          Returns the remote system Id.
 void setFilePrefix(String filePrefix)
          Sets the file prefix (optional).
 void setPortId(PortId portId)
          Sets the port Id (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

GetPortDataFilesCommand

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

Parameters:
connection - the connections to the server.

GetPortDataFilesCommand

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

Parameters:
ctx - the repository session context.
Method Detail

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

getPortId

public PortId getPortId()
Returns the port Id.

Returns:
a port Id

setPortId

public void setPortId(PortId portId)
Sets the port Id (required). The data files retrieved are from this port.

Parameters:
portId - a port Id

getFiles

public PortDataFile[] getFiles()
Returns the data files retrieved from a port.

Returns:
a list of data files

getFilePrefix

public String getFilePrefix()
Returns the file prefix.

Returns:
a file prefix

setFilePrefix

public void setFilePrefix(String filePrefix)
Sets the file prefix (optional). The files retrieved will be filtered to have this prefix. The default is empty string.

Parameters:
filePrefix - a file pattern


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.