Class PointOfServiceModel

  • All Implemented Interfaces:
    java.io.Serializable

    public class PointOfServiceModel
    extends ItemModel
    Generated model class for type PointOfService first defined at extension basecommerce.
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String _ADVANCEDSHIPPINGNOTICE2POSRELATION
      Generated relation code constant for relation AdvancedShippingNotice2POSRelation defining source attribute advancedShippingNotices in extension warehousing.
      static java.lang.String _BASESTORE2POINTOFSERVICERELATION
      Generated relation code constant for relation BaseStore2PointOfServiceRelation defining source attribute baseStore in extension basecommerce.
      static java.lang.String _STOREEMPLGROUP2POSREL
      Generated relation code constant for relation StoreEmplGroup2POSRel defining source attribute storeEmployeeGroups in extension commerceservices.
      static java.lang.String _TYPECODE
      Generated model type code constant.
      static java.lang.String ADDRESS
      Generated constant - Attribute key of PointOfService.address attribute defined at extension basecommerce.
      static java.lang.String ADVANCEDSHIPPINGNOTICES
      Generated constant - Attribute key of PointOfService.advancedShippingNotices attribute defined at extension warehousing.
      static java.lang.String BASESTORE
      Generated constant - Attribute key of PointOfService.baseStore attribute defined at extension basecommerce.
      static java.lang.String BUSINESSCATEGORY
      Generated constant - Attribute key of PointOfService.businessCategory attribute defined at extension basecommerce.
      static java.lang.String DESCRIPTION
      Generated constant - Attribute key of PointOfService.description attribute defined at extension basecommerce.
      static java.lang.String DISPLAYNAME
      Generated constant - Attribute key of PointOfService.displayName attribute defined at extension commerceservices.
      static java.lang.String FEATURES
      Generated constant - Attribute key of PointOfService.features attribute defined at extension commerceservices.
      static java.lang.String GEOCODETIMESTAMP
      Generated constant - Attribute key of PointOfService.geocodeTimestamp attribute defined at extension basecommerce.
      static java.lang.String LATITUDE
      Generated constant - Attribute key of PointOfService.latitude attribute defined at extension basecommerce.
      static java.lang.String LONGITUDE
      Generated constant - Attribute key of PointOfService.longitude attribute defined at extension basecommerce.
      static java.lang.String MAPICON
      Generated constant - Attribute key of PointOfService.mapIcon attribute defined at extension basecommerce.
      static java.lang.String NAME
      Generated constant - Attribute key of PointOfService.name attribute defined at extension basecommerce.
      static java.lang.String NEARBYSTORERADIUS
      Generated constant - Attribute key of PointOfService.nearbyStoreRadius attribute defined at extension commerceservices.
      static java.lang.String OPENINGSCHEDULE
      Generated constant - Attribute key of PointOfService.openingSchedule attribute defined at extension basecommerce.
      static java.lang.String STORECONTENT
      Generated constant - Attribute key of PointOfService.storeContent attribute defined at extension basecommerce.
      static java.lang.String STOREEMPLOYEEGROUPS
      Generated constant - Attribute key of PointOfService.storeEmployeeGroups attribute defined at extension commerceservices.
      static java.lang.String STOREIMAGE
      Generated constant - Attribute key of PointOfService.storeImage attribute defined at extension basecommerce.
      static java.lang.String TYPE
      Generated constant - Attribute key of PointOfService.type attribute defined at extension basecommerce.
      static java.lang.String WAREHOUSES
      Generated constant - Attribute key of PointOfService.warehouses attribute defined at extension commerceservices.
    • Constructor Summary

      Constructors 
      Constructor Description
      PointOfServiceModel()
      Generated constructor - Default constructor for generic creation.
      PointOfServiceModel​(ItemModelContext ctx)
      Generated constructor - Default constructor for creation with existing context
      PointOfServiceModel​(java.lang.String _name, PointOfServiceTypeEnum _type)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.1.1 Please use the default constructor without parameters
      PointOfServiceModel​(java.lang.String _name, ItemModel _owner, PointOfServiceTypeEnum _type)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.1.1 Please use the default constructor without parameters
    • Field Detail

      • _TYPECODE

        public static final java.lang.String _TYPECODE
        Generated model type code constant.
        See Also:
        Constant Field Values
      • _BASESTORE2POINTOFSERVICERELATION

        public static final java.lang.String _BASESTORE2POINTOFSERVICERELATION
        Generated relation code constant for relation BaseStore2PointOfServiceRelation defining source attribute baseStore in extension basecommerce.
        See Also:
        Constant Field Values
      • _STOREEMPLGROUP2POSREL

        public static final java.lang.String _STOREEMPLGROUP2POSREL
        Generated relation code constant for relation StoreEmplGroup2POSRel defining source attribute storeEmployeeGroups in extension commerceservices.
        See Also:
        Constant Field Values
      • _ADVANCEDSHIPPINGNOTICE2POSRELATION

        public static final java.lang.String _ADVANCEDSHIPPINGNOTICE2POSRELATION
        Generated relation code constant for relation AdvancedShippingNotice2POSRelation defining source attribute advancedShippingNotices in extension warehousing.
        See Also:
        Constant Field Values
      • NAME

        public static final java.lang.String NAME
        Generated constant - Attribute key of PointOfService.name attribute defined at extension basecommerce.
        See Also:
        Constant Field Values
      • ADDRESS

        public static final java.lang.String ADDRESS
        Generated constant - Attribute key of PointOfService.address attribute defined at extension basecommerce.
        See Also:
        Constant Field Values
      • DESCRIPTION

        public static final java.lang.String DESCRIPTION
        Generated constant - Attribute key of PointOfService.description attribute defined at extension basecommerce.
        See Also:
        Constant Field Values
      • TYPE

        public static final java.lang.String TYPE
        Generated constant - Attribute key of PointOfService.type attribute defined at extension basecommerce.
        See Also:
        Constant Field Values
      • MAPICON

        public static final java.lang.String MAPICON
        Generated constant - Attribute key of PointOfService.mapIcon attribute defined at extension basecommerce.
        See Also:
        Constant Field Values
      • LATITUDE

        public static final java.lang.String LATITUDE
        Generated constant - Attribute key of PointOfService.latitude attribute defined at extension basecommerce.
        See Also:
        Constant Field Values
      • LONGITUDE

        public static final java.lang.String LONGITUDE
        Generated constant - Attribute key of PointOfService.longitude attribute defined at extension basecommerce.
        See Also:
        Constant Field Values
      • GEOCODETIMESTAMP

        public static final java.lang.String GEOCODETIMESTAMP
        Generated constant - Attribute key of PointOfService.geocodeTimestamp attribute defined at extension basecommerce.
        See Also:
        Constant Field Values
      • OPENINGSCHEDULE

        public static final java.lang.String OPENINGSCHEDULE
        Generated constant - Attribute key of PointOfService.openingSchedule attribute defined at extension basecommerce.
        See Also:
        Constant Field Values
      • STORECONTENT

        public static final java.lang.String STORECONTENT
        Generated constant - Attribute key of PointOfService.storeContent attribute defined at extension basecommerce.
        See Also:
        Constant Field Values
      • STOREIMAGE

        public static final java.lang.String STOREIMAGE
        Generated constant - Attribute key of PointOfService.storeImage attribute defined at extension basecommerce.
        See Also:
        Constant Field Values
      • BUSINESSCATEGORY

        public static final java.lang.String BUSINESSCATEGORY
        Generated constant - Attribute key of PointOfService.businessCategory attribute defined at extension basecommerce.
        See Also:
        Constant Field Values
      • BASESTORE

        public static final java.lang.String BASESTORE
        Generated constant - Attribute key of PointOfService.baseStore attribute defined at extension basecommerce.
        See Also:
        Constant Field Values
      • DISPLAYNAME

        public static final java.lang.String DISPLAYNAME
        Generated constant - Attribute key of PointOfService.displayName attribute defined at extension commerceservices.
        See Also:
        Constant Field Values
      • NEARBYSTORERADIUS

        public static final java.lang.String NEARBYSTORERADIUS
        Generated constant - Attribute key of PointOfService.nearbyStoreRadius attribute defined at extension commerceservices.
        See Also:
        Constant Field Values
      • FEATURES

        public static final java.lang.String FEATURES
        Generated constant - Attribute key of PointOfService.features attribute defined at extension commerceservices.
        See Also:
        Constant Field Values
      • WAREHOUSES

        public static final java.lang.String WAREHOUSES
        Generated constant - Attribute key of PointOfService.warehouses attribute defined at extension commerceservices.
        See Also:
        Constant Field Values
      • STOREEMPLOYEEGROUPS

        public static final java.lang.String STOREEMPLOYEEGROUPS
        Generated constant - Attribute key of PointOfService.storeEmployeeGroups attribute defined at extension commerceservices.
        See Also:
        Constant Field Values
      • ADVANCEDSHIPPINGNOTICES

        public static final java.lang.String ADVANCEDSHIPPINGNOTICES
        Generated constant - Attribute key of PointOfService.advancedShippingNotices attribute defined at extension warehousing.
        See Also:
        Constant Field Values
    • Constructor Detail

      • PointOfServiceModel

        public PointOfServiceModel()
        Generated constructor - Default constructor for generic creation.
      • PointOfServiceModel

        public PointOfServiceModel​(ItemModelContext ctx)
        Generated constructor - Default constructor for creation with existing context
        Parameters:
        ctx - the model context to be injected, must not be null
      • PointOfServiceModel

        @Deprecated(since="4.1.1",
                    forRemoval=true)
        public PointOfServiceModel​(java.lang.String _name,
                                   PointOfServiceTypeEnum _type)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.1.1 Please use the default constructor without parameters
        Generated constructor - Constructor with all mandatory attributes.
        Parameters:
        _name - initial attribute declared by type PointOfService at extension basecommerce
        _type - initial attribute declared by type PointOfService at extension basecommerce
      • PointOfServiceModel

        @Deprecated(since="4.1.1",
                    forRemoval=true)
        public PointOfServiceModel​(java.lang.String _name,
                                   ItemModel _owner,
                                   PointOfServiceTypeEnum _type)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.1.1 Please use the default constructor without parameters
        Generated constructor - for all mandatory and initial attributes.
        Parameters:
        _name - initial attribute declared by type PointOfService at extension basecommerce
        _owner - initial attribute declared by type Item at extension core
        _type - initial attribute declared by type PointOfService at extension basecommerce
    • Method Detail

      • getAddress

        @Accessor(qualifier="address",
                  type=GETTER)
        public AddressModel getAddress()
        Generated method - Getter of the PointOfService.address attribute defined at extension basecommerce.
        Returns:
        the address
      • getAdvancedShippingNotices

        @Accessor(qualifier="advancedShippingNotices",
                  type=GETTER)
        public java.util.Set<AdvancedShippingNoticeModel> getAdvancedShippingNotices()
        Generated method - Getter of the PointOfService.advancedShippingNotices attribute defined at extension warehousing. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the advancedShippingNotices
      • getBaseStore

        @Accessor(qualifier="baseStore",
                  type=GETTER)
        public BaseStoreModel getBaseStore()
        Generated method - Getter of the PointOfService.baseStore attribute defined at extension basecommerce.
        Returns:
        the baseStore
      • getBusinessCategory

        @Accessor(qualifier="businessCategory",
                  type=GETTER)
        public java.lang.String getBusinessCategory()
        Generated method - Getter of the PointOfService.businessCategory attribute defined at extension basecommerce.
        Returns:
        the businessCategory - Specifies the overarching business category
      • getDescription

        @Accessor(qualifier="description",
                  type=GETTER)
        public java.lang.String getDescription()
        Generated method - Getter of the PointOfService.description attribute defined at extension basecommerce.
        Returns:
        the description
      • getDisplayName

        @Accessor(qualifier="displayName",
                  type=GETTER)
        public java.lang.String getDisplayName()
        Generated method - Getter of the PointOfService.displayName attribute defined at extension commerceservices.
        Returns:
        the displayName - Used as the display name for search results etc.
      • getFeatures

        @Accessor(qualifier="features",
                  type=GETTER)
        public java.util.Set<StoreLocatorFeatureModel> getFeatures()
        Generated method - Getter of the PointOfService.features attribute defined at extension commerceservices. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the features
      • getGeocodeTimestamp

        @Accessor(qualifier="geocodeTimestamp",
                  type=GETTER)
        public java.util.Date getGeocodeTimestamp()
        Generated method - Getter of the PointOfService.geocodeTimestamp attribute defined at extension basecommerce.
        Returns:
        the geocodeTimestamp
      • getLatitude

        @Accessor(qualifier="latitude",
                  type=GETTER)
        public java.lang.Double getLatitude()
        Generated method - Getter of the PointOfService.latitude attribute defined at extension basecommerce.
        Returns:
        the latitude
      • getLongitude

        @Accessor(qualifier="longitude",
                  type=GETTER)
        public java.lang.Double getLongitude()
        Generated method - Getter of the PointOfService.longitude attribute defined at extension basecommerce.
        Returns:
        the longitude
      • getMapIcon

        @Accessor(qualifier="mapIcon",
                  type=GETTER)
        public MediaModel getMapIcon()
        Generated method - Getter of the PointOfService.mapIcon attribute defined at extension basecommerce.
        Returns:
        the mapIcon
      • getName

        @Accessor(qualifier="name",
                  type=GETTER)
        public java.lang.String getName()
        Generated method - Getter of the PointOfService.name attribute defined at extension basecommerce.
        Returns:
        the name
      • getNearbyStoreRadius

        @Accessor(qualifier="nearbyStoreRadius",
                  type=GETTER)
        public java.lang.Double getNearbyStoreRadius()
        Generated method - Getter of the PointOfService.nearbyStoreRadius attribute defined at extension commerceservices.
        Returns:
        the nearbyStoreRadius - Overrides the default search radius when performing a search for nearby PoS from this PoS. Unit is BaseStore's StorelocatorDistanceUnit.
      • getOpeningSchedule

        @Accessor(qualifier="openingSchedule",
                  type=GETTER)
        public OpeningScheduleModel getOpeningSchedule()
        Generated method - Getter of the PointOfService.openingSchedule attribute defined at extension basecommerce.
        Returns:
        the openingSchedule - It is property representing a schedule of opening hours of this point of service.
      • getStoreContent

        @Accessor(qualifier="storeContent",
                  type=GETTER)
        public java.lang.String getStoreContent()
        Generated method - Getter of the PointOfService.storeContent attribute defined at extension basecommerce.
        Returns:
        the storeContent - It is a localized attribute that contains informational store content text.
      • getStoreContent

        @Accessor(qualifier="storeContent",
                  type=GETTER)
        public java.lang.String getStoreContent​(java.util.Locale loc)
        Generated method - Getter of the PointOfService.storeContent attribute defined at extension basecommerce.
        Parameters:
        loc - the value localization key
        Returns:
        the storeContent - It is a localized attribute that contains informational store content text.
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language
      • getStoreEmployeeGroups

        @Accessor(qualifier="storeEmployeeGroups",
                  type=GETTER)
        public java.util.Set<StoreEmployeeGroupModel> getStoreEmployeeGroups()
        Generated method - Getter of the PointOfService.storeEmployeeGroups attribute defined at extension commerceservices. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the storeEmployeeGroups
      • getStoreImage

        @Accessor(qualifier="storeImage",
                  type=GETTER)
        public MediaContainerModel getStoreImage()
        Generated method - Getter of the PointOfService.storeImage attribute defined at extension basecommerce.
        Returns:
        the storeImage - It is a media container with additional images of the store.
      • getWarehouses

        @Accessor(qualifier="warehouses",
                  type=GETTER)
        public java.util.List<WarehouseModel> getWarehouses()
        Generated method - Getter of the PointOfService.warehouses attribute defined at extension commerceservices. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the warehouses
      • setAddress

        @Accessor(qualifier="address",
                  type=SETTER)
        public void setAddress​(AddressModel value)
        Generated method - Setter of PointOfService.address attribute defined at extension basecommerce.
        Parameters:
        value - the address
      • setAdvancedShippingNotices

        @Accessor(qualifier="advancedShippingNotices",
                  type=SETTER)
        public void setAdvancedShippingNotices​(java.util.Set<AdvancedShippingNoticeModel> value)
        Generated method - Setter of PointOfService.advancedShippingNotices attribute defined at extension warehousing.
        Parameters:
        value - the advancedShippingNotices
      • setBaseStore

        @Accessor(qualifier="baseStore",
                  type=SETTER)
        public void setBaseStore​(BaseStoreModel value)
        Generated method - Setter of PointOfService.baseStore attribute defined at extension basecommerce.
        Parameters:
        value - the baseStore
      • setBusinessCategory

        @Accessor(qualifier="businessCategory",
                  type=SETTER)
        public void setBusinessCategory​(java.lang.String value)
        Generated method - Setter of PointOfService.businessCategory attribute defined at extension basecommerce.
        Parameters:
        value - the businessCategory - Specifies the overarching business category
      • setDescription

        @Accessor(qualifier="description",
                  type=SETTER)
        public void setDescription​(java.lang.String value)
        Generated method - Setter of PointOfService.description attribute defined at extension basecommerce.
        Parameters:
        value - the description
      • setDisplayName

        @Accessor(qualifier="displayName",
                  type=SETTER)
        public void setDisplayName​(java.lang.String value)
        Generated method - Setter of PointOfService.displayName attribute defined at extension commerceservices.
        Parameters:
        value - the displayName - Used as the display name for search results etc.
      • setFeatures

        @Accessor(qualifier="features",
                  type=SETTER)
        public void setFeatures​(java.util.Set<StoreLocatorFeatureModel> value)
        Generated method - Setter of PointOfService.features attribute defined at extension commerceservices.
        Parameters:
        value - the features
      • setGeocodeTimestamp

        @Accessor(qualifier="geocodeTimestamp",
                  type=SETTER)
        public void setGeocodeTimestamp​(java.util.Date value)
        Generated method - Setter of PointOfService.geocodeTimestamp attribute defined at extension basecommerce.
        Parameters:
        value - the geocodeTimestamp
      • setLatitude

        @Accessor(qualifier="latitude",
                  type=SETTER)
        public void setLatitude​(java.lang.Double value)
        Generated method - Setter of PointOfService.latitude attribute defined at extension basecommerce.
        Parameters:
        value - the latitude
      • setLongitude

        @Accessor(qualifier="longitude",
                  type=SETTER)
        public void setLongitude​(java.lang.Double value)
        Generated method - Setter of PointOfService.longitude attribute defined at extension basecommerce.
        Parameters:
        value - the longitude
      • setMapIcon

        @Accessor(qualifier="mapIcon",
                  type=SETTER)
        public void setMapIcon​(MediaModel value)
        Generated method - Setter of PointOfService.mapIcon attribute defined at extension basecommerce.
        Parameters:
        value - the mapIcon
      • setName

        @Accessor(qualifier="name",
                  type=SETTER)
        public void setName​(java.lang.String value)
        Generated method - Initial setter of PointOfService.name attribute defined at extension basecommerce. Can only be used at creation of model - before first save.
        Parameters:
        value - the name
      • setNearbyStoreRadius

        @Accessor(qualifier="nearbyStoreRadius",
                  type=SETTER)
        public void setNearbyStoreRadius​(java.lang.Double value)
        Generated method - Setter of PointOfService.nearbyStoreRadius attribute defined at extension commerceservices.
        Parameters:
        value - the nearbyStoreRadius - Overrides the default search radius when performing a search for nearby PoS from this PoS. Unit is BaseStore's StorelocatorDistanceUnit.
      • setOpeningSchedule

        @Accessor(qualifier="openingSchedule",
                  type=SETTER)
        public void setOpeningSchedule​(OpeningScheduleModel value)
        Generated method - Setter of PointOfService.openingSchedule attribute defined at extension basecommerce.
        Parameters:
        value - the openingSchedule - It is property representing a schedule of opening hours of this point of service.
      • setStoreContent

        @Accessor(qualifier="storeContent",
                  type=SETTER)
        public void setStoreContent​(java.lang.String value)
        Generated method - Setter of PointOfService.storeContent attribute defined at extension basecommerce.
        Parameters:
        value - the storeContent - It is a localized attribute that contains informational store content text.
      • setStoreContent

        @Accessor(qualifier="storeContent",
                  type=SETTER)
        public void setStoreContent​(java.lang.String value,
                                    java.util.Locale loc)
        Generated method - Setter of PointOfService.storeContent attribute defined at extension basecommerce.
        Parameters:
        value - the storeContent - It is a localized attribute that contains informational store content text.
        loc - the value localization key
        Throws:
        java.lang.IllegalArgumentException - if localization key cannot be mapped to data language
      • setStoreEmployeeGroups

        @Accessor(qualifier="storeEmployeeGroups",
                  type=SETTER)
        public void setStoreEmployeeGroups​(java.util.Set<StoreEmployeeGroupModel> value)
        Generated method - Setter of PointOfService.storeEmployeeGroups attribute defined at extension commerceservices.
        Parameters:
        value - the storeEmployeeGroups
      • setStoreImage

        @Accessor(qualifier="storeImage",
                  type=SETTER)
        public void setStoreImage​(MediaContainerModel value)
        Generated method - Setter of PointOfService.storeImage attribute defined at extension basecommerce.
        Parameters:
        value - the storeImage - It is a media container with additional images of the store.
      • setWarehouses

        @Accessor(qualifier="warehouses",
                  type=SETTER)
        public void setWarehouses​(java.util.List<WarehouseModel> value)
        Generated method - Setter of PointOfService.warehouses attribute defined at extension commerceservices.
        Parameters:
        value - the warehouses