de.hybris.platform.webservices

Interface WsUtilService

All Known Implementing Classes:

DefaultWsUtilService

public interface WsUtilService

This interface temporarily inholds service method signatures, that was needed in restjersey and was not yet defined in expected platform service classes.

Since:

4.0

Spring Bean ID:

wsUtilService

Method Summary

Modifier and Type	Method and Description
CronJobModel	createCronJobBasedOnCurrent(CronJobModel model, java.lang.String code) Create a cronjob based on delivered cronjob.
void	createEnumerationType(java.lang.String typeCode) Create enumeration value of given enumeration type
EnumerationValueModel	createEnumerationValue(java.lang.String typeCode, java.lang.String valueCode, java.lang.String name) Create enumeration value of given enumeration type
NodeFactory	findNodeFactory(java.lang.Class dtoClass) Returns a NodeFactory for specified dtoClass
AddressModel	getAddress(java.lang.Long pk)
java.util.List<AddressModel>	getAllAddresses() Gets all addresses that belong to users
java.util.Collection<CartModel>	getAllCarts() Gets all carts of system.
java.util.Collection<CompanyModel>	getAllCompanies() Returns collection of all CompanyModel objects
java.util.Collection<CustomerModel>	getAllCustomers() Gets all customers of system.
java.util.Collection<DiscountModel>	getAllDiscounts() Gets all discounts of system.
java.util.Collection<EnumerationMetaTypeModel>	getAllEnumerationTypes() Gets back all enumeration types
java.util.Collection<KeywordModel>	getAllKeywords(CatalogVersionModel versionModel) Returns collection of all Keywords for a specific catalog version
java.util.Collection<RegionModel>	getAllRegions()
java.util.Set<RegionModel>	getAllRegions(java.lang.String countryCode)
java.util.Collection<UnitModel>	getAllUnits() Returns collection of all UnitModel objects
java.util.Collection<UserGroupModel>	getAllUserGroups() Returns collection of all UserGroupModel objects
CompanyModel	getCompany(java.lang.String uid) Returns single CompanyModel object based on CompanyModel uid attribute
java.util.Set<java.lang.String>	getConfigurationForType(int level, java.lang.Class<?> runtimeNodeType, java.util.Map<java.lang.String,java.util.List<java.lang.String>> httpQueryParameters, java.util.Set<java.lang.String> allowedAttributesNames, java.util.List<java.lang.String> possibleConfigNodeNames) Gets a "attribute selector API" configuration for attributes of currently processed graph node.
CustomerModel	getCustomer(java.lang.String login) Returns single CustomerModel object based on CostomerModel login attribute
DeliveryModeModel	getDeliveryModeByCode(java.lang.String code) Returns single DeliveryModeModel object based on DeliveryModeModel code attribute
java.util.Collection<DeliveryModeModel>	getDeliveryModesByCode(java.lang.String code) Returns collection of DeliveryModeModel objects based on DeliveryModeModel code attribute
DiscountModel	getDiscount(java.lang.String code) gets back the discount upon the code
KeywordModel	getKeyword(CatalogVersionModel versionModel, LanguageModel language, java.lang.String keyword) Returns a specified KeywordModel object based on its catalogVersion, Language and value of the keyword
KeywordModel	getKeyword(CatalogVersionModel versionModel, java.lang.String keyword) Returns a specified KeywordModel object based on its catalogVersion and value of the keyword
PaymentModeModel	getPaymentModeByCode(java.lang.String code) Returns single PaymentModeModel object based on PaymentModeModel code attribute
java.util.Collection<PaymentModeModel>	getPaymentModesByCode(java.lang.String code) Returns collection of PaymentModeModel objects based on PaymentModeModel code attribute
RegionModel	getRegion(java.lang.String isocode) gets back the region upon the iso code
RegionModel	getRegion(java.lang.String countryCode, java.lang.String isocode) gets back the region upon the iso code
boolean	isMemberOf(java.lang.String userID, java.lang.String userGroupID, boolean includingSupergroups) Checks whether the principal is member of the given group or any of its subgroups.
void	setCatalogVersionsIntoJaloSession() Set appropriate catalog versions to the jalosession for current authenticated user.
void	setRequestUserIntoJaloSession(java.lang.String userID) Set request user to jalosession.

Method Detail

getAddress

AddressModel getAddress(java.lang.Long pk)

Parameters:

pk - pk of the address to obtain

