com.sap.mdm.data.commands
Class CancelSyndicationCommand

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.CancelSyndicationCommand
All Implemented Interfaces:
Command, PassportSupport

public class CancelSyndicationCommand
extends AbstractUserSessionCommand

A command to cancel syndication. If the syndication had already started, it cannot be cancel. The work unit to cancel is identified by the file prefix.

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

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

Constructor Summary
CancelSyndicationCommand(ConnectionAccessor connection)
          Constructor.
CancelSyndicationCommand(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.
 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 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

CancelSyndicationCommand

public CancelSyndicationCommand(ConnectionAccessor connection)
Constructor.

Parameters:
connection - the connection to the MDM server

CancelSyndicationCommand

public CancelSyndicationCommand(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.

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). If the work units with this prefix will be canceled. If the file prefix is an empty string, all work units in the port will be canceled.

Parameters:
filePrefix - a file prefix


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.