DDMStructure (Liferay 7.0.10 portal-kernel API)

All Superinterfaces:

AuditedModel, ClassedModel, GroupedModel, StagedGroupedModel, StagedModel
```
@ProviderType
public interface DDMStructure
extends StagedGroupedModel
```
Author:

Leonardo Barros

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Object`	`clone()`
`String[]`	`getAvailableLanguageIds()`
`List<String>`	`getChildrenFieldNames(String fieldName)`
`String`	`getClassName()`
`long`	`getClassNameId()`
`Date`	`getCreateDate()`
`DDMForm`	`getDDMForm()`
`DDMFormField`	`getDDMFormField(String fieldName)`
`List<DDMFormField>`	`getDDMFormFields(boolean includeTransientFields)`
`String`	`getDefaultLanguageId()`
`String`	`getDefinition()`
`String`	`getDescription()`
`String`	`getDescription(Locale locale)`
`String`	`getDescription(Locale locale, boolean useDefault)`
`String`	`getDescription(String languageId)`
`String`	`getDescription(String languageId, boolean useDefault)`
`String`	`getDescriptionCurrentLanguageId()`
`String`	`getDescriptionCurrentValue()`
`Map<Locale,String>`	`getDescriptionMap()`
`ExpandoBridge`	`getExpandoBridge()`
`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)`
`boolean`	`getFieldRepeatable(String fieldName)`
`boolean`	`getFieldRequired(String fieldName)`
`String`	`getFieldTip(String fieldName, Locale locale)`
`String`	`getFieldTip(String fieldName, String locale)`
`String`	`getFieldType(String fieldName)`
`DDMForm`	`getFullHierarchyDDMForm()`
`long`	`getGroupId()`
`Date`	`getModifiedDate()`
`String`	`getName()`
`String`	`getName(Locale locale)`
`String`	`getName(Locale locale, boolean useDefault)`
`String`	`getName(String languageId)`
`String`	`getName(String languageId, boolean useDefault)`
`String`	`getNameCurrentLanguageId()`
`String`	`getNameCurrentValue()`
`Map<Locale,String>`	`getNameMap()`
`long`	`getParentStructureId()`
`long`	`getPrimaryKey()`
`Serializable`	`getPrimaryKeyObj()`
`List<String>`	`getRootFieldNames()`
`String`	`getStorageType()`
`long`	`getStructureId()`
`String`	`getStructureKey()`
`List<DDMTemplate>`	`getTemplates()`
`int`	`getType()`
`long`	`getUserId()`
`String`	`getUserName()`
`String`	`getUserUuid()`
`String`	`getUuid()`
`String`	`getWebDavURL(ThemeDisplay themeDisplay, String webDAVToken)`
`boolean`	`hasField(String fieldName)`
`boolean`	`isFieldRepeatable(String fieldName)`
`boolean`	`isFieldTransient(String fieldName)`
`boolean`	`isNew()`
`void`	`prepareLocalizedFieldsForImport()`
`void`	`prepareLocalizedFieldsForImport(Locale defaultImportLocale)`
`void`	`setDefinition(String definition)`
`String`	`toXmlString()`

Methods inherited from interface com.liferay.portal.kernel.model.StagedGroupedModel
getLastPublishDate, setLastPublishDate

Methods inherited from interface com.liferay.portal.kernel.model.GroupedModel
setGroupId

Methods inherited from interface com.liferay.portal.kernel.model.AuditedModel
getCompanyId, setCompanyId, setCreateDate, setModifiedDate, setUserId, setUserName, setUserUuid

Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel
getModelClass, getModelClassName, setPrimaryKeyObj

Methods inherited from interface com.liferay.portal.kernel.model.StagedModel
getCompanyId, getStagedModelType, setCompanyId, setCreateDate, setModifiedDate, setUuid

Method Detail

clone
```
Object clone()
```
Specified by:

clone in interface StagedModel

getAvailableLanguageIds
```
String[] getAvailableLanguageIds()
```

getChildrenFieldNames

List<String> getChildrenFieldNames(String fieldName)
                            throws PortalException

Throws:: PortalException

getClassName
```
String getClassName()
```

getClassNameId
```
long getClassNameId()
```

getCreateDate
```
Date getCreateDate()
```
Specified by:

getCreateDate in interface AuditedModel

Specified by:

getCreateDate in interface StagedModel

getDDMForm
```
DDMForm getDDMForm()
```

getDDMFormField

DDMFormField getDDMFormField(String fieldName)
                      throws PortalException

Throws:: PortalException

getDDMFormFields

List<DDMFormField> getDDMFormFields(boolean includeTransientFields)

getDefaultLanguageId
```
String getDefaultLanguageId()
```

getDefinition
```
String getDefinition()
```

getDescription
```
String getDescription()
```

getDescription
```
String getDescription(Locale locale)
```

getDescription

String getDescription(Locale locale,
                      boolean useDefault)

getDescription

String getDescription(String languageId)

getDescription

String getDescription(String languageId,
                      boolean useDefault)

getDescriptionCurrentLanguageId

String getDescriptionCurrentLanguageId()

getDescriptionCurrentValue
```
String getDescriptionCurrentValue()
```

getDescriptionMap
```
Map<Locale,String> getDescriptionMap()
```

getExpandoBridge
```
ExpandoBridge getExpandoBridge()
```
Specified by:

getExpandoBridge in interface ClassedModel

getFieldDataType

String getFieldDataType(String fieldName)
                 throws PortalException

Throws:: PortalException

getFieldLabel

String getFieldLabel(String fieldName,
                     Locale locale)
              throws PortalException

Throws:: PortalException

getFieldLabel

String getFieldLabel(String fieldName,
                     String locale)
              throws PortalException

Throws:: PortalException

getFieldNames
```
Set<String> getFieldNames()
```

getFieldProperty

String getFieldProperty(String fieldName,
                        String property)
                 throws PortalException

Throws:: PortalException

getFieldRepeatable

boolean getFieldRepeatable(String fieldName)
                    throws PortalException

Throws:: PortalException

getFieldRequired

boolean getFieldRequired(String fieldName)
                  throws PortalException

Throws:: PortalException

getFieldTip

String getFieldTip(String fieldName,
                   Locale locale)
            throws PortalException

Throws:: PortalException

getFieldTip

String getFieldTip(String fieldName,
                   String locale)
            throws PortalException

Throws:: PortalException

getFieldType

String getFieldType(String fieldName)
             throws PortalException

Throws:: PortalException

getFullHierarchyDDMForm
```
DDMForm getFullHierarchyDDMForm()
```

getGroupId
```
long getGroupId()
```
Specified by:

getGroupId in interface GroupedModel

getModifiedDate
```
Date getModifiedDate()
```
Specified by:

getModifiedDate in interface AuditedModel

Specified by:

getModifiedDate in interface StagedModel

getName
```
String getName()
```

getName
```
String getName(Locale locale)
```

getName

String getName(Locale locale,
               boolean useDefault)

getName
```
String getName(String languageId)
```

getName

String getName(String languageId,
               boolean useDefault)

getNameCurrentLanguageId
```
String getNameCurrentLanguageId()
```

getNameCurrentValue
```
String getNameCurrentValue()
```

getNameMap
```
Map<Locale,String> getNameMap()
```

getParentStructureId
```
long getParentStructureId()
```

getPrimaryKey
```
long getPrimaryKey()
```

getPrimaryKeyObj
```
Serializable getPrimaryKeyObj()
```
Specified by:

getPrimaryKeyObj in interface ClassedModel

getRootFieldNames
```
List<String> getRootFieldNames()
```

getStorageType
```
String getStorageType()
```

getStructureId
```
long getStructureId()
```

getStructureKey
```
String getStructureKey()
```

getTemplates

List<DDMTemplate> getTemplates()
                        throws PortalException

Throws:: PortalException

getType
```
int getType()
```

getUserId
```
long getUserId()
```
Specified by:

getUserId in interface AuditedModel

getUserName
```
String getUserName()
```
Specified by:

getUserName in interface AuditedModel

getUserUuid
```
String getUserUuid()
```
Specified by:

getUserUuid in interface AuditedModel

getUuid
```
String getUuid()
```
Specified by:

getUuid in interface StagedModel

getWebDavURL

String getWebDavURL(ThemeDisplay themeDisplay,
                    String webDAVToken)

hasField
```
boolean hasField(String fieldName)
```

isFieldRepeatable

boolean isFieldRepeatable(String fieldName)
                   throws PortalException

Throws:: PortalException

isFieldTransient

boolean isFieldTransient(String fieldName)
                  throws PortalException

Throws:: PortalException

isNew
```
boolean isNew()
```

prepareLocalizedFieldsForImport

void prepareLocalizedFieldsForImport()
                              throws LocaleException

Throws:: LocaleException

prepareLocalizedFieldsForImport

void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
                              throws LocaleException

Throws:: LocaleException

setDefinition
```
void setDefinition(String definition)
```

toXmlString
```
String toXmlString()
```

Interface DDMStructure

Method Summary

Methods inherited from interface com.liferay.portal.kernel.model.StagedGroupedModel

Methods inherited from interface com.liferay.portal.kernel.model.GroupedModel

Methods inherited from interface com.liferay.portal.kernel.model.AuditedModel

Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel

Methods inherited from interface com.liferay.portal.kernel.model.StagedModel

Method Detail

clone

getAvailableLanguageIds

getChildrenFieldNames

getClassName

getClassNameId

getCreateDate

getDDMForm

getDDMFormField

getDDMFormFields

getDefaultLanguageId

getDefinition

getDescription

getDescription

getDescription

getDescription

getDescription

getDescriptionCurrentLanguageId

getDescriptionCurrentValue

getDescriptionMap

getExpandoBridge

getFieldDataType

getFieldLabel

getFieldLabel

getFieldNames

getFieldProperty

getFieldRepeatable

getFieldRequired

getFieldTip

getFieldTip

getFieldType

getFullHierarchyDDMForm

getGroupId

getModifiedDate

getName

getName

getName

getName

getName

getNameCurrentLanguageId

getNameCurrentValue

getNameMap

getParentStructureId

getPrimaryKey

getPrimaryKeyObj

getRootFieldNames

getStorageType

getStructureId

getStructureKey

getTemplates

getType

getUserId

getUserName

getUserUuid

getUuid

getWebDavURL

hasField

isFieldRepeatable

isFieldTransient

isNew

prepareLocalizedFieldsForImport

prepareLocalizedFieldsForImport

setDefinition

toXmlString