API Docs for:
Show:

eb_CompanyInformation Class

Company Information class.

Methods

eb_CompanyInformation.domElement

(
  • domElement
)

Page DOM element.

Parameters:

  • domElement Object

    current DOM element.

eb_CompanyInformation.getCompanyAddresses

(
  • companyId
)
Object

Public method to get Company Addresses data list from the server

Parameters:

  • companyId Number

    companyId to get company addresses

Returns:

Object:

Addresses of company

eb_CompanyInformation.getCompanyBillingAddress

() Object

Public method to get company billing address from the server. The service will return company billing address.

Returns:

Object:

jQuery promise object which when resolved returns billing address.

eb_CompanyInformation.getCompanyInformation

() Object

Public method to get company information from the server. The service will return company information.

Returns:

Object:

jQuery promise object which when resolved returns company information.

eb_CompanyInformation.getCompanyMainFax

() Object

Public method to get company main fax from the server. The service will return company main fax.

Returns:

Object:

jQuery promise object which when resolved returns main fax.

eb_CompanyInformation.getCompanyMainPhone

() Object

Public method to get company main phone from the server. The service will return company main phone.

Returns:

Object:

jQuery promise object which when resolved returns main phone.

eb_CompanyInformation.getCompanyPhoneNumberData

() Object

Public method to get company phone data list from the server. The service will return list of all phones.

Returns:

Object:

jQuery promise object which when resolved returns phones list.

eb_CompanyInformation.getCountriesData

() Object

Public method to get countries data list from the server. The service will return list of all countries.

Returns:

Object:

jQuery promise object which when resolved returns countries list.

eb_CompanyInformation.getProfileAddresses

(
  • companyId
)
Object

Public method to get Profile Addresses data list for company from the server.

Parameters:

  • companyId String

    company Id.

Returns:

Object:

jQuery promise object which when resolved returns profile address data.

eb_CompanyInformation.getProfilePhoneNumberData

() Object

Public method to get profile phone data list from the server. The service will return list of all phones.

Returns:

Object:

jQuery promise object which when resolved returns phones list.

eb_CompanyInformation.getProvinceData

(
  • country
)
Object

Public method to get province data list from the server.

Parameters:

  • country String

    Country Id.

Returns:

Object:

jQuery promise object which when resolved returns province list.

eb_CompanyInformation.model

(
  • options
  • userContext
)

Company Information model responsible for company information operations.

Parameters:

  • options Any

    Object of company information data.

    • ServicePath String

      Service URL.

    • SitePath String

      Site URL.

    • templatePath String

      HTML path.

    • domElement Object

      Company information DOM element.

  • userContext Object

    eb_UserContext.model instance.

eb_CompanyInformation.render

(
  • options
)
String

The service will return company information HTML.

Parameters:

  • options Any

    Array of required data.

    • templatePath String

      Company Information template URL.

Returns:

String:

Company Information HTML template.

eb_CompanyInformation.updateCompanyAddressRecord

(
  • companyId
  • data
  • addressName
)
Object

PATCH service call method.

Parameters:

  • companyId Number

    companyId

  • data Object

    Address related information[ State, City, Country ...]

  • addressName String

    Updated information of company Address

Returns:

Object:

Return Updated Address

eb_CompanyInformation.updateCompanyData

(
  • data
)
Object

Update company information method.

Parameters:

  • data Object

    Data to be updated.

Returns:

Object:

jQuery promise object which when resolved returns updated company data.

eb_CompanyInformation.updateCompanyPhoneNumbersData

() Object

Update company phone number information

Returns:

Object:

jQuery promise object

eb_CompanyInformation.updateProfileAddressRecord

(
  • data
  • addressName
)
Object

PATCH service call method.

Parameters:

  • data Object

    Data to be updated.

  • addressName String

    Address name.

Returns:

Object:

jQuery promise object which when resolved returns updated profile address data.

eb_CompanyInformation.updateProfilePhoneNumbersData

() Object

Update profile phone number information of company

Returns:

Object:

jQuery promise object

eb_CompanyInformation.validateAddressData

(
  • country
)
Object

Public method to validate data from the server.

Parameters:

  • country String

    Country Id.

Returns:

Object:

jQuery promise object.

eb_CompanyInformation.validateAddressData

(
  • data
)
Object

Public method to validate data from the server.

Parameters:

  • data String

    Address data.

Returns:

Object:

jQuery promise object which when resolved returns validation results.xxxxxxzzzxxxxzxxstdfgdds

Properties

eb_CompanyInformation.defaultErrorMessage

String

Default error message.

eb_CompanyInformation.errorResponses

Object

Globally defined error codes object for the control. Every error code should have boolean 'useServerMessage' attribute, which when true suggests we are showing service error message on the UI. If the 'useServerMessage' is defined as false, then provide another attribute 'frontEndMessage' with the error string which will be shown on UI. If 'useServerMessage' is false and 'frontEndMessage' is not defined, default error message will be shown. If service error response contains error code not defined in this object then default error message will be shown.

eb_CompanyInformation.ServicePath

String

SOA path.

eb_CompanyInformation.ServicePath

String

SOA serviceUrls. All company information Service URLs.

eb_CompanyInformation.SitePath

String

Site path. It would be set from configuration file.

eb_CompanyInformation.TemplatePath

String

Company Information template path.