com.belladati.sdk.domain.DomainCreateBuilder Maven / Gradle / Ivy

Go to download
package com.belladati.sdk.domain;

import com.belladati.sdk.util.PostBuilder;

/**
 * Builder used to initiate domain object that should be created.
 * 
 * @author Lubomir Elko
 */
public interface DomainCreateBuilder extends PostBuilder {

	/**
	 * Sets the domain's display name.
	 * 
	 * @param name the domain's display name
	 */
	void setName(String name);

	/**
	 * Sets the domain's description.
	 * 
	 * @param description the domain's description
	 */
	void setDescription(String description);

	/**
	 * Sets the domain's date format.
	 * 
	 * @param dateFormat the domain's date format
	 */
	void setDateFormat(String dateFormat);

	/**
	 * Sets the domain's time format.
	 * 
	 * @param timeFormat the domain's time format
	 */
	void setTimeFormat(String timeFormat);

	/**
	 * Sets the domain's time zone.
	 * 
	 * @param timeZone the domain's time zone
	 */
	void setTimeZone(String timeZone);

	/**
	 * Sets the locale string set for the domain.
	 * 
	 * @param locale the locale string set for the domain
	 */
	void setLocale(String locale);

	/**
	 * Adds the new parameter specified by given key and value.
	 * 
	 * @param key parameter key
	 * @param value parameter value
	 */
	void addParameter(String key, String value);

	/**
	 * Sets the template for the domain.
	 * 
	 * @param id domain template identifier
	 * @param usernameSuffix suffix used during copying users
	 */
	void setTemplate(String id, String usernameSuffix);

	/**
	 * Sets the template identifier for the domain.
	 * 
	 * @param id domain template identifier
	 */
	void setTemplateId(String id);

}