iStore API 115

Download iStore API 115

Post on 08-Apr-2015

108 views

Category:

Documents

2 download

Embed Size (px)

TRANSCRIPT

<p>Oracle iStore</p> <p>API Reference Guide</p> <p>Release 11i</p> <p>October 2001 Part No. A95199-01</p> <p>Oracle iStore API Reference Guide, Release 11i Part No. A95199-01 Copyright 2001, Oracle Corporation. All rights reserved. The Programs (which include both the software and documentation) contain proprietary information of Oracle Corporation; they are provided under a license agreement containing restrictions on use and disclosure and are also protected by copyright, patent, and other intellectual and industrial property laws. Reverse engineering, disassembly, or decompilation of the Programs, except to the extent required to obtain interoperability with other independently created software or as specified by law, is prohibited. The information contained in this document is subject to change without notice. If you find any problems in the documentation, please report them to us in writing. Oracle Corporation does not warrant that this document is error free. Except as may be expressly permitted in your license agreement for these Programs, no part of these Programs may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of Oracle Corporation. If the Programs are delivered to the U.S. Government or anyone licensing or using the programs on behalf of the U.S. Government, the following notice is applicable: Restricted Rights Notice Programs delivered subject to the DOD FAR Supplement are "commercial computer software" and use, duplication, and disclosure of the Programs, including documentation, shall be subject to the licensing restrictions set forth in the applicable Oracle license agreement. Otherwise, Programs delivered subject to the Federal Acquisition Regulations are "restricted computer software" and use, duplication, and disclosure of the Programs shall be subject to the restrictions in FAR 52.227-19, Commercial Computer Software - Restricted Rights (June, 1987). Oracle Corporation, 500 Oracle Parkway, Redwood City, CA 94065. The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherently dangerous applications. It shall be the licensee's responsibility to take all appropriate fail-safe, backup, redundancy, and other measures to ensure the safe use of such applications if the Programs are used for such purposes, and Oracle Corporation disclaims liability for any damages caused by such use of the Programs. Oracle is a registered trademark of Oracle Corporation. Other names may be trademarks of their respective owners.</p> <p>ContentsSend Us Your Comments ................................................................................................................... ix Preface............................................................................................................................................................ xiAudience for This Guide ...................................................................................................................... How To Use This Guide ....................................................................................................................... Typographic Conventions ................................................................................................................... Documentation Accessibility .............................................................................................................. Other Information Sources .................................................................................................................. Do Not Use Database Tools to Modify Oracle Applications Data ................................................ About Oracle ........................................................................................................................................ xi xi xii xii xiii xv xvi</p> <p>1</p> <p>Oracle iStore 11i Store APIs1.1 1.2 1.2.1 1.3 1.3.1 Store API Class Summary .................................................................................................... Class StoreMinisite................................................................................................................ Methods for Class StoreMinisite.................................................................................. Class StoreProfile................................................................................................................. Methods for Class StoreProfile................................................................................... 1-2 1-2 1-2 1-15 1-15</p> <p>2</p> <p>Oracle iStore 11i Display Manager APIs2.1 2.2 2.2.1 2.2.2 2.2.3 Display Manager API Class Summary............................................................................... Class DisplayManager .......................................................................................................... Variables for Class DisplayManager ........................................................................... Constructors for Class DisplayManager..................................................................... Methods for Class DisplayManager ............................................................................ 2-2 2-2 2-2 2-2 2-3</p> <p>iii</p> <p>3</p> <p>Oracle iStore 11i Catalog APIs3.1 3.2 3.2.1 3.2.2 3.3 3.3.1 3.4 3.4.1 3.5 3.5.1 3.5.2 3.6 3.6.1 3.6.2 3.6.3 3.6.4 3.6.5 3.6.6 3.6.7 Catalog API Class Summary................................................................................................ Class Item................................................................................................................................ Variables for Class Item................................................................................................. Methods for Class Item.................................................................................................. Class ItemFlexfield .............................................................................................................. Methods for Class ItemFlexfield ................................................................................ Class PriceObject.................................................................................................................. Methods for Class PriceObject.................................................................................... Class Section ......................................................................................................................... Variables for Class Section .......................................................................................... Methods for Class Section ........................................................................................... Exception Classes ................................................................................................................ SQLException................................................................................................................ FrameworkException................................................................................................... ItemNotFoundException............................................................................................. InvalidColumnNumberException ............................................................................. PriceNotFoundException ............................................................................................ CatalogException.......................................................................................................... SectionNotFoundException ........................................................................................ 3-2 3-3 3-4 3-5 3-38 3-38 3-39 3-40 3-41 3-42 3-42 3-58 3-58 3-58 3-59 3-59 3-59 3-60 3-60</p> <p>4</p> <p>Oracle iStore 11i Shopping Cart Quote APIs4.1 4.2 4.2.1 4.2.2 4.3 4.3.1 4.3.2 4.3.3 4.4 4.4.1 4.4.2 4.5 4.5.1 Shopping Cart Quote API Class Summary........................................................................ Class CCTrxnOutRecord ...................................................................................................... Variables for Class CCTrxnOutRecord ....................................................................... Constructors for Class CCTrxnOutRecord ................................................................. Class Contract ........................................................................................................................ Variables for Class Contract ......................................................................................... Constructors for Class Contract ................................................................................... Methods for Class Contract .......................................................................................... Class ControlRecord.............................................................................................................. Variables for Class ControlRecord............................................................................. Constructors for Class ControlRecord ...................................................................... Class FreightChargeRecord ............................................................................................... Variables for Class FreightChargeRecord................................................................. 4-3 4-4 4-4 4-5 4-6 4-6 4-7 4-7 4-9 4-10 4-11 4-11 4-11</p> <p>iv</p> <p>4.5.2 4.6 4.6.1 4.6.2 4.7 4.7.1 4.7.2 4.8 4.8.1 4.8.2 4.9 4.9.1 4.9.2 4.10 4.10.1 4.10.2 4.11 4.11.1 4.11.2 4.12 4.12.1 4.12.2 4.13 4.13.1 4.13.2 4.14 4.14.1 4.14.2 4.15 4.15.1 4.15.2 4.16 4.16.1 4.16.2 4.17</p> <p>Constructors for Class FreightChargeRecord .......................................................... Class HeaderRecord............................................................................................................ Variables for Class HeaderRecord............................................................................. Constructors for Class HeaderRecord....................................................................... Class LineAttributeExtRecord ........................................................................................... Variables for Class LineAttributeExtRecord ............................................................ Constructors for Class LineAttributeExtRecord...................................................... Class LineDetailRecord ...................................................................................................... Variables for Class LineDetailRecord ....................................................................... Constructors for Class LineDetailRecord ................................................................. Class LineRecord ................................................................................................................. Variables for Class LineRecord .................................................................................. Constructors for Class LineRecord............................................................................ Class LineRelationshipRecord........................................................................................... Variables for Class LineRelationshipRecord............................................................ Constructors for Class LineRelationshipRecord...................................................... Class OrderHeaderRecord ................................................................................................. Variables for Class OrderHeaderRecord .................................................................. Constructors for Class OrderHeaderRecord............................................................ Class PaymentRecord ......................................................................................................... Variables for Class PaymentRecord .......................................................................... Constructors for Class PaymentRecord .................................................................... Class PriceAdjustmentAttributeRecord........................................................................... Variables for Class PriceAdjustmentAttributeRecord............................................ Constructors for Class PriceAdjustmentAttributeRecord...................................... Class PriceAdjustmentRecord ........................................................................................... Variables for Class PriceAdjustmentRecord ............................................................ Constructors for Class PriceAdjustmentRecord...................................................... Class PriceAdjustmentRelationshipRecord..................................................................... Variables for Class PriceAdjustmentRelationshipRecord...................................... Constructors for Class PriceAdjustmentRelationshipRecord................................ Class PriceAttributeRecord................................................................................................ Variables for Class PriceAttributeRecord................................................................. Constructors for Class PriceAttributeRecord........................................................... Class Quote...........................................................................................................................</p> <p>4-14 4-14 4-14 4-23 4-23 4-23 4-25 4-25 4-26 4-32 4-32 4-32 4-37 4-37 4-38 4-39 4-39 4-40 4-40 4-40 4-41 4-44 4-44 4-45 4-47 4-47 4-47 4-54 4-54 4-55 4-56 4-57 4-57 4-68 4-68</p> <p>v</p> <p>4.17.1 4.17.2 4.17.3 4.18 4.18.1 4.18.2 4.19 4.19.1 4.19.2 4.20 4.20.1 4.20.2 4.21 4.21.1 4.21.2 4.22 4.22.1 4.22.2 4.22.3 4.22.4</p> <p>Variables for Class Quote............................................................................................ Constructors for Class Quote...................................................................................... Methods for Class Quote............................................................................................. Class QuoteAccessRecord .................................................................................................. Variables for Class QuoteAccessRecord ................................................................... Constructors for Class QuoteAccessRecord ............................................................. Class ShipmentRecord ........................................................................................................ Variables for Class ShipmentRecord ......................................................................... Constructors for Class ShipmentRecord................................................................... Class SubmitControlRecord...................................................................................</p>