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 BSCIndex

    Object
       |
       +--GrvObject
             |
             +--EDOIndex
                   |
                   +--BSCIndex

class BSCIndex
extends EDOIndex

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

- konstructor()

Defined in aimbidders.js

Constructor Summary
`BSCIndex ()`

Method Summary
`String` | `_bidString( bindex )` return Bidder description
`String` | `_conString( cindex )` return contact description
`Object` | `_noString()`
`String` | `_shpString( sindex )` return Shipping description
`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> bMethod,<Function> sMethod,<Function> cMethod,<Object> optArg)` Invoke the appropriate method given the index type and return its result.
`void` | `konstructor( <int> optB,<int> optS,<int> optC )`
`<static> BSCIndex` | `Bidder()` Static factory method to generate Bidder-flavored index
`<static> BSCIndex` | `Contact( <int> index )` Static factory method to generate Contact-flavored index
`<static> BSCIndex` | `Shipping( <int> index )` Static factory method to generate Shipping-flavored index

Methods inherited from class GrvObject
`souper`

Constructor Detail

### BSCIndex

    BSCIndex()

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

- konstructor()

Method Detail

### _bidString

    String _bidString( bindex )

return Bidder description

### _conString

    String _conString( cindex )

return contact description

### _noString

    Object _noString()

### _shpString

    String _shpString( sindex )

return Shipping description

### 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> bMethod,<Function> sMethod,<Function> cMethod,<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

`bMethod` - method to call if xi is Bidder type

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

`cMethod` - method to call if xi is Contact type

`optArg` - optional extra param to pass to method

Returns:

the result of the called method

### konstructor

    void konstructor( <int> optB,<int> optS,<int> optC )

Parameters:

`optB` - index into Bidders list for current Auction

`optS` - index into Shipping list for specified Bidder

`optC` - index into contacts list for specified Bidder If args not specified or if all are null then this represents "no selection".

### Bidder

    <static> BSCIndex Bidder()

Static factory method to generate Bidder-flavored index

Parameters:

`index` - Bidder index

### Contact

    <static> BSCIndex Contact( <int> index )

Static factory method to generate Contact-flavored index

Parameters:

`index` - Contact index

### Shipping

    <static> BSCIndex Shipping( <int> index )

Static factory method to generate Shipping-flavored index

Parameters:

`index` - Shipping 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