Liferay 6.1.2-ce-ga3

com.liferay.portlet.dynamicdatamapping.model
Interface DDMStructure

All Superinterfaces:
AuditedModel, BaseModel<DDMStructure>, ClassedModel, Cloneable, Comparable<DDMStructure>, DDMStructureModel, GroupedModel, PersistedModel, Serializable
All Known Implementing Classes:
DDMStructureBaseImpl, DDMStructureImpl, 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.

See Also:
DDMStructureModel, DDMStructureImpl, DDMStructureModelImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
 List<String> getAvailableLocales()
           
 String getDefaultLocale()
           
 Document getDocument()
           
 String getFieldDataType(String fieldName)
           
 String getFieldLabel(String fieldName, Locale locale)
           
 String getFieldLabel(String fieldName, String locale)
           
 Set<String> getFieldNames()
           
 String getFieldProperty(String fieldName, String property)
           
 String getFieldProperty(String fieldName, String property, String locale)
           
 boolean getFieldRequired(String fieldName)
           
 Map<String,String> getFields(String fieldName, String attributeName, String attributeValue)
           
 Map<String,String> getFields(String fieldName, String attributeName, String attributeValue, String locale)
           
 Map<String,Map<String,String>> getFieldsMap()
           
 Map<String,Map<String,String>> getFieldsMap(String locale)
           
 String getFieldType(String fieldName)
           
 Map<String,Map<String,Map<String,String>>> getLocalizedFieldsMap()
           
 Map<String,Map<String,Map<String,String>>> getLocalizedTransientFieldsMap()
           
 List<DDMTemplate> getTemplates()
           
 Map<String,Map<String,String>> getTransientFieldsMap(String locale)
           
 boolean hasField(String fieldName)
           
 void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
           
 void setDocument(Document document)
           
 void setLocalizedFieldsMap(Map<String,Map<String,Map<String,String>>> localizedFieldsMap)
           
 void setLocalizedTransientFieldsMap(Map<String,Map<String,Map<String,String>>> localizedTransientFieldsMap)
           
 void setXsd(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, toUnescapedModel, 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

List<String> getAvailableLocales()

getDefaultLocale

String getDefaultLocale()

getDocument

Document getDocument()

getFieldDataType

String getFieldDataType(String fieldName)
                        throws StructureFieldException
Throws:
StructureFieldException

getFieldLabel

String getFieldLabel(String fieldName,
                     Locale locale)
                     throws StructureFieldException
Throws:
StructureFieldException

getFieldLabel

String getFieldLabel(String fieldName,
                     String locale)
                     throws StructureFieldException
Throws:
StructureFieldException

getFieldNames

Set<String> getFieldNames()

getFieldProperty

String getFieldProperty(String fieldName,
                        String property)
                        throws StructureFieldException
Throws:
StructureFieldException

getFieldProperty

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

getFieldRequired

boolean getFieldRequired(String fieldName)
                         throws StructureFieldException
Throws:
StructureFieldException

getFields

Map<String,String> getFields(String fieldName,
                             String attributeName,
                             String attributeValue)

getFields

Map<String,String> getFields(String fieldName,
                             String attributeName,
                             String attributeValue,
                             String locale)

getFieldsMap

Map<String,Map<String,String>> getFieldsMap()

getFieldsMap

Map<String,Map<String,String>> getFieldsMap(String locale)

getFieldType

String getFieldType(String fieldName)
                    throws StructureFieldException
Throws:
StructureFieldException

getLocalizedFieldsMap

Map<String,Map<String,Map<String,String>>> getLocalizedFieldsMap()

getLocalizedTransientFieldsMap

Map<String,Map<String,Map<String,String>>> getLocalizedTransientFieldsMap()

getTemplates

List<DDMTemplate> getTemplates()
                               throws SystemException
Throws:
SystemException

getTransientFieldsMap

Map<String,Map<String,String>> getTransientFieldsMap(String locale)

hasField

boolean hasField(String fieldName)

prepareLocalizedFieldsForImport

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

setDocument

void setDocument(Document document)

setLocalizedFieldsMap

void setLocalizedFieldsMap(Map<String,Map<String,Map<String,String>>> localizedFieldsMap)

setLocalizedTransientFieldsMap

void setLocalizedTransientFieldsMap(Map<String,Map<String,Map<String,String>>> localizedTransientFieldsMap)

setXsd

void setXsd(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

Liferay 6.1.2-ce-ga3