/**
* This code was auto-generated by a Codezu.
*
* Changes to this file may cause incorrect behavior and will be lost if
* the code is regenerated.
*/
package com.mozu.api.resources.commerce.orders.attributedefinition;
import com.mozu.api.ApiContext;
import java.util.List;
import java.util.ArrayList;
import com.mozu.api.MozuClient;
import com.mozu.api.MozuClientFactory;
import com.mozu.api.MozuUrl;
import com.mozu.api.Headers;
import org.joda.time.DateTime;
import com.mozu.api.security.AuthTicket;
import org.apache.commons.lang.StringUtils;
/** <summary>
* Attributes are used to add custom definitions and characteristics to the following objects:
* — are attributes that define the characteristics of products, enabling you to uniquely describe a product. They consist of options, properties, and extras. Refer to [Product Attributes](https://www.mozu.com/docs/guides/catalog/product-attributes.htm) in the Guides section for more information.
* — are custom attributes that you can apply to customer accounts to add further definition for special uses, such as marketing campaigns, or discounts. Refer to [Customer Attributes](https://www.mozu.com/docs/guides/customers/customers.htm#customer_attributes) in the Guides section for more information.
* — are custom attributes that enable you to uniquely describe an aspect of an order. Depending on the attribute definition, either you or a shopper can enter values for the order attribute. Refer to [Order Attributes](https://www.mozu.com/docs/guides/orders/order-attributes.htm) in the Guides section for more information.
* </summary>
*/
public class AttributeResource {
///
/// <see cref="Mozu.Api.ApiContext"/>
///
private ApiContext _apiContext;
public AttributeResource(ApiContext apiContext)
{
_apiContext = apiContext;
}
/**
* Retrieves a paged list of attributes according to any specified filter criteria and sort options.
* <p><pre><code>
* Attribute attribute = new Attribute();
* AttributeCollection attributeCollection = attribute.getAttributes();
* </code></pre></p>
* @return com.mozu.api.contracts.core.extensible.AttributeCollection
* @see com.mozu.api.contracts.core.extensible.AttributeCollection
*/
public com.mozu.api.contracts.core.extensible.AttributeCollection getAttributes() throws Exception
{
return getAttributes( null, null, null, null, null);
}
/**
* Retrieves a paged list of attributes according to any specified filter criteria and sort options.
* <p><pre><code>
* Attribute attribute = new Attribute();
* AttributeCollection attributeCollection = attribute.getAttributes( startIndex, pageSize, sortBy, filter, responseFields);
* </code></pre></p>
* @param filter A set of expressions that consist of a field, operator, and value and represent search parameter syntax when filtering results of a query. Valid operators include equals (eq), does not equal (ne), greater than (gt), less than (lt), greater than or equal to (ge), less than or equal to (le), starts with (sw), or contains (cont). For example - "filter=IsDisplayed+eq+true"
* @param pageSize The number of results to display on each page when creating paged results from a query. The maximum value is 200.
* @param responseFields Use this field to include those fields which are not included by default.
* @param sortBy The property by which to sort results and whether the results appear in ascending (a-z) order, represented by ASC or in descending (z-a) order, represented by DESC. The sortBy parameter follows an available property. For example: "sortBy=productCode+asc"
* @param startIndex When creating paged results from a query, this value indicates the zero-based offset in the complete result set where the returned entities begin. For example, with a PageSize of 25, to get the 51st through the 75th items, use startIndex=3.
* @return com.mozu.api.contracts.core.extensible.AttributeCollection
* @see com.mozu.api.contracts.core.extensible.AttributeCollection
*/
public com.mozu.api.contracts.core.extensible.AttributeCollection getAttributes(Integer startIndex, Integer pageSize, String sortBy, String filter, String responseFields) throws Exception
{
MozuClient<com.mozu.api.contracts.core.extensible.AttributeCollection> client = com.mozu.api.clients.commerce.orders.attributedefinition.AttributeClient.getAttributesClient( startIndex, pageSize, sortBy, filter, responseFields);
client.setContext(_apiContext);
client.executeRequest();
return client.getResult();
}
/**
* Retrieve a list of the vocabulary values defined for the customer attribute specified in the request.
* <p><pre><code>
* Attribute attribute = new Attribute();
* AttributeVocabularyValue attributeVocabularyValue = attribute.getAttributeVocabularyValues( attributeFQN);
* </code></pre></p>
* @param attributeFQN The fully qualified name of the attribute, which is a user defined attribute identifier.
* @return List<com.mozu.api.contracts.core.extensible.AttributeVocabularyValue>
* @see com.mozu.api.contracts.core.extensible.AttributeVocabularyValue
*/
public List<com.mozu.api.contracts.core.extensible.AttributeVocabularyValue> getAttributeVocabularyValues(String attributeFQN) throws Exception
{
MozuClient<List<com.mozu.api.contracts.core.extensible.AttributeVocabularyValue>> client = com.mozu.api.clients.commerce.orders.attributedefinition.AttributeClient.getAttributeVocabularyValuesClient( attributeFQN);
client.setContext(_apiContext);
client.executeRequest();
return client.getResult();
}
/**
* Retrieves the details of the specified product attribute.
* <p><pre><code>
* Attribute attribute = new Attribute();
* Attribute attribute = attribute.getAttribute( attributeFQN);
* </code></pre></p>
* @param attributeFQN The fully qualified name of the attribute, which is a user defined attribute identifier.
* @return com.mozu.api.contracts.core.extensible.Attribute
* @see com.mozu.api.contracts.core.extensible.Attribute
*/
public com.mozu.api.contracts.core.extensible.Attribute getAttribute(String attributeFQN) throws Exception
{
return getAttribute( attributeFQN, null);
}
/**
* Retrieves the details of the specified product attribute.
* <p><pre><code>
* Attribute attribute = new Attribute();
* Attribute attribute = attribute.getAttribute( attributeFQN, responseFields);
* </code></pre></p>
* @param attributeFQN The fully qualified name of the attribute, which is a user defined attribute identifier.
* @param responseFields Use this field to include those fields which are not included by default.
* @return com.mozu.api.contracts.core.extensible.Attribute
* @see com.mozu.api.contracts.core.extensible.Attribute
*/
public com.mozu.api.contracts.core.extensible.Attribute getAttribute(String attributeFQN, String responseFields) throws Exception
{
MozuClient<com.mozu.api.contracts.core.extensible.Attribute> client = com.mozu.api.clients.commerce.orders.attributedefinition.AttributeClient.getAttributeClient( attributeFQN, responseFields);
client.setContext(_apiContext);
client.executeRequest();
return client.getResult();
}
/**
* Create and save a new attribute. These attributes are used in products and product options.
* <p><pre><code>
* Attribute attribute = new Attribute();
* Attribute attribute = attribute.createAttribute( attribute);
* </code></pre></p>
* @param attribute Properties of an attribute used to describe customers or orders.
* @return com.mozu.api.contracts.core.extensible.Attribute
* @see com.mozu.api.contracts.core.extensible.Attribute
* @see com.mozu.api.contracts.core.extensible.Attribute
*/
public com.mozu.api.contracts.core.extensible.Attribute createAttribute(com.mozu.api.contracts.core.extensible.Attribute attribute) throws Exception
{
return createAttribute( attribute, null);
}
/**
* Create and save a new attribute. These attributes are used in products and product options.
* <p><pre><code>
* Attribute attribute = new Attribute();
* Attribute attribute = attribute.createAttribute( attribute, responseFields);
* </code></pre></p>
* @param responseFields Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss.
* @param attribute Properties of an attribute used to describe customers or orders.
* @return com.mozu.api.contracts.core.extensible.Attribute
* @see com.mozu.api.contracts.core.extensible.Attribute
* @see com.mozu.api.contracts.core.extensible.Attribute
*/
public com.mozu.api.contracts.core.extensible.Attribute createAttribute(com.mozu.api.contracts.core.extensible.Attribute attribute, String responseFields) throws Exception
{
MozuClient<com.mozu.api.contracts.core.extensible.Attribute> client = com.mozu.api.clients.commerce.orders.attributedefinition.AttributeClient.createAttributeClient( attribute, responseFields);
client.setContext(_apiContext);
client.executeRequest();
return client.getResult();
}
/**
* Updates an existing attribute with attribute properties to set.
* <p><pre><code>
* Attribute attribute = new Attribute();
* Attribute attribute = attribute.updateAttribute( attribute, attributeFQN);
* </code></pre></p>
* @param attributeFQN Fully qualified name for an attribute.
* @param attribute Properties of an attribute used to describe customers or orders.
* @return com.mozu.api.contracts.core.extensible.Attribute
* @see com.mozu.api.contracts.core.extensible.Attribute
* @see com.mozu.api.contracts.core.extensible.Attribute
*/
public com.mozu.api.contracts.core.extensible.Attribute updateAttribute(com.mozu.api.contracts.core.extensible.Attribute attribute, String attributeFQN) throws Exception
{
return updateAttribute( attribute, attributeFQN, null);
}
/**
* Updates an existing attribute with attribute properties to set.
* <p><pre><code>
* Attribute attribute = new Attribute();
* Attribute attribute = attribute.updateAttribute( attribute, attributeFQN, responseFields);
* </code></pre></p>
* @param attributeFQN Fully qualified name for an attribute.
* @param responseFields Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss.
* @param attribute Properties of an attribute used to describe customers or orders.
* @return com.mozu.api.contracts.core.extensible.Attribute
* @see com.mozu.api.contracts.core.extensible.Attribute
* @see com.mozu.api.contracts.core.extensible.Attribute
*/
public com.mozu.api.contracts.core.extensible.Attribute updateAttribute(com.mozu.api.contracts.core.extensible.Attribute attribute, String attributeFQN, String responseFields) throws Exception
{
MozuClient<com.mozu.api.contracts.core.extensible.Attribute> client = com.mozu.api.clients.commerce.orders.attributedefinition.AttributeClient.updateAttributeClient( attribute, attributeFQN, responseFields);
client.setContext(_apiContext);
client.executeRequest();
return client.getResult();
}
}