com.liferay.portlet.dynamicdatamapping.model
Interface DDMStructure

All Superinterfaces:
AuditedModel, BaseModel<DDMStructure>, ClassedModel, java.lang.Cloneable, java.lang.Comparable<DDMStructure>, DDMStructureModel, GroupedModel, PersistedModel, java.io.Serializable
All Known Implementing Classes:
DDMStructureWrapper

public interface DDMStructure
extends DDMStructureModel, PersistedModel

The extended model interface for the DDMStructure service. Represents a row in the "DDMStructure" database table, with each column mapped to a property of this class.

Author:
Brian Wing Shun Chan
See Also:
DDMStructureModel, DDMStructureImpl, DDMStructureModelImpl
Generated:

Method Summary
 java.util.List<java.lang.String> getAvailableLocales()
           
 java.lang.String getDefaultLocale()
           
 Document getDocument()
           
 java.lang.String getFieldDataType(java.lang.String fieldName)
           
 java.lang.String getFieldLabel(java.lang.String fieldName, java.util.Locale locale)
           
 java.lang.String getFieldLabel(java.lang.String fieldName, java.lang.String locale)
           
 java.util.Set<java.lang.String> getFieldNames()
           
 java.lang.String getFieldProperty(java.lang.String fieldName, java.lang.String property)
           
 java.lang.String getFieldProperty(java.lang.String fieldName, java.lang.String property, java.lang.String locale)
           
 boolean getFieldRequired(java.lang.String fieldName)
           
 java.util.Map<java.lang.String,java.lang.String> getFields(java.lang.String fieldName, java.lang.String attributeName, java.lang.String attributeValue)
           
 java.util.Map<java.lang.String,java.lang.String> getFields(java.lang.String fieldName, java.lang.String attributeName, java.lang.String attributeValue, java.lang.String locale)
           
 java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getFieldsMap()
           
 java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getFieldsMap(java.lang.String locale)
           
 java.lang.String getFieldType(java.lang.String fieldName)
           
 java.util.List<DDMTemplate> getTemplates()
           
 boolean hasField(java.lang.String fieldName)
           
 void prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale)
           
 void setDocument(Document document)
           
 void setLocalizedFieldsMap(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>> localizedFieldsMap)
           
 void setXsd(java.lang.String xsd)
          Sets the xsd of this d d m structure.
 
Methods inherited from interface com.liferay.portlet.dynamicdatamapping.model.DDMStructureModel
clone, compareTo, getClassName, getClassNameId, getCompanyId, getCreateDate, getDescription, getDescription, getDescription, getDescription, getDescription, getDescriptionCurrentLanguageId, getDescriptionCurrentValue, getDescriptionMap, getExpandoBridge, getGroupId, getModifiedDate, getName, getName, getName, getName, getName, getNameCurrentLanguageId, getNameCurrentValue, getNameMap, getPrimaryKey, getPrimaryKeyObj, getStorageType, getStructureId, getStructureKey, getType, getUserId, getUserName, getUserUuid, getUuid, getXsd, hashCode, isCachedModel, isEscapedModel, isNew, setCachedModel, setClassName, setClassNameId, setCompanyId, setCreateDate, setDescription, setDescription, setDescription, setDescriptionCurrentLanguageId, setDescriptionMap, setDescriptionMap, setExpandoBridgeAttributes, setGroupId, setModifiedDate, setName, setName, setName, setNameCurrentLanguageId, setNameMap, setNameMap, setNew, setPrimaryKey, setPrimaryKeyObj, setStorageType, setStructureId, setStructureKey, setType, setUserId, setUserName, setUserUuid, setUuid, toCacheModel, toEscapedModel, toString, toXmlString
 
Methods inherited from interface com.liferay.portal.model.BaseModel
getModelAttributes, resetOriginalValues, setModelAttributes
 
Methods inherited from interface com.liferay.portal.model.ClassedModel
getModelClass, getModelClassName
 
Methods inherited from interface com.liferay.portal.model.PersistedModel
persist
 

Method Detail

getAvailableLocales

java.util.List<java.lang.String> getAvailableLocales()

getDefaultLocale

java.lang.String getDefaultLocale()

getDocument

Document getDocument()

getFieldDataType

java.lang.String getFieldDataType(java.lang.String fieldName)
                                  throws StructureFieldException
Throws:
StructureFieldException

getFieldLabel

java.lang.String getFieldLabel(java.lang.String fieldName,
                               java.util.Locale locale)
                               throws StructureFieldException
Throws:
StructureFieldException

getFieldLabel

java.lang.String getFieldLabel(java.lang.String fieldName,
                               java.lang.String locale)
                               throws StructureFieldException
Throws:
StructureFieldException

getFieldNames

java.util.Set<java.lang.String> getFieldNames()

getFieldProperty

java.lang.String getFieldProperty(java.lang.String fieldName,
                                  java.lang.String property)
                                  throws StructureFieldException
Throws:
StructureFieldException

getFieldProperty

java.lang.String getFieldProperty(java.lang.String fieldName,
                                  java.lang.String property,
                                  java.lang.String locale)
                                  throws StructureFieldException
Throws:
StructureFieldException

getFieldRequired

boolean getFieldRequired(java.lang.String fieldName)
                         throws StructureFieldException
Throws:
StructureFieldException

getFields

java.util.Map<java.lang.String,java.lang.String> getFields(java.lang.String fieldName,
                                                           java.lang.String attributeName,
                                                           java.lang.String attributeValue)

getFields

java.util.Map<java.lang.String,java.lang.String> getFields(java.lang.String fieldName,
                                                           java.lang.String attributeName,
                                                           java.lang.String attributeValue,
                                                           java.lang.String locale)

getFieldsMap

java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getFieldsMap()

getFieldsMap

java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getFieldsMap(java.lang.String locale)

getFieldType

java.lang.String getFieldType(java.lang.String fieldName)
                              throws StructureFieldException
Throws:
StructureFieldException

getTemplates

java.util.List<DDMTemplate> getTemplates()
                                         throws SystemException
Throws:
SystemException

hasField

boolean hasField(java.lang.String fieldName)

prepareLocalizedFieldsForImport

void prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale)
                                     throws LocaleException
Specified by:
prepareLocalizedFieldsForImport in interface DDMStructureModel
Throws:
LocaleException

setDocument

void setDocument(Document document)

setLocalizedFieldsMap

void setLocalizedFieldsMap(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>> localizedFieldsMap)

setXsd

void setXsd(java.lang.String xsd)
Description copied from interface: DDMStructureModel
Sets the xsd of this d d m structure.

Specified by:
setXsd in interface DDMStructureModel
Parameters:
xsd - the xsd of this d d m structure