Class AddressBase

The addressbook 'subrecord'. In SS2.x this is mostly treated as a normal record object but you can't create or load one from scratch. Typically just reference this type on the appropriate address subrecord property. For example,

Example

- an NSDAL Customer instance can refer to the first address's subrecord simply as:

customer.addressbook[0].addressbookaddress.addr1

Example: - defining custom addressbook subrecord fields.


// define custom fields on address subrecord (optional)
 export class MyCustomAddressClass extends AddressBase {
        // ... define custom address subrecord fields here
   }

 // tell the customer address sublist to use our custom subrecord class
 export class MyAddressSublist extends CustomerAddressSublist {
      @SublistFieldType.subrecord(MyCustomAddressClass)
     addressbookaddress: MyCustomAddressClass
  }

Hierarchy (view full)

Constructors

constructor

Properties

_id addr1 addr2 addr3 addressee addrphone addrtext attention city country defaultValues? nsrecord override state zip

Accessors

id

Methods

getField save toJSON recordType

Constructors

constructor

  • new AddressBase(id, isDynamic?): AddressBase

  • Loads an existing record with the given internal id

    Parameters

    • id: NonNullable<string | number>

      record internal id to load

    • OptionalisDynamic: boolean

      set true if you want to load the record in dynamic mode

    Returns AddressBase

    Example

    // load customer with internal id 123
    const c = new Customer(123)
  • new AddressBase(rec): AddressBase

  • Creates an NSDAL instance for the given existing NetSuite record object. This does NOT reload the record - it just wraps the supplied rec

    Parameters

    • rec: NonNullable<ClientCurrentRecord | Record>

      an existing netsuite record

    Returns AddressBase

    Example

    // assume `ctx` is the _context_ object passed to a `beforeSubmit()` entrypoint.
    // results in an NFT representation of the 'new record'
    const customer = new Customer(ctx.newRecord)
  • new AddressBase(unused?, isDynamic?, defaultvalues?): AddressBase

  • creates a new record

    Parameters

    • Optionalunused: Nullable<string | number>

      either null or leave this parameter out entirely

    • OptionalisDynamic: boolean

      true if you want to create the record in dynamic mode, otherwise uses standard mode.

    • Optionaldefaultvalues: object

      optional defaultvalues object - specific to certain records that allow initializing a new record.

    Returns AddressBase

    Example

    // start a new customer record
    const c = new Customer()

    // start a new customer record in dynamic mode
    const c = new Customer(null, true)

Properties

Protected_id

_id: number

Netsuite internal id of this record

addr1

addr1: string

addr2

addr2: string

addr3

addr3: string

addressee

addressee: string

addrphone

addrphone: string

note this field name differs from the 'records browser' documentation

addrtext

addrtext: string

attention

attention: string

city

city: string

country

country: string

Unlike other select fields which take a numeric internal id value, this one requires the country abbreviation as the key (e.g. 'US')

Protected OptionaldefaultValues

defaultValues?: object

nsrecord

nsrecord: Record

underlying netsuite record

override

override: boolean

state

state: string

zip

zip: string

Accessors

id

  • get id(): number

  • Returns number

Methods

getField

  • getField(field): Field

  • Returns NetSuite field metadata. Useful for doing things like disabling a field on the form programmatically.

    Parameters

    Returns Field

save

  • save(enableSourcing?, ignoreMandatoryFields?): number

  • Persists this record to the NS database

    Parameters

    • OptionalenableSourcing: boolean
    • OptionalignoreMandatoryFields: boolean

    Returns number

toJSON

StaticrecordType

  • recordType(): string | Type

  • The netsuite record type (constant string) - this is declared here and overridden in derived classes

    Returns string | Type

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods