com.sap.mdm.data.commands
Class RetrieveJoinCheckOutPermissionsCommand

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

public class RetrieveJoinCheckOutPermissionsCommand
extends AbstractUserSessionCommand

This command retrieves join check out permissions for specified checked out records.

Users/Roles that have join check out permissions can join checked out records using JoinCheckoutRecordsCommand command.

Check out mechanism enables secure modifying of records while working in distributed environment.

Since:
7.2
See Also:
ModifyJoinCheckOutPermissionsCommand1, JoinCheckoutRecordsCommand, CheckoutRecordsCommand, CheckinRecordsCommand

Constructor Summary
RetrieveJoinCheckOutPermissionsCommand(ConnectionAccessor connection)
          Constructor.
RetrieveJoinCheckOutPermissionsCommand(UserSessionContext ctx)
          Creates a new instance of this command by context.
 
Method Summary
 JoinCheckOutPermissions getJoinCheckOutPermissions()
          Returns join checkout permissions for specified records.
 RecordId[] getRecordIds()
          Returns checked out record Ids.
 TableId getTableId()
          Returns table Id.
 void setRecordIds(RecordId[] recordIds)
          Sets checked out record ids required*.
 void setTableId(TableId tableId)
          Sets table 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

RetrieveJoinCheckOutPermissionsCommand

public RetrieveJoinCheckOutPermissionsCommand(ConnectionAccessor connection)
Constructor.

Parameters:
connection - the connection to the MDM server

RetrieveJoinCheckOutPermissionsCommand

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

Parameters:
ctx - the user session context.
Method Detail

setTableId

public void setTableId(TableId tableId)
Sets table Id required*. Specifies the table that contains checked out records.

Parameters:
tableId - table Id

getTableId

public TableId getTableId()
Returns table Id.

Returns:
table id

setRecordIds

public void setRecordIds(RecordId[] recordIds)
Sets checked out record ids required*. This command retrieves join checkout permissions for the records specified by this method. Note:
Ids of checked out records could be obtained via CheckoutRecordsCommand or RetrieveCheckoutRecordsByOriginalCommand.

Parameters:
recordIds - ids of checked out records

getRecordIds

public RecordId[] getRecordIds()
Returns checked out record Ids.

Returns:
checked out record Ids

getJoinCheckOutPermissions

public JoinCheckOutPermissions getJoinCheckOutPermissions()
Returns join checkout permissions for specified records.

Returns:
join checkout permissions


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.