com.sap.mdm.dataimport.commands
Class ImportRecordsCommand

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

public class ImportRecordsCommand
extends AbstractUserSessionCommand

This command is responsible for importing one or more records to repository


Constructor Summary
ImportRecordsCommand(ConnectionAccessor connection)
          Constructor.
ImportRecordsCommand(UserSessionContext ctx)
          Constructor.
 
Method Summary
 void addRecordImportDefinition(RecordImportDefinition recordDefinition)
          Adds the record import definition (required*)
 int getDuplicateLinkCheckOption()
           
 ImportResult getImportResult()
          Returns the result of import process.
 int getImportType()
          Returns default import type.
 int getKeyReassignmentConfig()
           
 int getMatchingQualifiedLinkOption()
          Returns import option for the matched qualified links
 int getNonMatchingQualifiedLinkOption()
          Returns import option for the non-matched qualified links
 RecordImportDefinition[] getRecordImportDefinitions()
          Gets the import definitions for all records
 RemoteSystemId getRemoteSystemId()
          Returns the remote system ID
 TableId getTableId()
          Gets the table ID for which records are imported.
 boolean isAutoJoinChkOutOption()
          Indicates if ...
 boolean isAutoLinkUsedAttributes()
          Indicates if the used attribute should be automatically linked to the taxonomy category
 boolean isImportCheckOutRecord()
           
 void setAutoJoinChkOutOption(boolean autoJoinChkOutOption)
          Specify if ...
 void setAutoLinkUsedAttributes(boolean autoLinkUsedAttributes)
          Specify if the used attribute should be automatically linked to the taxonomy category (optional) The default value is false
 void setDuplicateLinkCheckOption(int duplicateLinkCheckOption)
          (optional) The default value is 0
 void setImportCheckOutRecord(boolean importCheckOutRecord)
          (optional) The default value is false
 void setImportType(int importType)
          Sets the default import type of the import process.
 void setKeyReassignmentConfig(int keyReassignmentConfig)
          (optional)
 void setMatchingQualifiedLinkOption(int matchingQualifiedLinkOption)
          Sets import option for the matched qualified links.
 void setNonMatchingQualifiedLinkOption(int nonMatchingQualifiedLinkOption)
          Sets import option for the non-matched qualified links.
 void setRemoteSystemId(RemoteSystemId remoteSystemId)
          Sets the remote system ...
 void setTableId(TableId tableId)
          Sets the table ID for which records are imported (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

ImportRecordsCommand

public ImportRecordsCommand(ConnectionAccessor connection)
Constructor.

Parameters:
connection - Connection to the MDM server.

ImportRecordsCommand

public ImportRecordsCommand(UserSessionContext ctx)
                     throws ConnectionException,
                            SessionException
Constructor.

Parameters:
ctx - User session context.
Method Detail

isAutoJoinChkOutOption

public boolean isAutoJoinChkOutOption()
Indicates if ...

Returns:
the autoJoinChkOutOption

setAutoJoinChkOutOption

public void setAutoJoinChkOutOption(boolean autoJoinChkOutOption)
Specify if ... (optional) The default value is true

Parameters:
autoJoinChkOutOption - the autoJoinChkOutOption to set

isAutoLinkUsedAttributes

public boolean isAutoLinkUsedAttributes()
Indicates if the used attribute should be automatically linked to the taxonomy category

Returns:
the autoLinkUsedAttributes

setAutoLinkUsedAttributes

public void setAutoLinkUsedAttributes(boolean autoLinkUsedAttributes)
Specify if the used attribute should be automatically linked to the taxonomy category (optional) The default value is false

Parameters:
autoLinkUsedAttributes - the autoLinkUsedAttributes to set

getDuplicateLinkCheckOption

public int getDuplicateLinkCheckOption()
Returns:
the duplicateLinkCheckOption

setDuplicateLinkCheckOption

public void setDuplicateLinkCheckOption(int duplicateLinkCheckOption)
(optional) The default value is 0

Parameters:
duplicateLinkCheckOption - the duplicateLinkCheckOption to set

isImportCheckOutRecord

public boolean isImportCheckOutRecord()
Returns:
the importCheckOutRecord

setImportCheckOutRecord

public void setImportCheckOutRecord(boolean importCheckOutRecord)
(optional) The default value is false

Parameters:
importCheckOutRecord - the importCheckOutRecord to set

getKeyReassignmentConfig

public int getKeyReassignmentConfig()
Returns:
the keyReassignmentConfig

setKeyReassignmentConfig

public void setKeyReassignmentConfig(int keyReassignmentConfig)
(optional)

Parameters:
keyReassignmentConfig - the keyReassignmentConfig to set

getMatchingQualifiedLinkOption

public int getMatchingQualifiedLinkOption()
Returns import option for the matched qualified links

Returns:
the matching qualified link option

setMatchingQualifiedLinkOption

public void setMatchingQualifiedLinkOption(int matchingQualifiedLinkOption)
Sets import option for the matched qualified links. (optional) The default value is ImportTypes.NONE The legal values are: ImportTypes.SKIP, ImportTypes.UPDATE_MAPPED, ImportTypes.UPDATE_NULL_ONLY, ImportTypes.UPDATE_REPLACE

Parameters:
matchingQualifiedLinkOption - the matching qualified link option to set

getNonMatchingQualifiedLinkOption

public int getNonMatchingQualifiedLinkOption()
Returns import option for the non-matched qualified links

Returns:
the non-matching qualified link option

setNonMatchingQualifiedLinkOption

public void setNonMatchingQualifiedLinkOption(int nonMatchingQualifiedLinkOption)
Sets import option for the non-matched qualified links. (optional) The default value is ImportTypes.NONE The legal values are: ImportTypes.SKIP, ImportTypes.CREATE The default value is ImportTypes.NONE

Parameters:
nonMatchingQualifiedLinkOption - the non-matching qualified link option to set

getRemoteSystemId

public RemoteSystemId getRemoteSystemId()
Returns the remote system ID

Returns:
the remote system ID

setRemoteSystemId

public void setRemoteSystemId(RemoteSystemId remoteSystemId)
Sets the remote system ... (optional) The default value is 0

Parameters:
remoteSystemId - the remoteSystemId to set

getTableId

public TableId getTableId()
Gets the table ID for which records are imported.

Returns:
the tableId

setTableId

public void setTableId(TableId tableId)
Sets the table ID for which records are imported (required*).

Parameters:
tableId - the tableId to set

getImportType

public int getImportType()
Returns default import type. This type is used for all imported records for which specific import type is not specified in the RecordImportDefinition class

Returns:
the default import type

setImportType

public void setImportType(int importType)
Sets the default import type of the import process. (optional) This type is used for all imported records for which specific import type is not specified in the RecordImportDefinition class

Parameters:
importType - the import type to set

addRecordImportDefinition

public void addRecordImportDefinition(RecordImportDefinition recordDefinition)
Adds the record import definition (required*)

Parameters:
recordDefinition -

getRecordImportDefinitions

public RecordImportDefinition[] getRecordImportDefinitions()
Gets the import definitions for all records

Returns:
array of record import definitions

getImportResult

public ImportResult getImportResult()
Returns the result of import process.

Returns:
the import process result


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.