com.sap.mdm.data.commands
Class RetrieveAttributesKeyMappingsCommand

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

public class RetrieveAttributesKeyMappingsCommand
extends AbstractUserSessionCommand

This command allows for retrieving key mappings for several text attribute values.

See Also:
ModifyAttributesKeyMappingsCommand, RetrieveRecordsKeyMappingsCommand

Constructor Summary
RetrieveAttributesKeyMappingsCommand(ConnectionAccessor connection)
          Constructor.
RetrieveAttributesKeyMappingsCommand(UserSessionContext ctx)
          Creates a new instance of this command by context.
 
Method Summary
 void addAttributeValueId(TextAttributeValueId attributeValueId)
          Adds an attribute value ID to the list of IDs which key mapping should be retrieved from repository (required*).
 void clearAttributeValueIds()
          Clears the list of attribute value IDs.
 boolean containsAttributeValueId(TextAttributeValueId attributeValueId)
          Checks if the specified attribute value ID is contained in the list of IDs which key mapping should be retrieved from repository.
 AttributeId getAttributeId()
          Returns the attribute ID.
 TextAttributeValueId[] getAttributeValueIds()
          Gets the attributeValue IDs which key mapping should be retrieved from repository.
 AttributeKeyMapping[] getKeyMappings()
          Returns the key mappings for all specified attribute values.
 TableId getTaxonomyTableId()
          Returns the taxonomy table ID.
 boolean isDefaultKeysOnly()
          Specifies if only default keys should be loaded.
 void removeAttributeValueId(TextAttributeValueId attributeValueId)
          Removes an attribute value ID from the list of IDs which key mapping should be retrieved from repository.
 void setAttributeId(AttributeId attributeId)
          Sets the attribute ID (required).
 void setAttributeValueIds(TextAttributeValueId[] attributeValueIds)
          Sets attribute value IDs which key mapping should be retrieved from repository (required).
 void setDefaultKeysOnly(boolean isDefaultKeysOnly)
          Indicates if only default keys should be loaded (optional).
 void setTaxonomyTableId(TableId taxonomyTableId)
          Sets the taxonomy 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

RetrieveAttributesKeyMappingsCommand

public RetrieveAttributesKeyMappingsCommand(ConnectionAccessor connection)
Constructor.

Parameters:
connection - the connection to the MDM server

RetrieveAttributesKeyMappingsCommand

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

Parameters:
ctx - the user session context.
Method Detail

getTaxonomyTableId

public TableId getTaxonomyTableId()
Returns the taxonomy table ID.

Returns:
the taxonomy table ID

setTaxonomyTableId

public void setTaxonomyTableId(TableId taxonomyTableId)
Sets the taxonomy table ID (required).

Parameters:
taxonomyTableId - the taxonomy table ID

getAttributeId

public AttributeId getAttributeId()
Returns the attribute ID.

Returns:
the attribute ID

setAttributeId

public void setAttributeId(AttributeId attributeId)
Sets the attribute ID (required).

Parameters:
attributeId - the attribute ID

setAttributeValueIds

public void setAttributeValueIds(TextAttributeValueId[] attributeValueIds)
Sets attribute value IDs which key mapping should be retrieved from repository (required).

Parameters:
attributeValueIds - array of attribute value IDs

getAttributeValueIds

public TextAttributeValueId[] getAttributeValueIds()
Gets the attributeValue IDs which key mapping should be retrieved from repository.

Returns:
array of attribute value IDs

addAttributeValueId

public void addAttributeValueId(TextAttributeValueId attributeValueId)
Adds an attribute value ID to the list of IDs which key mapping should be retrieved from repository (required*).

Parameters:
attributeValueId - attribute value ID to add

removeAttributeValueId

public void removeAttributeValueId(TextAttributeValueId attributeValueId)
Removes an attribute value ID from the list of IDs which key mapping should be retrieved from repository.

Parameters:
attributeValueId - attribute value ID to remove

containsAttributeValueId

public boolean containsAttributeValueId(TextAttributeValueId attributeValueId)
Checks if the specified attribute value ID is contained in the list of IDs which key mapping should be retrieved from repository.

Parameters:
attributeValueId - attribute value ID
Returns:
true if the the text attribute value is found, otherwise false

clearAttributeValueIds

public void clearAttributeValueIds()
Clears the list of attribute value IDs.


isDefaultKeysOnly

public boolean isDefaultKeysOnly()
Specifies if only default keys should be loaded.

Returns:
true if only default keys are loaded, else otherwise

setDefaultKeysOnly

public void setDefaultKeysOnly(boolean isDefaultKeysOnly)
Indicates if only default keys should be loaded (optional). The default is false.

Parameters:
isDefaultKeysOnly - true if only default keys should be retrieved, otherwise false

getKeyMappings

public AttributeKeyMapping[] getKeyMappings()
Returns the key mappings for all specified attribute values.

Returns:
array of AttributeKeyMapping


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.