Overview | File | Class | Tree | Index | Help
| The Gravey 2.5 Framework and AIM RIA
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## Class ALIndex

    Object
       |
       +--GrvObject
             |
             +--EDOIndex
                   |
                   +--ALIndex

class ALIndex
extends EDOIndex

This class encapsulates an EDO index for Auctions/Lots.
Version: 2.0
Author: Bruce Wallace (PolyGlotInc.com)
See:

- konstructor()

Defined in aimauctions.js

Constructor Summary
`ALIndex ()`

Method Summary
`String` | `_auctionString( aindex )` return auction description
`String` | `_lotString( lindex )` return lot description
`Object` | `_noString()`
`String` | `asEventArgs()` return "this" as event handler arg list string
`String` | `asString()` return "this" as a description string
`boolean` | `equals(x)` return whether "this" equals given EDOIndex
`boolean` | `hasSelection()` return whether "this" contains a selection
`Object` | `invoke(<Object> self,<Function> sMethod,<Function> lMethod,<Object> optArg)` Invoke the appropriate method given the index type and return its result.
`void` | `konstructor( <int> optA,<int> optL )`
`<static> ALIndex` | `Auction()` Static factory method to generate Auction-flavored index
`<static> ALIndex` | `Lot( <int> index )` Static factory method to generate Lot-flavored index

Methods inherited from class GrvObject
`souper`

Constructor Detail

### ALIndex

    ALIndex()

Version: 2.0
Author: Bruce Wallace (PolyGlotInc.com)
See:

- konstructor()

Method Detail

### _auctionString

    String _auctionString( aindex )

return auction description

### _lotString

    String _lotString( lindex )

return lot description

### _noString

    Object _noString()

### asEventArgs

    String asEventArgs()

return "this" as event handler arg list string

### asString

    String asString()

return "this" as a description string

### equals

    boolean equals(x)

return whether "this" equals given EDOIndex

### hasSelection

    boolean hasSelection()

return whether "this" contains a selection

### invoke

    Object invoke(<Object> self,<Function> sMethod,<Function> lMethod,<Object> optArg)

Invoke the appropriate method given the index type and return its result. Methods are expected to have the signature

     self.method(this.subindex,optionalArgument)

Parameters:

`self` - the parent object of the method

`sMethod` - method to call if xi is Auction type

`lMethod` - method to call if xi is Lot type

`optArg` - optional extra param to pass to method

Returns:

the result of the called method

### konstructor

    void konstructor( <int> optA,<int> optL )

Parameters:

`optA` - index into auctions list for current Auction

`optL` - index into lots list for specified Auction If args not specified or if all are null then this represents "no selection".

### Auction

    <static> ALIndex Auction()

Static factory method to generate Auction-flavored index

Parameters:

`index` - Auction index

### Lot

    <static> ALIndex Lot( <int> index )

Static factory method to generate Lot-flavored index

Parameters:

`index` - Lot index

Overview | File | Class | Tree | Index | Help
| The Gravey 2.5 Framework and AIM RIA
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Documentation generated by JSDoc on Thu Jan 6 12:46:39 2011