Aras Innovator - Programmers Documents/Aras... · PDF fileAras Innovator Programmer's...

Click here to load reader

  • date post

    18-Aug-2018
  • Category

    Documents

  • view

    240
  • download

    1

Embed Size (px)

Transcript of Aras Innovator - Programmers Documents/Aras... · PDF fileAras Innovator Programmer's...

  • Copyright 2007 Aras Corporation All Rights Reserved.

    Aras Innovator Programmer's Guide

    Aras Innovator 8.1

    Document #: 8.1.12042006

    Last Modified: 4/4/2007

    http://www.aras.com/support/http://www.aras.com/support/

  • Page 2

    Copyright 2007 Aras Corporation. All Rights Reserved.

    ARAS CORPORATION Copyright 2006 Aras Corporation. All rights reserved

    Aras Corporation Heritage Place 439 South Union Street Lawrence, MA 01843 Phone: 978-691-8900 Fax: 978-794-9826 E-mail: [email protected] Website: http://www.aras.com

    Notice of Rights

    Copyright 2006 by Aras Corporation. This material may be distributed only subject to the terms and conditions set forth in the Open Publication License, V1.0 or later (the latest version is presently available at http://www.opencontent.org/openpub/).

    Distribution of substantively modified versions of this document is prohibited without the explicit permission of the copyright holder.

    Distribution of the work or derivative of the work in any standard (paper) book form for commercial purposes is prohibited unless prior permission is obtained from the copyright holder.

    Aras Innovator, Aras, and the Aras Corp "A" logo are registered trademarks of Aras Corporation in the United States and other countries.

    All other trademarks referenced herein are the property of their respective owners.

    Notice of Liability

    The information contained in this document is distributed on an "As Is" basis, without warranty of any kind, express or implied, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose or a warranty of non-infringement. Aras shall have no liability to any person or entity with respect to any loss or damage caused or alleged to be caused directly or indirectly by the information contained in this document or by the software or hardware products described herein.

  • Page 3

    Copyright 2007 Aras Corporation. All Rights Reserved.

    Table of Contents SEND US YOUR COMMENTS...........................................................................................7

    1 INTRODUCTION..........................................................................................................8

    1.1 THE ITEM ..................................................................................................................8 1.2 THE AML .................................................................................................................9 1.3 METHODS AND THE IOM ..........................................................................................9

    2 AML ..............................................................................................................................10

    2.1 TAG ...........................................................................................................10 2.2 TAG ..........................................................................................10 2.3 TAGS ..................................................................................................10 2.4 ATTRIBUTES............................................................................................................11

    2.4.1 Item Attributes................................................................................................11 2.4.2 Property Attributes.........................................................................................12

    3 IOM REFERENCE .....................................................................................................13

    3.1 IOMCREDENTIALS CLASS ......................................................................................13 3.2 INNOVATOR CLASS .................................................................................................14 3.3 ITEM CLASS ............................................................................................................14

    3.3.1 Base Methods .................................................................................................14 3.3.2 Boolean Methods ...........................................................................................14 3.3.3 Attribute Methods...........................................................................................14 3.3.4 Property Methods...........................................................................................15 3.3.5 File Methods ..................................................................................................15 3.3.6 Relationship Methods.....................................................................................15 3.3.7 Item Collection Methods ................................................................................16 3.3.8 Logical Methods.............................................................................................17 3.3.9 New Methods..................................................................................................17 3.3.10 Error Methods................................................................................................17 3.3.11 Extended Item Class methods ........................................................................18

    4 METHODS ...................................................................................................................19

    4.1 ITEM ACTIONS EXTEND THE ITEM CLASS ...............................................................19 4.1.1 Context Item...................................................................................................19 4.1.2 Methods are Item Factories ...........................................................................20 4.1.3 Handling the Wrong ItemType.......................................................................20 4.1.4 Methodology ..................................................................................................21

    4.2 BUILT IN ACTION METHODS ...................................................................................21 4.3 GENERIC METHODS ................................................................................................22

    4.3.1 Context Item...................................................................................................22 4.3.2 Methods are Item Factories ...........................................................................22 4.3.3 Methodology ..................................................................................................23

    4.4 SERVER EVENTS .....................................................................................................23 4.4.1 Context Item...................................................................................................23

  • Page 4

    Copyright 2007 Aras Corporation. All Rights Reserved.

    4.4.2 Methodology ..................................................................................................23 4.4.3 Available Server Events .................................................................................24

    4.5 CLIENT EVENTS ......................................................................................................27 4.5.1 Context Item...................................................................................................27 4.5.2 Form Events ...................................................................................................27 4.5.3 Field Events ...................................................................................................28 4.5.4 Grid Events ....................................................................................................29 4.5.5 Item Actions and Server Event.......................................................................32

    5 ACTION ITEMS..........................................................................................................33

    5.1 CLIENT SIDE METHOD RULES .................................................................................33 5.2 SERVER SIDE METHOD RULES ................................................................................34 5.3 USE CASES..............................................................................................................35

    5.3.1 Client side - has cache Item is dirty...............................................................35 5.3.2 Client side - no cache Item - no item_query value.........................................35 5.3.3 Client side - has cache Item not dirty - no item_query value ........................35 5.3.4 Client side - has cache Item not dirty - has item_query value.......................36 5.3.5 Client side - no cache Item - has item_query value .......................................36 5.3.6 Server side - has cache Item is dirty ..............................................................36 5.3.7 Server side - no cache Item - no item_query value........................................37 5.3.8 Server side - has cache Item not dirty - no item_query value........................37 5.3.9 Server side - has cache Item not dirty - has item_query value ......................38 5.3.10 Server side - no cache Item - has item_query value ......................................38

    6 ARAS INNOVATOR METHODOLOGY.................................................................39

    7 COOKBOOK ...............................................................................................................40

    7.1 CREATE AN ARAS INNOVATOR OBJECT...................................................................40 7.2 CREATE AN ITEM OBJECT .......................................................................................40 7.3 QUERY FOR AN ITEM .........................................................