Serialized Form

  • Package com.skava.address.collection.model.datatransferobjects

    • Class com.skava.address.collection.model.datatransferobjects.CollectionAttribute

      class CollectionAttribute extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • defaultValue
          String defaultValue
          Holds the defaultValue of the collection property attribute *
        • description
          String description
          Holds the description of the collection property attribute
        • name
          String name
          Holds the name of the collection property attribute
        • nullable
          boolean nullable
          Holds the validationRule of the collection property attribute
        • possibleValues
          List<String> possibleValues
          The possible values of the attribute.
        • type
          CollectionAttributeType type
          The type of the attribute.

    • Class com.skava.address.collection.model.datatransferobjects.CollectionDataRequest

      class CollectionDataRequest extends com.skava.core.validation.InputModel implements Serializable
      serialVersionUID:
      -7085827381593595560L

      • Serialized Fields

        • authToken
          String authToken
          It refers the authorization token that initiated the transaction.
        • businessId
          long businessId
          It refers the businessId of the collection.
        • collectionId
          long collectionId
          It refers to the identifier of collection
        • description
          String description
          It refers to the name of collection.
        • filters
          String filters
          The filter parameter to hold the query DSL.
        • locale
          String locale
          It refers the localization
        • name
          String name
          It refers to the name of collection.
        • page
          int page
          This parameter will be available for all the services that supports pagination. This parameter is used to mention the starting index of the items which going to responded by the API.
        • properties
          @Valid List<CollectionProperty> properties
          Holds the collection property attributes list
        • propertyName
          String propertyName
          It refers to the name of collection property.
        • size
          int size
          This parameter will be available for all the services that supports pagination. This parameter is used to mention the number of maximum items that needs to be responded for the request.
        • sort
          com.skava.core.qdsl.sort.EcomSorts sort
          The sort parameter for the EcomSort
        • status
          CollectionStatus status
          This is used to change the status of the particular collection.There are three status ACTIVE denotes Entity is in Active status INACTIVE denotes Entity is in In-Active status DELETED denotes Entity is in Deleted status

    • Class com.skava.address.collection.model.datatransferobjects.CollectionPropertiesResponse

      class CollectionPropertiesResponse extends com.skava.core.validation.OutputModel implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

    • Class com.skava.address.collection.model.datatransferobjects.CollectionProperty

      class CollectionProperty extends com.skava.core.validation.InputModel implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • createdBy
          String createdBy
          The created by.
        • createdOn
          Date createdOn
          The Created On.
        • name
          @NotEmpty(message="Collection property name must not be null or empty") String name
          Holds the name of the collection property attribute
        • updatedBy
          String updatedBy
          The updated by.
        • updatedOn
          Date updatedOn
          The Updated On.
        • value
          String value
          Holds the value of the collection property attribute

    • Class com.skava.address.collection.model.datatransferobjects.CollectionPropertyResponse

      class CollectionPropertyResponse extends com.skava.core.validation.OutputModel implements Serializable
      serialVersionUID:
      1L

    • Class com.skava.address.collection.model.datatransferobjects.CollectionRequest

      class CollectionRequest extends com.skava.core.validation.InputModel implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • description
          String description

          description

          This field refers to the description of the collection. This field is optional.

        • name
          String name

          name

          This field refers to the name of collection. This field is required for creating a collection and required in update if name needs to be changed. The length of this field needs to be between 2 - 100 characters.

        • properties
          List<CollectionProperty> properties

          properties

          This field defines the configurations for a collection. Every collection will have values for all properties that are defined in the collection attributes entity. If no properties are provided at the time of creation of a collection, then the properties will be loaded from the collection attributes entity with the default values defined.
        • status
          CollectionStatus status

          status

          This field is used to set or change the status of the particular collection. following are the allowed values, ACTIVE - denotes the collection is in Active status. Service operations can only be performed when a collection is active. INACTIVE - denotes the collection is in In-Active status. Service operation will fail if performed on an inactive collection.

    • Class com.skava.address.collection.model.datatransferobjects.CollectionResponse

      class CollectionResponse extends com.skava.core.validation.OutputModel implements Serializable
      serialVersionUID:
      -7085827381593595560L

      • Serialized Fields

        • businessId
          long businessId
        • createdBy
          String createdBy
        • createdOn
          long createdOn
        • description
          String description
        • id
          long id
        • name
          String name
        • properties
          @Valid List<CollectionProperty> properties
          Holds the collection property attributes list
        • status
          CollectionStatus status
          This is used to change the status of the particular collection.There are three status ACTIVE denotes Entity is in Active status INACTIVE denotes Entity is in In-Active status DELETED denotes Entity is in Deleted status
        • updatedBy
          String updatedBy
        • updatedOn
          long updatedOn

    • Class com.skava.address.collection.model.datatransferobjects.Collections

      class Collections extends Object implements Serializable
      serialVersionUID:
      -7085827381593595560L

      • Serialized Fields

        • businessId
          long businessId
        • createdBy
          String createdBy
          The created by.
        • createdOn
          Date createdOn
          The Created On.
        • description
          String description
        • id
          long id
        • name
          String name
        • status
          CollectionStatus status
        • updatedBy
          String updatedBy
          The updated by.
        • updatedOn
          Date updatedOn
          The Updated On.

    • Class com.skava.address.collection.model.datatransferobjects.CollectionsResponse

      class CollectionsResponse extends com.skava.core.validation.OutputModel implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • collections
          List<Collections> collections
          The collection parameter contains list of collection response data.
        • pageableInfo
          PageableInfo pageableInfo
          Page data consists of page, size, count and total count of the response data

  • Package com.skava.address.collection.model.domain

    • Class com.skava.address.collection.model.domain.CollectionAttributeDomain

      class CollectionAttributeDomain extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • defaultValue
          String defaultValue
          Holds the defaultValue of the collection property attribute
        • description
          String description
          Holds the description of the collection property attribute
        • name
          String name
          Holds the name of the collection property attribute
        • nullable
          boolean nullable
          Holds the validationRule of the collection property attribute
        • possibleValues
          List<String> possibleValues
          The possible values of the attribute.
        • type
          CollectionAttributeType type
          The type of the attribute.

    • Class com.skava.address.collection.model.domain.CollectionDomain

      class CollectionDomain extends Object implements Serializable
      serialVersionUID:
      -4490125222317657635L

      • Serialized Fields

        • businessId
          long businessId
          It refers the businessId of the collection.
        • createdBy
          String createdBy
          Id of the user who created entity.
        • createdOn
          Date createdOn
          Time stamp denotes the created time of the entity.
        • description
          String description
        • filters
          String filters
          The filter parameter to hold the qdsl.
        • id
          long id
          It refers to the identifier of collection
        • name
          String name
          It refers to the name of collection.
        • page
          int page
          This parameter will be available for all the services that supports pagination. This parameter is used to mention the starting index of the items which going to responded by the API.
        • propertiesMap
          Map<String,CollectionPropertyDomain> propertiesMap
          collectionAttributes of the collection
        • size
          int size
          This parameter will be available for all the services that supports pagination. This parameter is used to mention the number of maximum items that needs to be responded for the request.
        • sort
          com.skava.core.qdsl.sort.EcomSorts sort
          The filter parameter to hold the qdsl.
        • status
          CollectionStatus status
          This is used to change the status of the particular collection.There are three status ACTIVE denotes Entity is in Active status INACTIVE denotes Entity is in In-Active status DELETED denotes Entity is in Deleted status
        • updatedBy
          String updatedBy
          Id of the user who updated entity.
        • updatedOn
          Date updatedOn
          Time stamp denotes the updated time of the entity.
        • userId
          String userId
          User Identifier for the transaction.
        • userRoles
          Set<String> userRoles
          User Roles for the transaction.

    • Class com.skava.address.collection.model.domain.CollectionPropertyDomain

      class CollectionPropertyDomain extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • businessId
          long businessId
        • collectionId
          long collectionId
          Holds the collection Id of the collection property
        • createdBy
          String createdBy
          Id of the user who created entity.
        • createdOn
          Date createdOn
          Time stamp denotes the created time of the entity.
        • name
          String name
          Holds the unique name of the collection property
        • updatedBy
          String updatedBy
          Id of the user who updated entity.
        • updatedOn
          Date updatedOn
          Time stamp denotes the updated time of the entity.
        • userId
          String userId
          User Identifier for the transaction.
        • userRoles
          Set<String> userRoles
          User Roles for the transaction.
        • value
          String value
          Holds the value of the collection property

  • Package com.skava.address.collection.model.entity

  • Package com.skava.address.event

  • Package com.skava.address.exceptions

  • Package com.skava.address.helper

  • Package com.skava.address.model.domain

    • Class com.skava.address.model.domain.AddressDO

      class AddressDO extends Object implements Serializable
      serialVersionUID:
      -3020176553843759284L

      • Serialized Fields

        • addressLine1
          String addressLine1
          Door no/ Flat no of the user to be used as delivery address eg: 26.
        • addressLine2
          String addressLine2
          Street of the user to be used as delivery address eg: second street.
        • addressLine3
          String addressLine3
          Street of the user to be used as delivery address eg: third street.
        • addressValidation
          List<AddressValidationDO> addressValidation
          List of address validations that are done to this address
        • cacheKey
          String cacheKey
          Cache Key to store and retrieve information from Cache, it is the combination of address collection identifier and address identifier
        • cacheName
          String cacheName
          Cache Name is classified as a parent of cache key where the collection level cache will be present.
        • canReceiveSMS
          boolean canReceiveSMS
          A flag indicates whether the user can receive sms or not
        • city
          String city
          City of the user to be used as delivery address eg: new york.
        • collectionId
          long collectionId
          Each clients have their own collections with different configurations based on its properties. Address will use different validation techniques based on its collection.
        • companyName
          String companyName
          It is useful for B2B. company name used.
        • country
          String country
          Country of the user to be used as delivery address eg: USA.
        • county
          String county
          County of the user to be used as delivery address eg: denver.
        • email
          String email
          Email of the user to send order status eg: mail@gmail.com.
        • firstName
          String firstName
          It refers first name of the user to be updated.
        • id
          long id
          It refers the identifier of the item.
        • lastName
          String lastName
          It refers last name of the user to be updated.
        • middleName
          String middleName
          It refers middle name of the user to be updated.
        • mobileNumber
          String mobileNumber
          Mobile number of the user to contact the user while delivering the order eg: 9950186725.
        • phone
          String phone
          Phone number of the user to contact the user while delivering the order eg: 9950185.
        • properties
          Map<String,String> properties
          Additional properties of the address validation
        • requestType
          String requestType
          Type of validation request
        • state
          String state
          State of the user to be used as delivery address eg: texas.
        • zip
          String zip
          Zip code of the user to be used as delivery address eg: 99501.

    • Class com.skava.address.model.domain.AddressValidationDO

      class AddressValidationDO extends Object implements Serializable
      serialVersionUID:
      3374979326113112598L

      • Serialized Fields

        • providedBy
          String providedBy
          Partner or Vendor name who validated the address
        • recommendations
          List<AddressDO> recommendations
        • responseCode
          String responseCode
          Response code from the service provider
        • responseMessage
          String responseMessage
          Response message from the service provider
        • responseTime
          long responseTime
          Time when validation was performed
        • validated
          boolean validated
          This flag is used to indicate," " whether the address validation has been done for the given type.
        • validationType
          String validationType
          validationType is the type of address validation that were done to the address

  • Package com.skava.address.model.exchange

    • Class com.skava.address.model.exchange.Address

      class Address extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • addressLine1
          String addressLine1
          Door no/ Flat no of the user to be used as delivery address eg: 26.
        • addressLine2
          String addressLine2
          Street of the user to be used as delivery address eg: second street.
        • addressLine3
          String addressLine3
          Street of the user to be used as delivery address eg: third street.
        • canReceiveSMS
          boolean canReceiveSMS
          A flag indicates whether the user can receive sms or not
        • city
          String city
          City of the user to be used as delivery address eg: new york.
        • companyName
          String companyName
          It is useful for B2B. company name used.
        • country
          String country
          Country of the user to be used as delivery address eg: USA.
        • county
          String county
          County of the user to be used as delivery address eg: denver.
        • email
          String email
          Email of the user to send order status eg: mail@gmail.com. The given email will be validated by the address validation service, If the requested type of validation is digitalAddressValidation.
        • firstName
          String firstName
          It refers first name of the user to be updated.
        • id
          long id
          It refers the identifier of the item.
        • lastName
          String lastName
          It refers last name of the user to be updated.
        • middleName
          String middleName
          It refers middle name of the user to be updated.
        • mobileNumber
          String mobileNumber
          Mobile number of the user to contact the user while delivering the order eg: 9950186725. The given mobile will be validated by the address validation service, If the requested type of validation is phoneDetailsValidation.
        • phone
          String phone
          Phone number of the user to contact the user while delivering the order eg: 9950185. The given phone will be validated by the address validation service, If the requested type of validation is phoneDetailsValidation.
        • properties
          Map<String,String> properties
          Additional properties of the address validation
        • requestType
          String requestType
          Type of validation request
        • state
          String state
          State of the user to be used as delivery address eg: texas.
        • validationDetails
          List<AddressValidation> validationDetails
          List of validation that are done to this address .
        • zip
          String zip
          Zip code of the user to be used as delivery address eg: 99501.

    • Class com.skava.address.model.exchange.AddressValidation

      class AddressValidation extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • overrideValidation
          boolean overrideValidation
          This flag is used to indicate," " whether the address validation has been done for the given type.
        • providedBy
          String providedBy
          Partner or Vendor name who validated the address
        • recommendations
          List<Address> recommendations
        • responseCode
          String responseCode
          Response code from the service provider
        • responseMessage
          String responseMessage
          Response message from the service provider
        • responseTime
          long responseTime
          Time when validation was performed
        • validated
          boolean validated
          This flag is used to indicate," " whether the address validation has been done for the given type.
        • validationType
          String validationType
          validationType is the type of address validation that were done to the address"\

  • Package com.skava.address.model.exchange.request

    • Class com.skava.address.model.exchange.request.AddressRequest

      class AddressRequest extends com.skava.core.validation.InputModel implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • address
          Address address
          It contains the information of addressRequest.
        • collectionId
          long collectionId
          Each clients have their own collections with different configurations based on its properties. Address will use different validation techniques based on its collection.
        • id
          long id
          It refers the identifier of the item.
        • locale
          String locale
          The locale.
        • overrideValidation
          boolean overrideValidation
          The override validation.
        • requestType
          String requestType
          The request type.
        • showRecommendation
          boolean showRecommendation

  • Package com.skava.address.model.exchange.response

  • Package com.skava.address.util