com.sapportals.connector.metadata.relations

Interface IRelation

All Superinterfaces:
ISOAPSerializable
All Known Subinterfaces:
IBlackBoxRelation, IDefaultRelation

public interface IRelation
extends ISOAPSerializable

This interface exposes metadata for a relation between 2 EIS Business Objects


Field Summary
static int BLACKBOX_RELATION
          Constant indicating this relation is a blackbox relation.
static int DEFAULT_RELATION
          Constant indicating this is a regular relation (not a blackbox relation).
 
Method Summary
 String getDescription()
          returns the description of this relation
 String getName()
          Deprecated.  
 IKey getSourceKey()
          Returns the source key of the relation
 IBusinessObject getSourceObject()
          Returns the source business object of the relation.
 IKey getTargetKey()
          Returns the target key of the relation
 IBusinessObject getTargetObject()
          Returns the target business object of the relation.
 boolean isBlackBox()
          Returns whether the relation is a black box
 String retrieveTerm()
          Returns the term describing the parameter, for example "Relation"
 int retrieveTypeCode()
          Deprecated.  
 

Field Detail

BLACKBOX_RELATION

public static final int BLACKBOX_RELATION
Constant indicating this relation is a blackbox relation. For a blackbox relation, it's logic is only known to the connector

See Also:
Constant Field Values

DEFAULT_RELATION

public static final int DEFAULT_RELATION
Constant indicating this is a regular relation (not a blackbox relation). A simple attribute to attribute comparison relation of the type A.x1 = B.y1 and ... A.xn = B.yn

See Also:
Constant Field Values
Method Detail

getName

public String getName()
Deprecated.  

Returns the name of the relation

Returns:
String the name

getSourceObject

public IBusinessObject getSourceObject()
                                throws ConnectorException
Returns the source business object of the relation.

Returns:
IBusinessObject interface
Throws:
ConnectorException
See Also:
IBusinessObject

getSourceKey

public IKey getSourceKey()
                  throws ConnectorException
Returns the source key of the relation

Returns:
IKey the source key of the relation
Throws:
ConnectorException
See Also:
IKey

getTargetObject

public IBusinessObject getTargetObject()
                                throws ConnectorException
Returns the target business object of the relation.

Returns:
IBusinessObject interface
Throws:
ConnectorException
See Also:
IBusinessObject

getTargetKey

public IKey getTargetKey()
                  throws ConnectorException
Returns the target key of the relation

Returns:
IKey the target key of the relation
Throws:
ConnectorException
See Also:
IKey

retrieveTypeCode

public int retrieveTypeCode()
Deprecated.  

returns the type of the relation

Returns:
int typeCode of relation

getDescription

public String getDescription()
returns the description of this relation

Returns:
String the description of this relation

retrieveTerm

public String retrieveTerm()
Returns the term describing the parameter, for example "Relation"

Returns:
The parameter term

isBlackBox

public boolean isBlackBox()
Returns whether the relation is a black box

Returns:
whether the relation is a black box


Copyright 2006 SAP AG. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Microsoft, Windows, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. Oracle is a registered trademark of Oracle Corporation. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc. HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C, World Wide Web Consortium, Massachusetts Institute of Technology. Java is a registered trademark of Sun Microsystems, Inc. JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape. MaxDB is a trademark of MySQL AB, Sweden. 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.