com.sap.mdm.data.commands
Class RefreshCalculatedFieldsCommand

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

public class RefreshCalculatedFieldsCommand
extends AbstractUserSessionCommand

A command to refresh the field values for those fields that are set as calculated fields.


Constructor Summary
RefreshCalculatedFieldsCommand(ConnectionAccessor connection)
          Creates an instance.
RefreshCalculatedFieldsCommand(UserSessionContext ctx)
          Creates a new instance of this command by context.
 
Method Summary
 RecordId[] getFailedRecords()
          Returns the records that failed refreshing calculated fields.
 RecordId[] getRecordIds()
          Returns the list of records.
 Integer getReturnCode(RecordId recordId)
          Returns the reason the record failed refreshing calculated fields.
 RecordId[] getSucceededRecords()
          Returns the records that were successfully refreshed.
 TableId getTableId()
          Returns the table Id.
 boolean isSlice()
          Returns whether slicing is enabled.
 void setRecordIds(RecordId[] recordIds)
          Sets the list of records to refresh the calculated field values (required).
 void setSlice(boolean isSlice)
          Enable slicing during refreshing calculated fields.
 void setTableId(TableId tableId)
          Sets the table Id the records are from (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

RefreshCalculatedFieldsCommand

public RefreshCalculatedFieldsCommand(ConnectionAccessor connection)
Creates an instance.

Parameters:
connection - the connection to the MDM server

RefreshCalculatedFieldsCommand

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

Parameters:
ctx - the user session context.
Method Detail

getRecordIds

public RecordId[] getRecordIds()
Returns the list of records.

Returns:
the record Ids

setRecordIds

public void setRecordIds(RecordId[] recordIds)
Sets the list of records to refresh the calculated field values (required).

Parameters:
recordIds - the record Ids

getTableId

public TableId getTableId()
Returns the table Id.


setTableId

public void setTableId(TableId tableId)
Sets the table Id the records are from (required).


setSlice

public void setSlice(boolean isSlice)
Enable slicing during refreshing calculated fields.

Parameters:
isSlice - true to enable, false to disable
Since:
7.1 SP7

isSlice

public boolean isSlice()
Returns whether slicing is enabled.

Returns:
true to enable, false to disable
Since:
7.1 SP7

getFailedRecords

public RecordId[] getFailedRecords()
Returns the records that failed refreshing calculated fields.

Note: When slicing is enabled, records are divided into subsets. For a given subset of records, if a record failed the operation, the whole subset of records are marked as failed. It is not possible to determine which record in the subset triggered the failure.

Returns:
the list of failed records
Since:
7.1 SP7

getSucceededRecords

public RecordId[] getSucceededRecords()
Returns the records that were successfully refreshed.

Returns:
the list of succeeded records
Since:
7.1 SP7

getReturnCode

public Integer getReturnCode(RecordId recordId)
Returns the reason the record failed refreshing calculated fields.

Parameters:
recordId - a record Id
Returns:
returns the return code for the failed record; if it's not a failed record, return null
Since:
7.1 SP7
See Also:
RC


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.