com.sap.mdm.group.commands
Class CreateGroupCommand

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

public class CreateGroupCommand
extends AbstractUserSessionCommand

This command allows for adding a new group to the hierarchy of groups.

Mandatory input parameters:

- Group node to add. Use HierGroupNodeFactory to create a group. Possible group types: HierDataGroupNode, HierLocationGroupNode or HierValidationGroupNode.

Optional input parameters:

- Parent ID. Default value stands for group to be added to the root node.

Output parameter:

- Group id. The id of the new group.

Note: the validation group type unsupported currently.

Since:
version MDM 5.5 SP6 P02
See Also:
DeleteGroupCommand, RetrieveGroupTreeCommand

Constructor Summary
CreateGroupCommand(ConnectionAccessor connection)
          Constructor.
CreateGroupCommand(UserSessionContext ctx)
          Constructor.
 
Method Summary
 HierGroupNode getGroup()
          Returns group.
 GroupNodeId getNewGroupId()
          Returns id of the new group.
 GroupNodeId getParentId()
          Returns id of the parent group.
 void setGroup(HierGroupNode group)
          Sets the group to add (required*).
 void setParentId(GroupNodeId parentId)
          Sets id of the parent group.
 
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

CreateGroupCommand

public CreateGroupCommand(ConnectionAccessor connection)
Constructor.

Parameters:
connection - Connection to the MDM server.

CreateGroupCommand

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

Parameters:
ctx - User session context.
Method Detail

setGroup

public void setGroup(HierGroupNode group)
Sets the group to add (required*).

Parameters:
group - Group to add. Group can be the instance of HierDataGroupNode, HierLocationGroupNode or HierValidationGroupNode. Use the HierGroupNodeFactory class to create a new group of the necessary type.

getGroup

public HierGroupNode getGroup()
Returns group.

Returns:
The group.

setParentId

public void setParentId(GroupNodeId parentId)
Sets id of the parent group.

Parameters:
parentId - Id of the parent node.

getParentId

public GroupNodeId getParentId()
Returns id of the parent group.

Returns:
Parent id.

getNewGroupId

public GroupNodeId getNewGroupId()
Returns id of the new group.

Returns:
Id of new created group.


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.