/**
* 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.catalog.admin;
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.AsyncCallback;
import java.util.concurrent.CountDownLatch;
import com.mozu.api.security.AuthTicket;
import org.apache.commons.lang.StringUtils;
/** <summary>
* The Search resource manages all settings and options for providing product search on your site.
* </summary>
*/
public class SearchResource {
///
/// <see cref="Mozu.Api.ApiContext"/>
///
private ApiContext _apiContext;
public SearchResource(ApiContext apiContext)
{
_apiContext = apiContext;
}
/**
* Retrieves the details of the specified search tuning rule.
* <p><pre><code>
* Search search = new Search();
* SearchTuningRule searchTuningRule = search.getSearchTuningRule( searchTuningRuleCode);
* </code></pre></p>
* @param searchTuningRuleCode The unique identifier of the search tuning rule.
* @return com.mozu.api.contracts.productadmin.search.SearchTuningRule
* @see com.mozu.api.contracts.productadmin.search.SearchTuningRule
*/
public com.mozu.api.contracts.productadmin.search.SearchTuningRule getSearchTuningRule(String searchTuningRuleCode) throws Exception
{
return getSearchTuningRule( searchTuningRuleCode, null);
}
/**
* Retrieves the details of the specified search tuning rule.
* <p><pre><code>
* Search search = new Search();
* CountDownLatch latch = search.getSearchTuningRule( searchTuningRuleCode, callback );
* latch.await() * </code></pre></p>
* @param searchTuningRuleCode The unique identifier of the search tuning rule.
* @param callback callback handler for asynchronous operations
* @return com.mozu.api.contracts.productadmin.search.SearchTuningRule
* @see com.mozu.api.contracts.productadmin.search.SearchTuningRule
*/
public CountDownLatch getSearchTuningRuleAsync(String searchTuningRuleCode, AsyncCallback<com.mozu.api.contracts.productadmin.search.SearchTuningRule> callback) throws Exception
{
return getSearchTuningRuleAsync( searchTuningRuleCode, null, callback);
}
/**
* Retrieves the details of the specified search tuning rule.
* <p><pre><code>
* Search search = new Search();
* SearchTuningRule searchTuningRule = search.getSearchTuningRule( searchTuningRuleCode, 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 searchTuningRuleCode The unique identifier of the search tuning rule.
* @return com.mozu.api.contracts.productadmin.search.SearchTuningRule
* @see com.mozu.api.contracts.productadmin.search.SearchTuningRule
*/
public com.mozu.api.contracts.productadmin.search.SearchTuningRule getSearchTuningRule(String searchTuningRuleCode, String responseFields) throws Exception
{
MozuClient<com.mozu.api.contracts.productadmin.search.SearchTuningRule> client = com.mozu.api.clients.commerce.catalog.admin.SearchClient.getSearchTuningRuleClient( searchTuningRuleCode, responseFields);
client.setContext(_apiContext);
client.executeRequest();
return client.getResult();
}
/**
* Retrieves the details of the specified search tuning rule.
* <p><pre><code>
* Search search = new Search();
* CountDownLatch latch = search.getSearchTuningRule( searchTuningRuleCode, responseFields, callback );
* latch.await() * </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 searchTuningRuleCode The unique identifier of the search tuning rule.
* @param callback callback handler for asynchronous operations
* @return com.mozu.api.contracts.productadmin.search.SearchTuningRule
* @see com.mozu.api.contracts.productadmin.search.SearchTuningRule
*/
public CountDownLatch getSearchTuningRuleAsync(String searchTuningRuleCode, String responseFields, AsyncCallback<com.mozu.api.contracts.productadmin.search.SearchTuningRule> callback) throws Exception
{
MozuClient<com.mozu.api.contracts.productadmin.search.SearchTuningRule> client = com.mozu.api.clients.commerce.catalog.admin.SearchClient.getSearchTuningRuleClient( searchTuningRuleCode, responseFields);
client.setContext(_apiContext);
return client.executeRequest(callback);
}
/**
* admin-search Get GetSearchTuningRules description DOCUMENT_HERE
* <p><pre><code>
* Search search = new Search();
* SearchTuningRuleCollection searchTuningRuleCollection = search.getSearchTuningRules();
* </code></pre></p>
* @return com.mozu.api.contracts.productadmin.search.SearchTuningRuleCollection
* @see com.mozu.api.contracts.productadmin.search.SearchTuningRuleCollection
*/
public com.mozu.api.contracts.productadmin.search.SearchTuningRuleCollection getSearchTuningRules() throws Exception
{
return getSearchTuningRules( null, null, null, null, null);
}
/**
* admin-search Get GetSearchTuningRules description DOCUMENT_HERE
* <p><pre><code>
* Search search = new Search();
* CountDownLatch latch = search.getSearchTuningRules( callback );
* latch.await() * </code></pre></p>
* @param callback callback handler for asynchronous operations
* @return com.mozu.api.contracts.productadmin.search.SearchTuningRuleCollection
* @see com.mozu.api.contracts.productadmin.search.SearchTuningRuleCollection
*/
public CountDownLatch getSearchTuningRulesAsync( AsyncCallback<com.mozu.api.contracts.productadmin.search.SearchTuningRuleCollection> callback) throws Exception
{
return getSearchTuningRulesAsync( null, null, null, null, null, callback);
}
/**
* admin-search Get GetSearchTuningRules description DOCUMENT_HERE
* <p><pre><code>
* Search search = new Search();
* SearchTuningRuleCollection searchTuningRuleCollection = search.getSearchTuningRules( startIndex, pageSize, sortBy, filter, responseFields);
* </code></pre></p>
* @param filter A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/applications/sorting-filtering.htm) for a list of supported filters.
* @param pageSize 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50.
* @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 sortBy The element to sort the results by and the channel in which the results appear. Either ascending (a-z) or descending (z-a) channel. Optional. Refer to [Sorting and Filtering](../../../../Developer/applications/sorting-filtering.htm) for more information.
* @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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50.
* @return com.mozu.api.contracts.productadmin.search.SearchTuningRuleCollection
* @see com.mozu.api.contracts.productadmin.search.SearchTuningRuleCollection
*/
public com.mozu.api.contracts.productadmin.search.SearchTuningRuleCollection getSearchTuningRules(Integer startIndex, Integer pageSize, String sortBy, String filter, String responseFields) throws Exception
{
MozuClient<com.mozu.api.contracts.productadmin.search.SearchTuningRuleCollection> client = com.mozu.api.clients.commerce.catalog.admin.SearchClient.getSearchTuningRulesClient( startIndex, pageSize, sortBy, filter, responseFields);
client.setContext(_apiContext);
client.executeRequest();
return client.getResult();
}
/**
* admin-search Get GetSearchTuningRules description DOCUMENT_HERE
* <p><pre><code>
* Search search = new Search();
* CountDownLatch latch = search.getSearchTuningRules( startIndex, pageSize, sortBy, filter, responseFields, callback );
* latch.await() * </code></pre></p>
* @param filter A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/applications/sorting-filtering.htm) for a list of supported filters.
* @param pageSize 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 this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50.
* @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 sortBy The element to sort the results by and the channel in which the results appear. Either ascending (a-z) or descending (z-a) channel. Optional. Refer to [Sorting and Filtering](../../../../Developer/applications/sorting-filtering.htm) for more information.
* @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 pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50.
* @param callback callback handler for asynchronous operations
* @return com.mozu.api.contracts.productadmin.search.SearchTuningRuleCollection
* @see com.mozu.api.contracts.productadmin.search.SearchTuningRuleCollection
*/
public CountDownLatch getSearchTuningRulesAsync(Integer startIndex, Integer pageSize, String sortBy, String filter, String responseFields, AsyncCallback<com.mozu.api.contracts.productadmin.search.SearchTuningRuleCollection> callback) throws Exception
{
MozuClient<com.mozu.api.contracts.productadmin.search.SearchTuningRuleCollection> client = com.mozu.api.clients.commerce.catalog.admin.SearchClient.getSearchTuningRulesClient( startIndex, pageSize, sortBy, filter, responseFields);
client.setContext(_apiContext);
return client.executeRequest(callback);
}
/**
* admin-search Get GetSearchTuningRuleSortFields description DOCUMENT_HERE
* <p><pre><code>
* Search search = new Search();
* SearchTuningRuleSortFields searchTuningRuleSortFields = search.getSearchTuningRuleSortFields();
* </code></pre></p>
* @return com.mozu.api.contracts.productadmin.search.SearchTuningRuleSortFields
* @see com.mozu.api.contracts.productadmin.search.SearchTuningRuleSortFields
*/
public com.mozu.api.contracts.productadmin.search.SearchTuningRuleSortFields getSearchTuningRuleSortFields() throws Exception
{
return getSearchTuningRuleSortFields( null);
}
/**
* admin-search Get GetSearchTuningRuleSortFields description DOCUMENT_HERE
* <p><pre><code>
* Search search = new Search();
* CountDownLatch latch = search.getSearchTuningRuleSortFields( callback );
* latch.await() * </code></pre></p>
* @param callback callback handler for asynchronous operations
* @return com.mozu.api.contracts.productadmin.search.SearchTuningRuleSortFields
* @see com.mozu.api.contracts.productadmin.search.SearchTuningRuleSortFields
*/
public CountDownLatch getSearchTuningRuleSortFieldsAsync( AsyncCallback<com.mozu.api.contracts.productadmin.search.SearchTuningRuleSortFields> callback) throws Exception
{
return getSearchTuningRuleSortFieldsAsync( null, callback);
}
/**
* admin-search Get GetSearchTuningRuleSortFields description DOCUMENT_HERE
* <p><pre><code>
* Search search = new Search();
* SearchTuningRuleSortFields searchTuningRuleSortFields = search.getSearchTuningRuleSortFields( 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.
* @return com.mozu.api.contracts.productadmin.search.SearchTuningRuleSortFields
* @see com.mozu.api.contracts.productadmin.search.SearchTuningRuleSortFields
*/
public com.mozu.api.contracts.productadmin.search.SearchTuningRuleSortFields getSearchTuningRuleSortFields(String responseFields) throws Exception
{
MozuClient<com.mozu.api.contracts.productadmin.search.SearchTuningRuleSortFields> client = com.mozu.api.clients.commerce.catalog.admin.SearchClient.getSearchTuningRuleSortFieldsClient( responseFields);
client.setContext(_apiContext);
client.executeRequest();
return client.getResult();
}
/**
* admin-search Get GetSearchTuningRuleSortFields description DOCUMENT_HERE
* <p><pre><code>
* Search search = new Search();
* CountDownLatch latch = search.getSearchTuningRuleSortFields( responseFields, callback );
* latch.await() * </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 callback callback handler for asynchronous operations
* @return com.mozu.api.contracts.productadmin.search.SearchTuningRuleSortFields
* @see com.mozu.api.contracts.productadmin.search.SearchTuningRuleSortFields
*/
public CountDownLatch getSearchTuningRuleSortFieldsAsync(String responseFields, AsyncCallback<com.mozu.api.contracts.productadmin.search.SearchTuningRuleSortFields> callback) throws Exception
{
MozuClient<com.mozu.api.contracts.productadmin.search.SearchTuningRuleSortFields> client = com.mozu.api.clients.commerce.catalog.admin.SearchClient.getSearchTuningRuleSortFieldsClient( responseFields);
client.setContext(_apiContext);
return client.executeRequest(callback);
}
/**
* Get site search settings
* <p><pre><code>
* Search search = new Search();
* SearchSettings searchSettings = search.getSettings();
* </code></pre></p>
* @return com.mozu.api.contracts.productadmin.SearchSettings
* @see com.mozu.api.contracts.productadmin.SearchSettings
*/
public com.mozu.api.contracts.productadmin.SearchSettings getSettings() throws Exception
{
return getSettings( null);
}
/**
* Get site search settings
* <p><pre><code>
* Search search = new Search();
* CountDownLatch latch = search.getSettings( callback );
* latch.await() * </code></pre></p>
* @param callback callback handler for asynchronous operations
* @return com.mozu.api.contracts.productadmin.SearchSettings
* @see com.mozu.api.contracts.productadmin.SearchSettings
*/
public CountDownLatch getSettingsAsync( AsyncCallback<com.mozu.api.contracts.productadmin.SearchSettings> callback) throws Exception
{
return getSettingsAsync( null, callback);
}
/**
* Get site search settings
* <p><pre><code>
* Search search = new Search();
* SearchSettings searchSettings = search.getSettings( 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.
* @return com.mozu.api.contracts.productadmin.SearchSettings
* @see com.mozu.api.contracts.productadmin.SearchSettings
*/
public com.mozu.api.contracts.productadmin.SearchSettings getSettings(String responseFields) throws Exception
{
MozuClient<com.mozu.api.contracts.productadmin.SearchSettings> client = com.mozu.api.clients.commerce.catalog.admin.SearchClient.getSettingsClient( responseFields);
client.setContext(_apiContext);
client.executeRequest();
return client.getResult();
}
/**
* Get site search settings
* <p><pre><code>
* Search search = new Search();
* CountDownLatch latch = search.getSettings( responseFields, callback );
* latch.await() * </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 callback callback handler for asynchronous operations
* @return com.mozu.api.contracts.productadmin.SearchSettings
* @see com.mozu.api.contracts.productadmin.SearchSettings
*/
public CountDownLatch getSettingsAsync(String responseFields, AsyncCallback<com.mozu.api.contracts.productadmin.SearchSettings> callback) throws Exception
{
MozuClient<com.mozu.api.contracts.productadmin.SearchSettings> client = com.mozu.api.clients.commerce.catalog.admin.SearchClient.getSettingsClient( responseFields);
client.setContext(_apiContext);
return client.executeRequest(callback);
}
/**
* Retrieves a collection of synonyms definitions for product searches. Synonyms aid with determining matches for entered searches.
* <p><pre><code>
* Search search = new Search();
* SynonymDefinitionCollection synonymDefinitionCollection = search.getSynonymDefinitionCollection( localeCode);
* </code></pre></p>
* @param localeCode The two character country code that sets the locale, such as US for United States. Sites, tenants, and catalogs use locale codes for localizing content, such as translated product text per supported country.
* @return com.mozu.api.contracts.productadmin.search.SynonymDefinitionCollection
* @see com.mozu.api.contracts.productadmin.search.SynonymDefinitionCollection
*/
public com.mozu.api.contracts.productadmin.search.SynonymDefinitionCollection getSynonymDefinitionCollection(String localeCode) throws Exception
{
return getSynonymDefinitionCollection( localeCode, null);
}
/**
* Retrieves a collection of synonyms definitions for product searches. Synonyms aid with determining matches for entered searches.
* <p><pre><code>
* Search search = new Search();
* CountDownLatch latch = search.getSynonymDefinitionCollection( localeCode, callback );
* latch.await() * </code></pre></p>
* @param localeCode The two character country code that sets the locale, such as US for United States. Sites, tenants, and catalogs use locale codes for localizing content, such as translated product text per supported country.
* @param callback callback handler for asynchronous operations
* @return com.mozu.api.contracts.productadmin.search.SynonymDefinitionCollection
* @see com.mozu.api.contracts.productadmin.search.SynonymDefinitionCollection
*/
public CountDownLatch getSynonymDefinitionCollectionAsync(String localeCode, AsyncCallback<com.mozu.api.contracts.productadmin.search.SynonymDefinitionCollection> callback) throws Exception
{
return getSynonymDefinitionCollectionAsync( localeCode, null, callback);
}
/**
* Retrieves a collection of synonyms definitions for product searches. Synonyms aid with determining matches for entered searches.
* <p><pre><code>
* Search search = new Search();
* SynonymDefinitionCollection synonymDefinitionCollection = search.getSynonymDefinitionCollection( localeCode, responseFields);
* </code></pre></p>
* @param localeCode The two character country code that sets the locale, such as US for United States. Sites, tenants, and catalogs use locale codes for localizing content, such as translated product text per supported country.
* @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.
* @return com.mozu.api.contracts.productadmin.search.SynonymDefinitionCollection
* @see com.mozu.api.contracts.productadmin.search.SynonymDefinitionCollection
*/
public com.mozu.api.contracts.productadmin.search.SynonymDefinitionCollection getSynonymDefinitionCollection(String localeCode, String responseFields) throws Exception
{
MozuClient<com.mozu.api.contracts.productadmin.search.SynonymDefinitionCollection> client = com.mozu.api.clients.commerce.catalog.admin.SearchClient.getSynonymDefinitionCollectionClient( localeCode, responseFields);
client.setContext(_apiContext);
client.executeRequest();
return client.getResult();
}
/**
* Retrieves a collection of synonyms definitions for product searches. Synonyms aid with determining matches for entered searches.
* <p><pre><code>
* Search search = new Search();
* CountDownLatch latch = search.getSynonymDefinitionCollection( localeCode, responseFields, callback );
* latch.await() * </code></pre></p>
* @param localeCode The two character country code that sets the locale, such as US for United States. Sites, tenants, and catalogs use locale codes for localizing content, such as translated product text per supported country.
* @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 callback callback handler for asynchronous operations
* @return com.mozu.api.contracts.productadmin.search.SynonymDefinitionCollection
* @see com.mozu.api.contracts.productadmin.search.SynonymDefinitionCollection
*/
public CountDownLatch getSynonymDefinitionCollectionAsync(String localeCode, String responseFields, AsyncCallback<com.mozu.api.contracts.productadmin.search.SynonymDefinitionCollection> callback) throws Exception
{
MozuClient<com.mozu.api.contracts.productadmin.search.SynonymDefinitionCollection> client = com.mozu.api.clients.commerce.catalog.admin.SearchClient.getSynonymDefinitionCollectionClient( localeCode, responseFields);
client.setContext(_apiContext);
return client.executeRequest(callback);
}
/**
*
* <p><pre><code>
* Search search = new Search();
* SynonymDefinitionPagedCollection synonymDefinitionPagedCollection = search.getSynonymDefinitions();
* </code></pre></p>
* @return com.mozu.api.contracts.productadmin.search.SynonymDefinitionPagedCollection
* @see com.mozu.api.contracts.productadmin.search.SynonymDefinitionPagedCollection
*/
public com.mozu.api.contracts.productadmin.search.SynonymDefinitionPagedCollection getSynonymDefinitions() throws Exception
{
return getSynonymDefinitions( null, null, null, null, null);
}
/**
*
* <p><pre><code>
* Search search = new Search();
* CountDownLatch latch = search.getSynonymDefinitions( callback );
* latch.await() * </code></pre></p>
* @param callback callback handler for asynchronous operations
* @return com.mozu.api.contracts.productadmin.search.SynonymDefinitionPagedCollection
* @see com.mozu.api.contracts.productadmin.search.SynonymDefinitionPagedCollection
*/
public CountDownLatch getSynonymDefinitionsAsync( AsyncCallback<com.mozu.api.contracts.productadmin.search.SynonymDefinitionPagedCollection> callback) throws Exception
{
return getSynonymDefinitionsAsync( null, null, null, null, null, callback);
}
/**
*
* <p><pre><code>
* Search search = new Search();
* SynonymDefinitionPagedCollection synonymDefinitionPagedCollection = search.getSynonymDefinitions( startIndex, pageSize, sortBy, filter, responseFields);
* </code></pre></p>
* @param filter
* @param pageSize
* @param responseFields
* @param sortBy
* @param startIndex
* @return com.mozu.api.contracts.productadmin.search.SynonymDefinitionPagedCollection
* @see com.mozu.api.contracts.productadmin.search.SynonymDefinitionPagedCollection
*/
public com.mozu.api.contracts.productadmin.search.SynonymDefinitionPagedCollection getSynonymDefinitions(Integer startIndex, Integer pageSize, String sortBy, String filter, String responseFields) throws Exception
{
MozuClient<com.mozu.api.contracts.productadmin.search.SynonymDefinitionPagedCollection> client = com.mozu.api.clients.commerce.catalog.admin.SearchClient.getSynonymDefinitionsClient( startIndex, pageSize, sortBy, filter, responseFields);
client.setContext(_apiContext);
client.executeRequest();
return client.getResult();
}
/**
*
* <p><pre><code>
* Search search = new Search();
* CountDownLatch latch = search.getSynonymDefinitions( startIndex, pageSize, sortBy, filter, responseFields, callback );
* latch.await() * </code></pre></p>
* @param filter
* @param pageSize
* @param responseFields
* @param sortBy
* @param startIndex
* @param callback callback handler for asynchronous operations
* @return com.mozu.api.contracts.productadmin.search.SynonymDefinitionPagedCollection
* @see com.mozu.api.contracts.productadmin.search.SynonymDefinitionPagedCollection
*/
public CountDownLatch getSynonymDefinitionsAsync(Integer startIndex, Integer pageSize, String sortBy, String filter, String responseFields, AsyncCallback<com.mozu.api.contracts.productadmin.search.SynonymDefinitionPagedCollection> callback) throws Exception
{
MozuClient<com.mozu.api.contracts.productadmin.search.SynonymDefinitionPagedCollection> client = com.mozu.api.clients.commerce.catalog.admin.SearchClient.getSynonymDefinitionsClient( startIndex, pageSize, sortBy, filter, responseFields);
client.setContext(_apiContext);
return client.executeRequest(callback);
}
/**
*
* <p><pre><code>
* Search search = new Search();
* SynonymDefinition synonymDefinition = search.getSynonymDefinition( synonymId);
* </code></pre></p>
* @param synonymId
* @return com.mozu.api.contracts.productadmin.search.SynonymDefinition
* @see com.mozu.api.contracts.productadmin.search.SynonymDefinition
*/
public com.mozu.api.contracts.productadmin.search.SynonymDefinition getSynonymDefinition(Integer synonymId) throws Exception
{
return getSynonymDefinition( synonymId, null);
}
/**
*
* <p><pre><code>
* Search search = new Search();
* CountDownLatch latch = search.getSynonymDefinition( synonymId, callback );
* latch.await() * </code></pre></p>
* @param synonymId
* @param callback callback handler for asynchronous operations
* @return com.mozu.api.contracts.productadmin.search.SynonymDefinition
* @see com.mozu.api.contracts.productadmin.search.SynonymDefinition
*/
public CountDownLatch getSynonymDefinitionAsync(Integer synonymId, AsyncCallback<com.mozu.api.contracts.productadmin.search.SynonymDefinition> callback) throws Exception
{
return getSynonymDefinitionAsync( synonymId, null, callback);
}
/**
*
* <p><pre><code>
* Search search = new Search();
* SynonymDefinition synonymDefinition = search.getSynonymDefinition( synonymId, responseFields);
* </code></pre></p>
* @param responseFields
* @param synonymId
* @return com.mozu.api.contracts.productadmin.search.SynonymDefinition
* @see com.mozu.api.contracts.productadmin.search.SynonymDefinition
*/
public com.mozu.api.contracts.productadmin.search.SynonymDefinition getSynonymDefinition(Integer synonymId, String responseFields) throws Exception
{
MozuClient<com.mozu.api.contracts.productadmin.search.SynonymDefinition> client = com.mozu.api.clients.commerce.catalog.admin.SearchClient.getSynonymDefinitionClient( synonymId, responseFields);
client.setContext(_apiContext);
client.executeRequest();
return client.getResult();
}
/**
*
* <p><pre><code>
* Search search = new Search();
* CountDownLatch latch = search.getSynonymDefinition( synonymId, responseFields, callback );
* latch.await() * </code></pre></p>
* @param responseFields
* @param synonymId
* @param callback callback handler for asynchronous operations
* @return com.mozu.api.contracts.productadmin.search.SynonymDefinition
* @see com.mozu.api.contracts.productadmin.search.SynonymDefinition
*/
public CountDownLatch getSynonymDefinitionAsync(Integer synonymId, String responseFields, AsyncCallback<com.mozu.api.contracts.productadmin.search.SynonymDefinition> callback) throws Exception
{
MozuClient<com.mozu.api.contracts.productadmin.search.SynonymDefinition> client = com.mozu.api.clients.commerce.catalog.admin.SearchClient.getSynonymDefinitionClient( synonymId, responseFields);
client.setContext(_apiContext);
return client.executeRequest(callback);
}
/**
* admin-search Post AddSearchTuningRule description DOCUMENT_HERE
* <p><pre><code>
* Search search = new Search();
* SearchTuningRule searchTuningRule = search.addSearchTuningRule( searchTuningRuleIn);
* </code></pre></p>
* @param searchTuningRuleIn Mozu.ProductAdmin.Contracts.Search.SearchTuningRule ApiType DOCUMENT_HERE
* @return com.mozu.api.contracts.productadmin.search.SearchTuningRule
* @see com.mozu.api.contracts.productadmin.search.SearchTuningRule
* @see com.mozu.api.contracts.productadmin.search.SearchTuningRule
*/
public com.mozu.api.contracts.productadmin.search.SearchTuningRule addSearchTuningRule(com.mozu.api.contracts.productadmin.search.SearchTuningRule searchTuningRuleIn) throws Exception
{
return addSearchTuningRule( searchTuningRuleIn, null);
}
/**
* admin-search Post AddSearchTuningRule description DOCUMENT_HERE
* <p><pre><code>
* Search search = new Search();
* CountDownLatch latch = search.addSearchTuningRule( searchTuningRuleIn, callback );
* latch.await() * </code></pre></p>
* @param callback callback handler for asynchronous operations
* @param searchTuningRuleIn Mozu.ProductAdmin.Contracts.Search.SearchTuningRule ApiType DOCUMENT_HERE
* @return com.mozu.api.contracts.productadmin.search.SearchTuningRule
* @see com.mozu.api.contracts.productadmin.search.SearchTuningRule
* @see com.mozu.api.contracts.productadmin.search.SearchTuningRule
*/
public CountDownLatch addSearchTuningRuleAsync(com.mozu.api.contracts.productadmin.search.SearchTuningRule searchTuningRuleIn, AsyncCallback<com.mozu.api.contracts.productadmin.search.SearchTuningRule> callback) throws Exception
{
return addSearchTuningRuleAsync( searchTuningRuleIn, null, callback);
}
/**
* admin-search Post AddSearchTuningRule description DOCUMENT_HERE
* <p><pre><code>
* Search search = new Search();
* SearchTuningRule searchTuningRule = search.addSearchTuningRule( searchTuningRuleIn, 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 searchTuningRuleIn Mozu.ProductAdmin.Contracts.Search.SearchTuningRule ApiType DOCUMENT_HERE
* @return com.mozu.api.contracts.productadmin.search.SearchTuningRule
* @see com.mozu.api.contracts.productadmin.search.SearchTuningRule
* @see com.mozu.api.contracts.productadmin.search.SearchTuningRule
*/
public com.mozu.api.contracts.productadmin.search.SearchTuningRule addSearchTuningRule(com.mozu.api.contracts.productadmin.search.SearchTuningRule searchTuningRuleIn, String responseFields) throws Exception
{
MozuClient<com.mozu.api.contracts.productadmin.search.SearchTuningRule> client = com.mozu.api.clients.commerce.catalog.admin.SearchClient.addSearchTuningRuleClient( searchTuningRuleIn, responseFields);
client.setContext(_apiContext);
client.executeRequest();
return client.getResult();
}
/**
* admin-search Post AddSearchTuningRule description DOCUMENT_HERE
* <p><pre><code>
* Search search = new Search();
* CountDownLatch latch = search.addSearchTuningRule( searchTuningRuleIn, responseFields, callback );
* latch.await() * </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 callback callback handler for asynchronous operations
* @param searchTuningRuleIn Mozu.ProductAdmin.Contracts.Search.SearchTuningRule ApiType DOCUMENT_HERE
* @return com.mozu.api.contracts.productadmin.search.SearchTuningRule
* @see com.mozu.api.contracts.productadmin.search.SearchTuningRule
* @see com.mozu.api.contracts.productadmin.search.SearchTuningRule
*/
public CountDownLatch addSearchTuningRuleAsync(com.mozu.api.contracts.productadmin.search.SearchTuningRule searchTuningRuleIn, String responseFields, AsyncCallback<com.mozu.api.contracts.productadmin.search.SearchTuningRule> callback) throws Exception
{
MozuClient<com.mozu.api.contracts.productadmin.search.SearchTuningRule> client = com.mozu.api.clients.commerce.catalog.admin.SearchClient.addSearchTuningRuleClient( searchTuningRuleIn, responseFields);
client.setContext(_apiContext);
return client.executeRequest(callback);
}
/**
* admin-search Post UpdateSearchTuningRuleSortFields description DOCUMENT_HERE
* <p><pre><code>
* Search search = new Search();
* SearchTuningRuleSortFields searchTuningRuleSortFields = search.updateSearchTuningRuleSortFields( searchTuningRuleSortFieldsIn);
* </code></pre></p>
* @param searchTuningRuleSortFieldsIn Mozu.ProductAdmin.Contracts.Search.SearchTuningRuleSortFields ApiType DOCUMENT_HERE
* @return com.mozu.api.contracts.productadmin.search.SearchTuningRuleSortFields
* @see com.mozu.api.contracts.productadmin.search.SearchTuningRuleSortFields
* @see com.mozu.api.contracts.productadmin.search.SearchTuningRuleSortFields
*/
public com.mozu.api.contracts.productadmin.search.SearchTuningRuleSortFields updateSearchTuningRuleSortFields(com.mozu.api.contracts.productadmin.search.SearchTuningRuleSortFields searchTuningRuleSortFieldsIn) throws Exception
{
return updateSearchTuningRuleSortFields( searchTuningRuleSortFieldsIn, null);
}
/**
* admin-search Post UpdateSearchTuningRuleSortFields description DOCUMENT_HERE
* <p><pre><code>
* Search search = new Search();
* CountDownLatch latch = search.updateSearchTuningRuleSortFields( searchTuningRuleSortFieldsIn, callback );
* latch.await() * </code></pre></p>
* @param callback callback handler for asynchronous operations
* @param searchTuningRuleSortFieldsIn Mozu.ProductAdmin.Contracts.Search.SearchTuningRuleSortFields ApiType DOCUMENT_HERE
* @return com.mozu.api.contracts.productadmin.search.SearchTuningRuleSortFields
* @see com.mozu.api.contracts.productadmin.search.SearchTuningRuleSortFields
* @see com.mozu.api.contracts.productadmin.search.SearchTuningRuleSortFields
*/
public CountDownLatch updateSearchTuningRuleSortFieldsAsync(com.mozu.api.contracts.productadmin.search.SearchTuningRuleSortFields searchTuningRuleSortFieldsIn, AsyncCallback<com.mozu.api.contracts.productadmin.search.SearchTuningRuleSortFields> callback) throws Exception
{
return updateSearchTuningRuleSortFieldsAsync( searchTuningRuleSortFieldsIn, null, callback);
}
/**
* admin-search Post UpdateSearchTuningRuleSortFields description DOCUMENT_HERE
* <p><pre><code>
* Search search = new Search();
* SearchTuningRuleSortFields searchTuningRuleSortFields = search.updateSearchTuningRuleSortFields( searchTuningRuleSortFieldsIn, 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 searchTuningRuleSortFieldsIn Mozu.ProductAdmin.Contracts.Search.SearchTuningRuleSortFields ApiType DOCUMENT_HERE
* @return com.mozu.api.contracts.productadmin.search.SearchTuningRuleSortFields
* @see com.mozu.api.contracts.productadmin.search.SearchTuningRuleSortFields
* @see com.mozu.api.contracts.productadmin.search.SearchTuningRuleSortFields
*/
public com.mozu.api.contracts.productadmin.search.SearchTuningRuleSortFields updateSearchTuningRuleSortFields(com.mozu.api.contracts.productadmin.search.SearchTuningRuleSortFields searchTuningRuleSortFieldsIn, String responseFields) throws Exception
{
MozuClient<com.mozu.api.contracts.productadmin.search.SearchTuningRuleSortFields> client = com.mozu.api.clients.commerce.catalog.admin.SearchClient.updateSearchTuningRuleSortFieldsClient( searchTuningRuleSortFieldsIn, responseFields);
client.setContext(_apiContext);
client.executeRequest();
return client.getResult();
}
/**
* admin-search Post UpdateSearchTuningRuleSortFields description DOCUMENT_HERE
* <p><pre><code>
* Search search = new Search();
* CountDownLatch latch = search.updateSearchTuningRuleSortFields( searchTuningRuleSortFieldsIn, responseFields, callback );
* latch.await() * </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 callback callback handler for asynchronous operations
* @param searchTuningRuleSortFieldsIn Mozu.ProductAdmin.Contracts.Search.SearchTuningRuleSortFields ApiType DOCUMENT_HERE
* @return com.mozu.api.contracts.productadmin.search.SearchTuningRuleSortFields
* @see com.mozu.api.contracts.productadmin.search.SearchTuningRuleSortFields
* @see com.mozu.api.contracts.productadmin.search.SearchTuningRuleSortFields
*/
public CountDownLatch updateSearchTuningRuleSortFieldsAsync(com.mozu.api.contracts.productadmin.search.SearchTuningRuleSortFields searchTuningRuleSortFieldsIn, String responseFields, AsyncCallback<com.mozu.api.contracts.productadmin.search.SearchTuningRuleSortFields> callback) throws Exception
{
MozuClient<com.mozu.api.contracts.productadmin.search.SearchTuningRuleSortFields> client = com.mozu.api.clients.commerce.catalog.admin.SearchClient.updateSearchTuningRuleSortFieldsClient( searchTuningRuleSortFieldsIn, responseFields);
client.setContext(_apiContext);
return client.executeRequest(callback);
}
/**
* Updates synonym definitions for product searches. Synonyms aid with determining matches for entered searches.
* <p><pre><code>
* Search search = new Search();
* SynonymDefinitionCollection synonymDefinitionCollection = search.updateSynonymDefinitionCollection( collection, localeCode);
* </code></pre></p>
* @param localeCode The two character country code that sets the locale, such as US for United States. Sites, tenants, and catalogs use locale codes for localizing content, such as translated product text per supported country.
* @param collection Collection of synonym definitions used for determining search results.
* @return com.mozu.api.contracts.productadmin.search.SynonymDefinitionCollection
* @see com.mozu.api.contracts.productadmin.search.SynonymDefinitionCollection
* @see com.mozu.api.contracts.productadmin.search.SynonymDefinitionCollection
*/
public com.mozu.api.contracts.productadmin.search.SynonymDefinitionCollection updateSynonymDefinitionCollection(com.mozu.api.contracts.productadmin.search.SynonymDefinitionCollection collection, String localeCode) throws Exception
{
return updateSynonymDefinitionCollection( collection, localeCode, null);
}
/**
* Updates synonym definitions for product searches. Synonyms aid with determining matches for entered searches.
* <p><pre><code>
* Search search = new Search();
* CountDownLatch latch = search.updateSynonymDefinitionCollection( collection, localeCode, callback );
* latch.await() * </code></pre></p>
* @param localeCode The two character country code that sets the locale, such as US for United States. Sites, tenants, and catalogs use locale codes for localizing content, such as translated product text per supported country.
* @param callback callback handler for asynchronous operations
* @param collection Collection of synonym definitions used for determining search results.
* @return com.mozu.api.contracts.productadmin.search.SynonymDefinitionCollection
* @see com.mozu.api.contracts.productadmin.search.SynonymDefinitionCollection
* @see com.mozu.api.contracts.productadmin.search.SynonymDefinitionCollection
*/
public CountDownLatch updateSynonymDefinitionCollectionAsync(com.mozu.api.contracts.productadmin.search.SynonymDefinitionCollection collection, String localeCode, AsyncCallback<com.mozu.api.contracts.productadmin.search.SynonymDefinitionCollection> callback) throws Exception
{
return updateSynonymDefinitionCollectionAsync( collection, localeCode, null, callback);
}
/**
* Updates synonym definitions for product searches. Synonyms aid with determining matches for entered searches.
* <p><pre><code>
* Search search = new Search();
* SynonymDefinitionCollection synonymDefinitionCollection = search.updateSynonymDefinitionCollection( collection, localeCode, responseFields);
* </code></pre></p>
* @param localeCode The two character country code that sets the locale, such as US for United States. Sites, tenants, and catalogs use locale codes for localizing content, such as translated product text per supported country.
* @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 collection Collection of synonym definitions used for determining search results.
* @return com.mozu.api.contracts.productadmin.search.SynonymDefinitionCollection
* @see com.mozu.api.contracts.productadmin.search.SynonymDefinitionCollection
* @see com.mozu.api.contracts.productadmin.search.SynonymDefinitionCollection
*/
public com.mozu.api.contracts.productadmin.search.SynonymDefinitionCollection updateSynonymDefinitionCollection(com.mozu.api.contracts.productadmin.search.SynonymDefinitionCollection collection, String localeCode, String responseFields) throws Exception
{
MozuClient<com.mozu.api.contracts.productadmin.search.SynonymDefinitionCollection> client = com.mozu.api.clients.commerce.catalog.admin.SearchClient.updateSynonymDefinitionCollectionClient( collection, localeCode, responseFields);
client.setContext(_apiContext);
client.executeRequest();
return client.getResult();
}
/**
* Updates synonym definitions for product searches. Synonyms aid with determining matches for entered searches.
* <p><pre><code>
* Search search = new Search();
* CountDownLatch latch = search.updateSynonymDefinitionCollection( collection, localeCode, responseFields, callback );
* latch.await() * </code></pre></p>
* @param localeCode The two character country code that sets the locale, such as US for United States. Sites, tenants, and catalogs use locale codes for localizing content, such as translated product text per supported country.
* @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 callback callback handler for asynchronous operations
* @param collection Collection of synonym definitions used for determining search results.
* @return com.mozu.api.contracts.productadmin.search.SynonymDefinitionCollection
* @see com.mozu.api.contracts.productadmin.search.SynonymDefinitionCollection
* @see com.mozu.api.contracts.productadmin.search.SynonymDefinitionCollection
*/
public CountDownLatch updateSynonymDefinitionCollectionAsync(com.mozu.api.contracts.productadmin.search.SynonymDefinitionCollection collection, String localeCode, String responseFields, AsyncCallback<com.mozu.api.contracts.productadmin.search.SynonymDefinitionCollection> callback) throws Exception
{
MozuClient<com.mozu.api.contracts.productadmin.search.SynonymDefinitionCollection> client = com.mozu.api.clients.commerce.catalog.admin.SearchClient.updateSynonymDefinitionCollectionClient( collection, localeCode, responseFields);
client.setContext(_apiContext);
return client.executeRequest(callback);
}
/**
*
* <p><pre><code>
* Search search = new Search();
* SynonymDefinition synonymDefinition = search.addSynonymDefinition( synonymDefinition);
* </code></pre></p>
* @param synonymDefinition
* @return com.mozu.api.contracts.productadmin.search.SynonymDefinition
* @see com.mozu.api.contracts.productadmin.search.SynonymDefinition
* @see com.mozu.api.contracts.productadmin.search.SynonymDefinition
*/
public com.mozu.api.contracts.productadmin.search.SynonymDefinition addSynonymDefinition(com.mozu.api.contracts.productadmin.search.SynonymDefinition synonymDefinition) throws Exception
{
return addSynonymDefinition( synonymDefinition, null);
}
/**
*
* <p><pre><code>
* Search search = new Search();
* CountDownLatch latch = search.addSynonymDefinition( synonymDefinition, callback );
* latch.await() * </code></pre></p>
* @param callback callback handler for asynchronous operations
* @param synonymDefinition
* @return com.mozu.api.contracts.productadmin.search.SynonymDefinition
* @see com.mozu.api.contracts.productadmin.search.SynonymDefinition
* @see com.mozu.api.contracts.productadmin.search.SynonymDefinition
*/
public CountDownLatch addSynonymDefinitionAsync(com.mozu.api.contracts.productadmin.search.SynonymDefinition synonymDefinition, AsyncCallback<com.mozu.api.contracts.productadmin.search.SynonymDefinition> callback) throws Exception
{
return addSynonymDefinitionAsync( synonymDefinition, null, callback);
}
/**
*
* <p><pre><code>
* Search search = new Search();
* SynonymDefinition synonymDefinition = search.addSynonymDefinition( synonymDefinition, responseFields);
* </code></pre></p>
* @param responseFields
* @param synonymDefinition
* @return com.mozu.api.contracts.productadmin.search.SynonymDefinition
* @see com.mozu.api.contracts.productadmin.search.SynonymDefinition
* @see com.mozu.api.contracts.productadmin.search.SynonymDefinition
*/
public com.mozu.api.contracts.productadmin.search.SynonymDefinition addSynonymDefinition(com.mozu.api.contracts.productadmin.search.SynonymDefinition synonymDefinition, String responseFields) throws Exception
{
MozuClient<com.mozu.api.contracts.productadmin.search.SynonymDefinition> client = com.mozu.api.clients.commerce.catalog.admin.SearchClient.addSynonymDefinitionClient( synonymDefinition, responseFields);
client.setContext(_apiContext);
client.executeRequest();
return client.getResult();
}
/**
*
* <p><pre><code>
* Search search = new Search();
* CountDownLatch latch = search.addSynonymDefinition( synonymDefinition, responseFields, callback );
* latch.await() * </code></pre></p>
* @param responseFields
* @param callback callback handler for asynchronous operations
* @param synonymDefinition
* @return com.mozu.api.contracts.productadmin.search.SynonymDefinition
* @see com.mozu.api.contracts.productadmin.search.SynonymDefinition
* @see com.mozu.api.contracts.productadmin.search.SynonymDefinition
*/
public CountDownLatch addSynonymDefinitionAsync(com.mozu.api.contracts.productadmin.search.SynonymDefinition synonymDefinition, String responseFields, AsyncCallback<com.mozu.api.contracts.productadmin.search.SynonymDefinition> callback) throws Exception
{
MozuClient<com.mozu.api.contracts.productadmin.search.SynonymDefinition> client = com.mozu.api.clients.commerce.catalog.admin.SearchClient.addSynonymDefinitionClient( synonymDefinition, responseFields);
client.setContext(_apiContext);
return client.executeRequest(callback);
}
/**
* admin-search Put UpdateSearchTuningRule description DOCUMENT_HERE
* <p><pre><code>
* Search search = new Search();
* SearchTuningRule searchTuningRule = search.updateSearchTuningRule( searchTuningRuleIn, searchTuningRuleCode);
* </code></pre></p>
* @param searchTuningRuleCode The unique identifier of the search tuning rule.
* @param searchTuningRuleIn Mozu.ProductAdmin.Contracts.Search.SearchTuningRule ApiType DOCUMENT_HERE
* @return com.mozu.api.contracts.productadmin.search.SearchTuningRule
* @see com.mozu.api.contracts.productadmin.search.SearchTuningRule
* @see com.mozu.api.contracts.productadmin.search.SearchTuningRule
*/
public com.mozu.api.contracts.productadmin.search.SearchTuningRule updateSearchTuningRule(com.mozu.api.contracts.productadmin.search.SearchTuningRule searchTuningRuleIn, String searchTuningRuleCode) throws Exception
{
return updateSearchTuningRule( searchTuningRuleIn, searchTuningRuleCode, null);
}
/**
* admin-search Put UpdateSearchTuningRule description DOCUMENT_HERE
* <p><pre><code>
* Search search = new Search();
* CountDownLatch latch = search.updateSearchTuningRule( searchTuningRuleIn, searchTuningRuleCode, callback );
* latch.await() * </code></pre></p>
* @param searchTuningRuleCode The unique identifier of the search tuning rule.
* @param callback callback handler for asynchronous operations
* @param searchTuningRuleIn Mozu.ProductAdmin.Contracts.Search.SearchTuningRule ApiType DOCUMENT_HERE
* @return com.mozu.api.contracts.productadmin.search.SearchTuningRule
* @see com.mozu.api.contracts.productadmin.search.SearchTuningRule
* @see com.mozu.api.contracts.productadmin.search.SearchTuningRule
*/
public CountDownLatch updateSearchTuningRuleAsync(com.mozu.api.contracts.productadmin.search.SearchTuningRule searchTuningRuleIn, String searchTuningRuleCode, AsyncCallback<com.mozu.api.contracts.productadmin.search.SearchTuningRule> callback) throws Exception
{
return updateSearchTuningRuleAsync( searchTuningRuleIn, searchTuningRuleCode, null, callback);
}
/**
* admin-search Put UpdateSearchTuningRule description DOCUMENT_HERE
* <p><pre><code>
* Search search = new Search();
* SearchTuningRule searchTuningRule = search.updateSearchTuningRule( searchTuningRuleIn, searchTuningRuleCode, 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 searchTuningRuleCode The unique identifier of the search tuning rule.
* @param searchTuningRuleIn Mozu.ProductAdmin.Contracts.Search.SearchTuningRule ApiType DOCUMENT_HERE
* @return com.mozu.api.contracts.productadmin.search.SearchTuningRule
* @see com.mozu.api.contracts.productadmin.search.SearchTuningRule
* @see com.mozu.api.contracts.productadmin.search.SearchTuningRule
*/
public com.mozu.api.contracts.productadmin.search.SearchTuningRule updateSearchTuningRule(com.mozu.api.contracts.productadmin.search.SearchTuningRule searchTuningRuleIn, String searchTuningRuleCode, String responseFields) throws Exception
{
MozuClient<com.mozu.api.contracts.productadmin.search.SearchTuningRule> client = com.mozu.api.clients.commerce.catalog.admin.SearchClient.updateSearchTuningRuleClient( searchTuningRuleIn, searchTuningRuleCode, responseFields);
client.setContext(_apiContext);
client.executeRequest();
return client.getResult();
}
/**
* admin-search Put UpdateSearchTuningRule description DOCUMENT_HERE
* <p><pre><code>
* Search search = new Search();
* CountDownLatch latch = search.updateSearchTuningRule( searchTuningRuleIn, searchTuningRuleCode, responseFields, callback );
* latch.await() * </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 searchTuningRuleCode The unique identifier of the search tuning rule.
* @param callback callback handler for asynchronous operations
* @param searchTuningRuleIn Mozu.ProductAdmin.Contracts.Search.SearchTuningRule ApiType DOCUMENT_HERE
* @return com.mozu.api.contracts.productadmin.search.SearchTuningRule
* @see com.mozu.api.contracts.productadmin.search.SearchTuningRule
* @see com.mozu.api.contracts.productadmin.search.SearchTuningRule
*/
public CountDownLatch updateSearchTuningRuleAsync(com.mozu.api.contracts.productadmin.search.SearchTuningRule searchTuningRuleIn, String searchTuningRuleCode, String responseFields, AsyncCallback<com.mozu.api.contracts.productadmin.search.SearchTuningRule> callback) throws Exception
{
MozuClient<com.mozu.api.contracts.productadmin.search.SearchTuningRule> client = com.mozu.api.clients.commerce.catalog.admin.SearchClient.updateSearchTuningRuleClient( searchTuningRuleIn, searchTuningRuleCode, responseFields);
client.setContext(_apiContext);
return client.executeRequest(callback);
}
/**
* Adds or Updates (Upsert) the Search Settings for a specific site
* <p><pre><code>
* Search search = new Search();
* SearchSettings searchSettings = search.updateSettings( settings);
* </code></pre></p>
* @param settings The settings to control product search and indexing behavior.
* @return com.mozu.api.contracts.productadmin.SearchSettings
* @see com.mozu.api.contracts.productadmin.SearchSettings
* @see com.mozu.api.contracts.productadmin.SearchSettings
*/
public com.mozu.api.contracts.productadmin.SearchSettings updateSettings(com.mozu.api.contracts.productadmin.SearchSettings settings) throws Exception
{
return updateSettings( settings, null);
}
/**
* Adds or Updates (Upsert) the Search Settings for a specific site
* <p><pre><code>
* Search search = new Search();
* CountDownLatch latch = search.updateSettings( settings, callback );
* latch.await() * </code></pre></p>
* @param callback callback handler for asynchronous operations
* @param settings The settings to control product search and indexing behavior.
* @return com.mozu.api.contracts.productadmin.SearchSettings
* @see com.mozu.api.contracts.productadmin.SearchSettings
* @see com.mozu.api.contracts.productadmin.SearchSettings
*/
public CountDownLatch updateSettingsAsync(com.mozu.api.contracts.productadmin.SearchSettings settings, AsyncCallback<com.mozu.api.contracts.productadmin.SearchSettings> callback) throws Exception
{
return updateSettingsAsync( settings, null, callback);
}
/**
* Adds or Updates (Upsert) the Search Settings for a specific site
* <p><pre><code>
* Search search = new Search();
* SearchSettings searchSettings = search.updateSettings( settings, 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 settings The settings to control product search and indexing behavior.
* @return com.mozu.api.contracts.productadmin.SearchSettings
* @see com.mozu.api.contracts.productadmin.SearchSettings
* @see com.mozu.api.contracts.productadmin.SearchSettings
*/
public com.mozu.api.contracts.productadmin.SearchSettings updateSettings(com.mozu.api.contracts.productadmin.SearchSettings settings, String responseFields) throws Exception
{
MozuClient<com.mozu.api.contracts.productadmin.SearchSettings> client = com.mozu.api.clients.commerce.catalog.admin.SearchClient.updateSettingsClient( settings, responseFields);
client.setContext(_apiContext);
client.executeRequest();
return client.getResult();
}
/**
* Adds or Updates (Upsert) the Search Settings for a specific site
* <p><pre><code>
* Search search = new Search();
* CountDownLatch latch = search.updateSettings( settings, responseFields, callback );
* latch.await() * </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 callback callback handler for asynchronous operations
* @param settings The settings to control product search and indexing behavior.
* @return com.mozu.api.contracts.productadmin.SearchSettings
* @see com.mozu.api.contracts.productadmin.SearchSettings
* @see com.mozu.api.contracts.productadmin.SearchSettings
*/
public CountDownLatch updateSettingsAsync(com.mozu.api.contracts.productadmin.SearchSettings settings, String responseFields, AsyncCallback<com.mozu.api.contracts.productadmin.SearchSettings> callback) throws Exception
{
MozuClient<com.mozu.api.contracts.productadmin.SearchSettings> client = com.mozu.api.clients.commerce.catalog.admin.SearchClient.updateSettingsClient( settings, responseFields);
client.setContext(_apiContext);
return client.executeRequest(callback);
}
/**
*
* <p><pre><code>
* Search search = new Search();
* SynonymDefinition synonymDefinition = search.updateSynonymDefinition( synonymDefinition, synonymId);
* </code></pre></p>
* @param synonymId
* @param synonymDefinition
* @return com.mozu.api.contracts.productadmin.search.SynonymDefinition
* @see com.mozu.api.contracts.productadmin.search.SynonymDefinition
* @see com.mozu.api.contracts.productadmin.search.SynonymDefinition
*/
public com.mozu.api.contracts.productadmin.search.SynonymDefinition updateSynonymDefinition(com.mozu.api.contracts.productadmin.search.SynonymDefinition synonymDefinition, Integer synonymId) throws Exception
{
return updateSynonymDefinition( synonymDefinition, synonymId, null);
}
/**
*
* <p><pre><code>
* Search search = new Search();
* CountDownLatch latch = search.updateSynonymDefinition( synonymDefinition, synonymId, callback );
* latch.await() * </code></pre></p>
* @param synonymId
* @param callback callback handler for asynchronous operations
* @param synonymDefinition
* @return com.mozu.api.contracts.productadmin.search.SynonymDefinition
* @see com.mozu.api.contracts.productadmin.search.SynonymDefinition
* @see com.mozu.api.contracts.productadmin.search.SynonymDefinition
*/
public CountDownLatch updateSynonymDefinitionAsync(com.mozu.api.contracts.productadmin.search.SynonymDefinition synonymDefinition, Integer synonymId, AsyncCallback<com.mozu.api.contracts.productadmin.search.SynonymDefinition> callback) throws Exception
{
return updateSynonymDefinitionAsync( synonymDefinition, synonymId, null, callback);
}
/**
*
* <p><pre><code>
* Search search = new Search();
* SynonymDefinition synonymDefinition = search.updateSynonymDefinition( synonymDefinition, synonymId, responseFields);
* </code></pre></p>
* @param responseFields
* @param synonymId
* @param synonymDefinition
* @return com.mozu.api.contracts.productadmin.search.SynonymDefinition
* @see com.mozu.api.contracts.productadmin.search.SynonymDefinition
* @see com.mozu.api.contracts.productadmin.search.SynonymDefinition
*/
public com.mozu.api.contracts.productadmin.search.SynonymDefinition updateSynonymDefinition(com.mozu.api.contracts.productadmin.search.SynonymDefinition synonymDefinition, Integer synonymId, String responseFields) throws Exception
{
MozuClient<com.mozu.api.contracts.productadmin.search.SynonymDefinition> client = com.mozu.api.clients.commerce.catalog.admin.SearchClient.updateSynonymDefinitionClient( synonymDefinition, synonymId, responseFields);
client.setContext(_apiContext);
client.executeRequest();
return client.getResult();
}
/**
*
* <p><pre><code>
* Search search = new Search();
* CountDownLatch latch = search.updateSynonymDefinition( synonymDefinition, synonymId, responseFields, callback );
* latch.await() * </code></pre></p>
* @param responseFields
* @param synonymId
* @param callback callback handler for asynchronous operations
* @param synonymDefinition
* @return com.mozu.api.contracts.productadmin.search.SynonymDefinition
* @see com.mozu.api.contracts.productadmin.search.SynonymDefinition
* @see com.mozu.api.contracts.productadmin.search.SynonymDefinition
*/
public CountDownLatch updateSynonymDefinitionAsync(com.mozu.api.contracts.productadmin.search.SynonymDefinition synonymDefinition, Integer synonymId, String responseFields, AsyncCallback<com.mozu.api.contracts.productadmin.search.SynonymDefinition> callback) throws Exception
{
MozuClient<com.mozu.api.contracts.productadmin.search.SynonymDefinition> client = com.mozu.api.clients.commerce.catalog.admin.SearchClient.updateSynonymDefinitionClient( synonymDefinition, synonymId, responseFields);
client.setContext(_apiContext);
return client.executeRequest(callback);
}
/**
* Deletes the specified search tuning rule.
* <p><pre><code>
* Search search = new Search();
* search.deleteSearchTuningRule( searchTuningRuleCode);
* </code></pre></p>
* @param searchTuningRuleCode The unique identifier of the search tuning rule.
* @return
*/
public void deleteSearchTuningRule(String searchTuningRuleCode) throws Exception
{
MozuClient client = com.mozu.api.clients.commerce.catalog.admin.SearchClient.deleteSearchTuningRuleClient( searchTuningRuleCode);
client.setContext(_apiContext);
client.executeRequest();
client.cleanupHttpConnection();
}
/**
*
* <p><pre><code>
* Search search = new Search();
* search.deleteSynonymDefinition( synonymId);
* </code></pre></p>
* @param synonymId
* @return
*/
public void deleteSynonymDefinition(Integer synonymId) throws Exception
{
MozuClient client = com.mozu.api.clients.commerce.catalog.admin.SearchClient.deleteSynonymDefinitionClient( synonymId);
client.setContext(_apiContext);
client.executeRequest();
client.cleanupHttpConnection();
}
}