com.sap.mdm.data.commands
Class RetrieveAttributeLinksCommand

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

public class RetrieveAttributeLinksCommand
extends AbstractUserSessionCommand

A command for retrieving the list of attribute links for a taxonomy record.

See Also:
CreateAttributeLinkCommand

Constructor Summary
RetrieveAttributeLinksCommand(ConnectionAccessor connection)
          Creates an instance.
RetrieveAttributeLinksCommand(UserSessionContext ctx)
          Creates a new instance of this command by context.
 
Method Summary
 AttributeLink[] getAttributeLinks()
          Returns the list of attribute links for the taxonomy record.
 AttributeProperties[] getAttributes()
          Returns the list of attributes.
 RecordId getRecordId()
          Returns the taxonomy record Id.
 TableId getTaxonomyTableId()
          Returns the taxonomy table Id.
 boolean isIncludeAncestors()
          Indicates whether to include ancestor attribute links.
 void setIncludeAncestors(boolean isIncludeAncestors)
          Sets whether to include ancestor attribute links (optional).
 void setRecordId(RecordId recordId)
          Sets the taxonomy record Id (required).
 void setTaxonomyTableId(TableId taxonomyTable)
          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

RetrieveAttributeLinksCommand

public RetrieveAttributeLinksCommand(ConnectionAccessor connection)
Creates an instance.

Parameters:
connection - the connection to the MDM server

RetrieveAttributeLinksCommand

public RetrieveAttributeLinksCommand(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 taxonomyTable)
Sets the taxonomy table Id (required).

Parameters:
taxonomyTable - the taxonomy table Id

getRecordId

public RecordId getRecordId()
Returns the taxonomy record Id.

Returns:
the taxonomy record Id

setRecordId

public void setRecordId(RecordId recordId)
Sets the taxonomy record Id (required).

Parameters:
recordId - the taxonomy record Id

isIncludeAncestors

public boolean isIncludeAncestors()
Indicates whether to include ancestor attribute links.

Returns:
true if include ancestors attribute links, otherwise false

setIncludeAncestors

public void setIncludeAncestors(boolean isIncludeAncestors)
Sets whether to include ancestor attribute links (optional). The default is false.

Parameters:
isIncludeAncestors - true if include ancestors attribute links, otherwise false

getAttributeLinks

public AttributeLink[] getAttributeLinks()
Returns the list of attribute links for the taxonomy record.

Returns:
the list of attribute links

getAttributes

public AttributeProperties[] getAttributes()
Returns the list of attributes.

Returns:
attributes
Since:
5.5 SP6 Patch 04


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.