/**
 * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
 *
 * The contents of this file are subject to the terms of the Liferay Enterprise
 * Subscription License ("License"). You may not use this file except in
 * compliance with the License. You can obtain a copy of the License by
 * contacting Liferay, Inc. See the License for the specific language governing
 * permissions and limitations under the License, including but not limited to
 * distribution rights of the Software.
 *
 *
 *
 */

package com.liferay.portlet.dynamicdatamapping.model;

import aQute.bnd.annotation.ProviderType;

import com.liferay.portal.LocaleException;
import com.liferay.portal.kernel.bean.AutoEscape;
import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.model.BaseModel;
import com.liferay.portal.model.CacheModel;
import com.liferay.portal.model.StagedGroupedModel;
import com.liferay.portal.model.TypedModel;
import com.liferay.portal.service.ServiceContext;

import com.liferay.portlet.expando.model.ExpandoBridge;

import java.io.Serializable;

import java.util.Date;
import java.util.Locale;
import java.util.Map;

/**
 * The base model interface for the DDMStructure service. Represents a row in the &quot;DDMStructure&quot; database table, with each column mapped to a property of this class.
 *
 * <p>
 * This interface and its corresponding implementation {@link com.liferay.portlet.dynamicdatamapping.model.impl.DDMStructureModelImpl} exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in {@link com.liferay.portlet.dynamicdatamapping.model.impl.DDMStructureImpl}.
 * </p>
 *
 * @author Brian Wing Shun Chan
 * @see DDMStructure
 * @see com.liferay.portlet.dynamicdatamapping.model.impl.DDMStructureImpl
 * @see com.liferay.portlet.dynamicdatamapping.model.impl.DDMStructureModelImpl
 * @generated
 */
