com.sap.mdm.data.commands
Class RetrieveAttributeUsageCommand

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

public class RetrieveAttributeUsageCommand
extends AbstractUserSessionCommand

A command for retrieving the attribute usage. It allows for discovering in all places the attribute is linked.

Since:
5.5 SP6 Patch 04

Constructor Summary
RetrieveAttributeUsageCommand(ConnectionAccessor connection)
          Creates an instance.
RetrieveAttributeUsageCommand(UserSessionContext ctx)
          Creates a new instance of this command by context.
 
Method Summary
 AttributeProperties getAttribute()
          Returns the attribute definition.
 AttributeId getAttributeId()
          Returns the attribute Id.
 TableId getTableId()
          Returns the table Id.
 HierNode getTree()
          Returns the hierarchy tree the attribute is use in.
 RepositoryItemUsage[] getUsage()
          Returns the attribute usage.
 void setAttributeId(AttributeId attributeId)
          Sets the attribute Id (required).
 void setTableId(TableId tableId)
          Sets the taxonomy table Id the attribute is 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

RetrieveAttributeUsageCommand

public RetrieveAttributeUsageCommand(ConnectionAccessor connection)
Creates an instance.

Parameters:
connection - the connection to the MDM server

RetrieveAttributeUsageCommand

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

Parameters:
ctx - the user session context.
Method Detail

getTableId

public TableId getTableId()
Returns the table Id.

Returns:
a table Id

setTableId

public void setTableId(TableId tableId)
Sets the taxonomy table Id the attribute is from (required).

Parameters:
tableId - a table Id

getAttributeId

public AttributeId getAttributeId()
Returns the attribute Id.

Returns:
a attribute Id

setAttributeId

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

Parameters:
attributeId - a attribute Id

getUsage

public RepositoryItemUsage[] getUsage()
Returns the attribute usage.

Returns:
the attribute usage

getTree

public HierNode getTree()
Returns the hierarchy tree the attribute is use in.

Returns:
an hierarchy tree

getAttribute

public AttributeProperties getAttribute()
Returns the attribute definition.

Returns:
an attribute definition


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.