Returns:

AddressModel

getAllAddresses

java.util.List<AddressModel> getAllAddresses()

Gets all addresses that belong to users

Returns:

all addresses

getAllRegions

java.util.Set<RegionModel> getAllRegions(java.lang.String countryCode)

Parameters:

countryCode - ISO code of a country for which we're retrieving regions

Returns:

all regions

getAllRegions

java.util.Collection<RegionModel> getAllRegions()

getAllUnits

java.util.Collection<UnitModel> getAllUnits()

Returns collection of all UnitModel objects

Returns:

collection of UnitModel objects

getRegion

RegionModel getRegion(java.lang.String isocode)

gets back the region upon the iso code

Parameters:

isocode - code of the region

Returns:

found region

getRegion

RegionModel getRegion(java.lang.String countryCode,
                      java.lang.String isocode)

gets back the region upon the iso code

Parameters:

isocode - code of the region

countryCode - code of the region's country

Returns:

found region

setRequestUserIntoJaloSession

void setRequestUserIntoJaloSession(java.lang.String userID)

Set request user to jalosession.

Parameters:

userID - authenticated user or anonymous user

setCatalogVersionsIntoJaloSession

void setCatalogVersionsIntoJaloSession()

Set appropriate catalog versions to the jalosession for current authenticated user.

getAllCarts

java.util.Collection<CartModel> getAllCarts()

Gets all carts of system.

Returns:

all carts

getAllDiscounts

java.util.Collection<DiscountModel> getAllDiscounts()

Gets all discounts of system.

Returns:

all discounts

getDiscount

DiscountModel getDiscount(java.lang.String code)

gets back the discount upon the code

Parameters:

code - code value of DiscountModel

Returns:

found discount

getAllCustomers

java.util.Collection<CustomerModel> getAllCustomers()

Gets all customers of system.

Returns:

all customers

getCustomer

CustomerModel getCustomer(java.lang.String login)

Returns single CustomerModel object based on CostomerModel login attribute

Parameters:

login - login value of CustomerModel

Returns:

CustomerModel object

getAllUserGroups

java.util.Collection<UserGroupModel> getAllUserGroups()

Returns collection of all UserGroupModel objects

Returns:

collection of UserGroupModel objects

getDeliveryModeByCode

DeliveryModeModel getDeliveryModeByCode(java.lang.String code)

Returns single DeliveryModeModel object based on DeliveryModeModel code attribute

Parameters:

code - code value of DeliveryModeModel

Returns:

DeliveryModeModel object

getDeliveryModesByCode

java.util.Collection<DeliveryModeModel> getDeliveryModesByCode(java.lang.String code)

Returns collection of DeliveryModeModel objects based on DeliveryModeModel code attribute

Parameters:

code - code value of DeliveryModeModel

Returns:

collection of DeliveryModeModel objects

getPaymentModeByCode

PaymentModeModel getPaymentModeByCode(java.lang.String code)

Returns single PaymentModeModel object based on PaymentModeModel code attribute

Parameters:

code - code value of PaymentModeModel

Returns:

PaymentModeModel object

getPaymentModesByCode

java.util.Collection<PaymentModeModel> getPaymentModesByCode(java.lang.String code)

Returns collection of PaymentModeModel objects based on PaymentModeModel code attribute

Parameters:

code - code value of PaymentModeModel

Returns:

collection of PaymentModeModel objects

getAllEnumerationTypes

java.util.Collection<EnumerationMetaTypeModel> getAllEnumerationTypes()

Gets back all enumeration types

Returns:

collection of EnumerationMetaTypeModel

createEnumerationValue

EnumerationValueModel createEnumerationValue(java.lang.String typeCode,
                                             java.lang.String valueCode,
                                             java.lang.String name)

Create enumeration value of given enumeration type

Parameters:

typeCode - enumeration type code

valueCode - enumeration value

name - name of the enumeration value

Returns:

created enumeration value model

createEnumerationType

void createEnumerationType(java.lang.String typeCode)
                    throws JaloDuplicateCodeException

Create enumeration value of given enumeration type

Parameters:

typeCode - enumerationType type code

Throws:

JaloDuplicateCodeException

getCompany

CompanyModel getCompany(java.lang.String uid)

Returns single CompanyModel object based on CompanyModel uid attribute

Parameters:

uid - uid value of CustomerModel

Returns:

CompanyModel object

getAllCompanies

