com.sapportals.connector.metadata.structures

Interface IStructure

All Superinterfaces:
ISOAPSerializable
All Known Subinterfaces:
IArrayStructure, IFieldStructure, IRecordSetStructure, IRecordStructure, IUnionStructure

public interface IStructure
extends ISOAPSerializable

This base interface exposes metadata for data structures


Field Summary
static int STRUCTURE_TYPE_ARRAY
          Represents a record set with a single field of any of the other structure types.
static int STRUCTURE_TYPE_COLUMN
          Deprecated. Use STRUCTURE_TYPE_ARRAY instead
static int STRUCTURE_TYPE_FIELD
          Represents a primitive type The specific primitive type can be retrieved by calling IFieldStructure.getType()
static int STRUCTURE_TYPE_RECORD
          Represents a single record
static int STRUCTURE_TYPE_RECORD_SET
          Represents a record set
static int STRUCTURE_TYPE_UNION
          Represents a union - one of the primitive (will be determined in runtime).
 
Method Summary
 int retrieveStructureTypeCode()
          Returns the type code of the structure.
 

Field Detail

STRUCTURE_TYPE_FIELD

public static final int STRUCTURE_TYPE_FIELD
Represents a primitive type The specific primitive type can be retrieved by calling IFieldStructure.getType()

See Also:
IFieldStructure, Constant Field Values

STRUCTURE_TYPE_RECORD_SET

public static final int STRUCTURE_TYPE_RECORD_SET
Represents a record set

See Also:
IRecordSetStructure, Constant Field Values

STRUCTURE_TYPE_RECORD

public static final int STRUCTURE_TYPE_RECORD
Represents a single record

See Also:
IRecordStructure, Constant Field Values

STRUCTURE_TYPE_COLUMN

public static final int STRUCTURE_TYPE_COLUMN
Deprecated. Use STRUCTURE_TYPE_ARRAY instead

See Also:
Constant Field Values

STRUCTURE_TYPE_ARRAY

public static final int STRUCTURE_TYPE_ARRAY
Represents a record set with a single field of any of the other structure types.

See Also:
IArrayStructure, Constant Field Values

STRUCTURE_TYPE_UNION

public static final int STRUCTURE_TYPE_UNION
Represents a union - one of the primitive (will be determined in runtime). Possible types can be retrieved by IUnionStructure.getPossibleTypes(). In runtime, one of those types will be returned. This type can be determined by introspection

See Also:
IUnionStructure, Constant Field Values
Method Detail

retrieveStructureTypeCode

public int retrieveStructureTypeCode()
Returns the type code of the structure.

Returns:
STRUCTURE_TYPE_FIELD, STRUCTURE_TYPE_RESULT_SET, STRUCTURE_TYPE_RECORD, STRUCTURE_TYPE_COLUMN=STRUCTURE_TYPE_ARRAY, STRUCTURE_TYPE_UNION


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.