com.sap.mdm.group.commands
Class RetrieveGroupTreeCommand

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

public class RetrieveGroupTreeCommand
extends AbstractUserSessionCommand

This command allows for retrieving relationships related to the specified anchor record.

Mandatory input parameters: - Group type. Possible values: VALIDATION_GROUP_TYPE, DATA_GROUP_TYPE, DATA_LOCATION_TYPE

Optional input parameters: - Root ID. By default it is 0 (global root)

Output parameter: - Group tree

Note: Currently setRootId(GroupNodeId) is ignored for Data Groups and Data Locations.


Field Summary
static int DATA_GROUP_TYPE
          Deprecated. use the same constant in the com.sap.mdm.group.GroupTypes class
static int DATA_LOCATION_TYPE
          Deprecated. use the same constant in the com.sap.mdm.group.GroupTypes class
static int VALIDATION_GROUP_TYPE
          Deprecated. use the same constant in the com.sap.mdm.group.GroupTypes class
 
Constructor Summary
RetrieveGroupTreeCommand(ConnectionAccessor connection)
          Constructor.
RetrieveGroupTreeCommand(UserSessionContext ctx)
          Creates a new instance of this command by context.
 
Method Summary
 HierGroupNode getGroupTree()
          Return hierarchical structure of groups.
 int getGroupType()
          Returns the group type.
 GroupNodeId getRootId()
          Returns the ID of root node of the result tree.
 void setGroupType(int groupType)
          Sets the group type (required).
 void setRootId(GroupNodeId rootId)
          Sets the ID of root node of the result tree (optional).
 
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
 

Field Detail

VALIDATION_GROUP_TYPE

public static final int VALIDATION_GROUP_TYPE
Deprecated. use the same constant in the com.sap.mdm.group.GroupTypes class

See Also:
Constant Field Values

DATA_GROUP_TYPE

public static final int DATA_GROUP_TYPE
Deprecated. use the same constant in the com.sap.mdm.group.GroupTypes class

See Also:
Constant Field Values

DATA_LOCATION_TYPE

public static final int DATA_LOCATION_TYPE
Deprecated. use the same constant in the com.sap.mdm.group.GroupTypes class

See Also:
Constant Field Values
Constructor Detail

RetrieveGroupTreeCommand

public RetrieveGroupTreeCommand(ConnectionAccessor connection)
Constructor.

Parameters:
connection - the connection to the MDM server

RetrieveGroupTreeCommand

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

Parameters:
ctx - the user session context.
Method Detail

getGroupType

public int getGroupType()
Returns the group type.

Returns:
the group type.

setGroupType

public void setGroupType(int groupType)
Sets the group type (required).

Parameters:
groupType - the group type.

getRootId

public GroupNodeId getRootId()
Returns the ID of root node of the result tree.

Returns:
the root node ID.

setRootId

public void setRootId(GroupNodeId rootId)
Sets the ID of root node of the result tree (optional).

Parameters:
rootId - the root node ID.

getGroupTree

public HierGroupNode getGroupTree()
Return hierarchical structure of groups.

Returns:
the group tree


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.