java.util.Collection<CompanyModel> getAllCompanies()

Returns collection of all CompanyModel objects

Returns:

collection of CompanyModel objects

createCronJobBasedOnCurrent

CronJobModel createCronJobBasedOnCurrent(CronJobModel model,
                                         java.lang.String code)

Create a cronjob based on delivered cronjob.

Parameters:

model - current cronjob model

code - of the new cronjob

Returns:

new CronJobModel based on delivered cronjob

getAllKeywords

java.util.Collection<KeywordModel> getAllKeywords(CatalogVersionModel versionModel)

Returns collection of all Keywords for a specific catalog version

Parameters:

versionModel - catalogVersionModel for which we wish to get all Keywords

Returns:

Collection of Keywords

getKeyword

KeywordModel getKeyword(CatalogVersionModel versionModel,
                        java.lang.String keyword)

Returns a specified KeywordModel object based on its catalogVersion and value of the keyword

Parameters:

versionModel - catalog version of the Keyword

keyword - value of the keyword

Returns:

KeywordModel object

getKeyword

KeywordModel getKeyword(CatalogVersionModel versionModel,
                        LanguageModel language,
                        java.lang.String keyword)

Returns a specified KeywordModel object based on its catalogVersion, Language and value of the keyword

Parameters:

versionModel - catalog version of the Keyword

keyword - value of the keyword

language - language in which the keyword is specified

Returns:

KeywordModel object

findNodeFactory

NodeFactory findNodeFactory(java.lang.Class dtoClass)

Returns a NodeFactory for specified dtoClass

Parameters:

dtoClass - the dto class

Returns:

the NodeFactory or null

getConfigurationForType

java.util.Set<java.lang.String> getConfigurationForType(int level,
                                                        java.lang.Class<?> runtimeNodeType,
                                                        java.util.Map<java.lang.String,java.util.List<java.lang.String>> httpQueryParameters,
                                                        java.util.Set<java.lang.String> allowedAttributesNames,
                                                        java.util.List<java.lang.String> possibleConfigNodeNames)

Gets a "attribute selector API" configuration for attributes of currently processed graph node. Node means a DTO instance. The implementation tries to match entries from dynamic or static configuration to the possible node names that are passed in possibleConfigurationNodeNames.

Parameters:

possibleConfigNodeNames - Ordered list of names to look for in configuration. Used to find configuration entries that are valid for currently processed node. More than one configuration entry can be valid for a node. Generally this list should contain node type names and name of the property that refers to the node. The reasons for this are explained below:

• 1.) Consider type hierarchy. A resource can be of type (the DTO type is important here) that is a subtype of some other type. Configuration may be specified for either of these types, or for both, or for any. To handle this scenario possibleConfigurationNodeNames must contain currently processed DTO's type name, and the names of all it's supertypes. The first match "wins", so if the list is sorted so that the most specific type is first, and the least specific type is last, we get automatically "best match" strategy.
• 2.) Consider complex property of a resource. If a resource has a complex property (a property that evaluates to DTO), then the property name is the natural way for users to configure attributes for the resource (DTO) returned by this property. So the property name is a candidate for configuration entry matching. If the property name is placed first on this list, it takes precedence over DTO type name matching.

level - Level of graph processing at which the node appears. The same node may has different configurations on different levels. Level == 0 is for the nodes that represents root element in the output XML. This means that for root resources every element of collection has level == 1 (root element is the collection wrapper)

runtimeNodeType - actual runtime type of the currently processed node.

httpQueryParameters - query parameters as returned by de.hybris.platform.webservices.objectgraphtransformer.YObjectGraphContext .getUriInfo().getQueryParameters(). These are used to provide dynamic configuration entries.

allowedAttributesNames - set of attribute names that are detected by the graph library for current node. The set of attribute names returned by this method, if any, is a subset of allowedAttributes.

Returns:

Set of attribute qualifiers that configurations permits for the given node at given level. The returned set is a subset of allowedAttributes. Returns null if no configuration for the node was found.

isMemberOf

boolean isMemberOf(java.lang.String userID,
                   java.lang.String userGroupID,
                   boolean includingSupergroups)

Checks whether the principal is member of the given group or any of its subgroups.

Parameters:

userID - the user ID.

includingSupergroups - if true indirect membership through group-in-group is evaluated, otherwise only direct membership

userGroupID - the group to check membership for

Returns:

true if this principal is member of the given group or any of its subgroups.