@ProviderType
public interface DDMStructureModel extends BaseModel<DDMStructure>,
	StagedGroupedModel, TypedModel {
	/*
	 * NOTE FOR DEVELOPERS:
	 *
	 * Never modify or reference this interface directly. All methods that expect a d d m structure model instance should use the {@link DDMStructure} interface instead.
	 */

	/**
	 * Returns the primary key of this d d m structure.
	 *
	 * @return the primary key of this d d m structure
	 */
	public long getPrimaryKey();

	/**
	 * Sets the primary key of this d d m structure.
	 *
	 * @param primaryKey the primary key of this d d m structure
	 */
	public void setPrimaryKey(long primaryKey);

	/**
	 * Returns the uuid of this d d m structure.
	 *
	 * @return the uuid of this d d m structure
	 */
	@AutoEscape
	@Override
	public String getUuid();

	/**
	 * Sets the uuid of this d d m structure.
	 *
	 * @param uuid the uuid of this d d m structure
	 */
	@Override
	public void setUuid(String uuid);

	/**
	 * Returns the structure ID of this d d m structure.
	 *
	 * @return the structure ID of this d d m structure
	 */
	public long getStructureId();

	/**
	 * Sets the structure ID of this d d m structure.
	 *
	 * @param structureId the structure ID of this d d m structure
	 */
	public void setStructureId(long structureId);

	/**
	 * Returns the group ID of this d d m structure.
	 *
	 * @return the group ID of this d d m structure
	 */
	@Override
	public long getGroupId();

	/**
	 * Sets the group ID of this d d m structure.
	 *
	 * @param groupId the group ID of this d d m structure
	 */
	@Override
	public void setGroupId(long groupId);

	/**
	 * Returns the company ID of this d d m structure.
	 *
	 * @return the company ID of this d d m structure
	 */
	@Override
	public long getCompanyId();

	/**
	 * Sets the company ID of this d d m structure.
	 *
	 * @param companyId the company ID of this d d m structure
	 */
	@Override
	public void setCompanyId(long companyId);

	/**
	 * Returns the user ID of this d d m structure.
	 *
	 * @return the user ID of this d d m structure
	 */
	@Override
	public long getUserId();

	/**
	 * Sets the user ID of this d d m structure.
	 *
	 * @param userId the user ID of this d d m structure
	 */
	@Override
	public void setUserId(long userId);

	/**
	 * Returns the user uuid of this d d m structure.
	 *
	 * @return the user uuid of this d d m structure
	 * @throws SystemException if a system exception occurred
	 */
	@Override
	public String getUserUuid() throws SystemException;

	/**
	 * Sets the user uuid of this d d m structure.
	 *
	 * @param userUuid the user uuid of this d d m structure
	 */
	@Override
	public void setUserUuid(String userUuid);

	/**
	 * Returns the user name of this d d m structure.
	 *
	 * @return the user name of this d d m structure
	 */
	@AutoEscape
	@Override
	public String getUserName();

	/**
	 * Sets the user name of this d d m structure.
	 *
	 * @param userName the user name of this d d m structure
	 */
	@Override
	public void setUserName(String userName);

	/**
	 * Returns the create date of this d d m structure.
	 *
	 * @return the create date of this d d m structure
	 */
	@Override
	public Date getCreateDate();

	/**
	 * Sets the create date of this d d m structure.
	 *
	 * @param createDate the create date of this d d m structure
	 */
	@Override
	public void setCreateDate(Date createDate);

	/**
	 * Returns the modified date of this d d m structure.
	 *
	 * @return the modified date of this d d m structure
	 */
	@Override
	public Date getModifiedDate();

	/**
	 * Sets the modified date of this d d m structure.
	 *
	 * @param modifiedDate the modified date of this d d m structure
	 */
	@Override
	public void setModifiedDate(Date modifiedDate);

	/**
	 * Returns the parent structure ID of this d d m structure.
	 *
	 * @return the parent structure ID of this d d m structure
	 */
	public long getParentStructureId();

	/**
	 * Sets the parent structure ID of this d d m structure.
	 *
	 * @param parentStructureId the parent structure ID of this d d m structure
	 */
	public void setParentStructureId(long parentStructureId);

	/**
	 * Returns the fully qualified class name of this d d m structure.
	 *
	 * @return the fully qualified class name of this d d m structure
	 */
	@Override
	public String getClassName();

	public void setClassName(String className);

	/**
	 * Returns the class name ID of this d d m structure.
	 *
	 * @return the class name ID of this d d m structure
	 */
	@Override
	public long getClassNameId();

	/**
	 * Sets the class name ID of this d d m structure.
	 *
	 * @param classNameId the class name ID of this d d m structure
	 */
	@Override
	public void setClassNameId(long classNameId);

	/**
	 * Returns the structure key of this d d m structure.
	 *
	 * @return the structure key of this d d m structure
	 */
	public String getStructureKey();

	/**
	 * Sets the structure key of this d d m structure.
	 *
	 * @param structureKey the structure key of this d d m structure
	 */
	public void setStructureKey(String structureKey);

	/**
	 * Returns the name of this d d m structure.
	 *
	 * @return the name of this d d m structure
	 */
	public String getName();

	/**
	 * Returns the localized name of this d d m structure in the language. Uses the default language if no localization exists for the requested language.
	 *
	 * @param locale the locale of the language
	 * @return the localized name of this d d m structure
	 */
	@AutoEscape
	public String getName(Locale locale);

	/**
	 * Returns the localized name of this d d m structure in the language, optionally using the default language if no localization exists for the requested language.
	 *
	 * @param locale the local of the language
	 * @param useDefault whether to use the default language if no localization exists for the requested language
	 * @return the localized name of this d d m structure. If <code>useDefault</code> is <code>false</code> and no localization exists for the requested language, an empty string will be returned.
	 */
	@AutoEscape
	public String getName(Locale locale, boolean useDefault);

	/**
	 * Returns the localized name of this d d m structure in the language. Uses the default language if no localization exists for the requested language.
	 *
	 * @param languageId the ID of the language
	 * @return the localized name of this d d m structure
	 */
	@AutoEscape
	public String getName(String languageId);

	/**
	 * Returns the localized name of this d d m structure in the language, optionally using the default language if no localization exists for the requested language.
	 *
	 * @param languageId the ID of the language
	 * @param useDefault whether to use the default language if no localization exists for the requested language
	 * @return the localized name of this d d m structure
	 */
	@AutoEscape
	public String getName(String languageId, boolean useDefault);

	@AutoEscape
	public String getNameCurrentLanguageId();

	@AutoEscape
	public String getNameCurrentValue();

	/**
	 * Returns a map of the locales and localized names of this d d m structure.
	 *
	 * @return the locales and localized names of this d d m structure
	 */
	public Map<Locale, String> getNameMap();

	/**
	 * Sets the name of this d d m structure.
	 *
	 * @param name the name of this d d m structure
	 */
	public void setName(String name);

	/**
	 * Sets the localized name of this d d m structure in the language.
	 *
	 * @param name the localized name of this d d m structure
	 * @param locale the locale of the language
	 */
	public void setName(String name, Locale locale);

	/**
	 * Sets the localized name of this d d m structure in the language, and sets the default locale.
	 *
	 * @param name the localized name of this d d m structure
	 * @param locale the locale of the language
	 * @param defaultLocale the default locale
	 */
	public void setName(String name, Locale locale, Locale defaultLocale);

	public void setNameCurrentLanguageId(String languageId);

	/**
	 * Sets the localized names of this d d m structure from the map of locales and localized names.
	 *
	 * @param nameMap the locales and localized names of this d d m structure
	 */
	public void setNameMap(Map<Locale, String> nameMap);

	/**
	 * Sets the localized names of this d d m structure from the map of locales and localized names, and sets the default locale.
	 *
	 * @param nameMap the locales and localized names of this d d m structure
	 * @param defaultLocale the default locale
	 */
	public void setNameMap(Map<Locale, String> nameMap, Locale defaultLocale);

	/**
	 * Returns the description of this d d m structure.
	 *
	 * @return the description of this d d m structure
	 */
	public String getDescription();

	/**
	 * Returns the localized description of this d d m structure in the language. Uses the default language if no localization exists for the requested language.
	 *
	 * @param locale the locale of the language
	 * @return the localized description of this d d m structure
	 */
	@AutoEscape
	public String getDescription(Locale locale);

	/**
	 * Returns the localized description of this d d m structure in the language, optionally using the default language if no localization exists for the requested language.
	 *
	 * @param locale the local of the language
	 * @param useDefault whether to use the default language if no localization exists for the requested language
	 * @return the localized description of this d d m structure. If <code>useDefault</code> is <code>false</code> and no localization exists for the requested language, an empty string will be returned.
	 */
	@AutoEscape
	public String getDescription(Locale locale, boolean useDefault);

	/**
	 * Returns the localized description of this d d m structure in the language. Uses the default language if no localization exists for the requested language.
	 *
	 * @param languageId the ID of the language
	 * @return the localized description of this d d m structure
	 */
	@AutoEscape
	public String getDescription(String languageId);

	/**
	 * Returns the localized description of this d d m structure in the language, optionally using the default language if no localization exists for the requested language.
	 *
	 * @param languageId the ID of the language
	 * @param useDefault whether to use the default language if no localization exists for the requested language
	 * @return the localized description of this d d m structure
	 */
	@AutoEscape
	public String getDescription(String languageId, boolean useDefault);

	@AutoEscape
	public String getDescriptionCurrentLanguageId();

	@AutoEscape
	public String getDescriptionCurrentValue();

	/**
	 * Returns a map of the locales and localized descriptions of this d d m structure.
	 *
	 * @return the locales and localized descriptions of this d d m structure
	 */
	public Map<Locale, String> getDescriptionMap();

	/**
	 * Sets the description of this d d m structure.
	 *
	 * @param description the description of this d d m structure
	 */
	public void setDescription(String description);

	/**
	 * Sets the localized description of this d d m structure in the language.
	 *
	 * @param description the localized description of this d d m structure
	 * @param locale the locale of the language
	 */
	public void setDescription(String description, Locale locale);

	/**
	 * Sets the localized description of this d d m structure in the language, and sets the default locale.
	 *
	 * @param description the localized description of this d d m structure
	 * @param locale the locale of the language
	 * @param defaultLocale the default locale
	 */
	public void setDescription(String description, Locale locale,
		Locale defaultLocale);

	public void setDescriptionCurrentLanguageId(String languageId);

	/**
	 * Sets the localized descriptions of this d d m structure from the map of locales and localized descriptions.
	 *
	 * @param descriptionMap the locales and localized descriptions of this d d m structure
	 */
	public void setDescriptionMap(Map<Locale, String> descriptionMap);

	/**
	 * Sets the localized descriptions of this d d m structure from the map of locales and localized descriptions, and sets the default locale.
	 *
	 * @param descriptionMap the locales and localized descriptions of this d d m structure
	 * @param defaultLocale the default locale
	 */
	public void setDescriptionMap(Map<Locale, String> descriptionMap,
		Locale defaultLocale);

	/**
	 * Returns the xsd of this d d m structure.
	 *
	 * @return the xsd of this d d m structure
	 */
	@AutoEscape
	public String getXsd();

	/**
	 * Sets the xsd of this d d m structure.
	 *
	 * @param xsd the xsd of this d d m structure
	 */
	public void setXsd(String xsd);

	/**
	 * Returns the storage type of this d d m structure.
	 *
	 * @return the storage type of this d d m structure
	 */
	@AutoEscape
	public String getStorageType();

	/**
	 * Sets the storage type of this d d m structure.
	 *
	 * @param storageType the storage type of this d d m structure
	 */
	public void setStorageType(String storageType);

	/**
	 * Returns the type of this d d m structure.
	 *
	 * @return the type of this d d m structure
	 */
	public int getType();

	/**
	 * Sets the type of this d d m structure.
	 *
	 * @param type the type of this d d m structure
	 */
	public void setType(int type);

	@Override
	public boolean isNew();

	@Override
	public void setNew(boolean n);

	@Override
	public boolean isCachedModel();

	@Override
	public void setCachedModel(boolean cachedModel);

	@Override
	public boolean isEscapedModel();

	@Override
	public Serializable getPrimaryKeyObj();

	@Override
	public void setPrimaryKeyObj(Serializable primaryKeyObj);

	@Override
	public ExpandoBridge getExpandoBridge();

	@Override
	public void setExpandoBridgeAttributes(BaseModel<?> baseModel);

	@Override
	public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);

	@Override
	public void setExpandoBridgeAttributes(ServiceContext serviceContext);

	public String[] getAvailableLanguageIds();

	public String getDefaultLanguageId();

	public void prepareLocalizedFieldsForImport() throws LocaleException;

	public void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
		throws LocaleException;

	@Override
	public Object clone();

	@Override
	public int compareTo(
		com.liferay.portlet.dynamicdatamapping.model.DDMStructure ddmStructure);

	@Override
	public int hashCode();

	@Override
	public CacheModel<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> toCacheModel();

	@Override
	public com.liferay.portlet.dynamicdatamapping.model.DDMStructure toEscapedModel();

	@Override
	public com.liferay.portlet.dynamicdatamapping.model.DDMStructure toUnescapedModel();

	@Override
	public String toString();

	@Override
	public String toXmlString();
}