com.liferay.dynamic.data.mapping.kernel

Interface DDMStructure

All Superinterfaces:

AuditedModel, ClassedModel, GroupedModel, StagedGroupedModel, StagedModel

@ProviderType
public interface DDMStructure
extends StagedGroupedModel

Method Summary

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

java.lang.Object clone()

Specified by:

clone in interface StagedModel

getAvailableLanguageIds

java.lang.String[] getAvailableLanguageIds()

getChildrenFieldNames

java.util.List<java.lang.String> getChildrenFieldNames(java.lang.String fieldName)
                                                throws PortalException

Throws:

PortalException

getClassName

java.lang.String getClassName()

getClassNameId

long getClassNameId()

getCreateDate

java.util.Date getCreateDate()

Specified by:

getCreateDate in interface AuditedModel

Specified by:

getCreateDate in interface StagedModel

getDDMForm

DDMForm getDDMForm()

getDDMFormField

DDMFormField getDDMFormField(java.lang.String fieldName)
                      throws PortalException

Throws:

PortalException

getDDMFormFields

java.util.List<DDMFormField> getDDMFormFields(boolean includeTransientFields)

getDefaultLanguageId

java.lang.String getDefaultLanguageId()

getDefinition

java.lang.String getDefinition()

getDescription

java.lang.String getDescription()

getDescription

java.lang.String getDescription(java.util.Locale locale)

getDescription

java.lang.String getDescription(java.util.Locale locale,
                                boolean useDefault)

getDescription

java.lang.String getDescription(java.lang.String languageId)

getDescription

java.lang.String getDescription(java.lang.String languageId,
                                boolean useDefault)

getDescriptionCurrentLanguageId

java.lang.String getDescriptionCurrentLanguageId()

getDescriptionCurrentValue

java.lang.String getDescriptionCurrentValue()

getDescriptionMap

java.util.Map<java.util.Locale,java.lang.String> getDescriptionMap()

getExpandoBridge

ExpandoBridge getExpandoBridge()

Specified by:

getExpandoBridge in interface ClassedModel

getFieldDataType

java.lang.String getFieldDataType(java.lang.String fieldName)
                           throws PortalException

Throws:

PortalException

getFieldLabel

java.lang.String getFieldLabel(java.lang.String fieldName,
                               java.util.Locale locale)
                        throws PortalException

Throws:

PortalException

getFieldLabel

java.lang.String getFieldLabel(java.lang.String fieldName,
                               java.lang.String locale)
                        throws PortalException

Throws:

PortalException

getFieldNames

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

getFieldProperty

java.lang.String getFieldProperty(java.lang.String fieldName,
                                  java.lang.String property)
                           throws PortalException

Throws:

PortalException

getFieldRepeatable

boolean getFieldRepeatable(java.lang.String fieldName)
                    throws PortalException

Throws:

PortalException

getFieldRequired

boolean getFieldRequired(java.lang.String fieldName)
                  throws PortalException

Throws:

PortalException

getFieldTip

java.lang.String getFieldTip(java.lang.String fieldName,
                             java.util.Locale locale)
                      throws PortalException

Throws:

PortalException

getFieldTip

java.lang.String getFieldTip(java.lang.String fieldName,
                             java.lang.String locale)
                      throws PortalException

Throws:

PortalException

getFieldType

java.lang.String getFieldType(java.lang.String fieldName)
                       throws PortalException

Throws:

PortalException

getFullHierarchyDDMForm

DDMForm getFullHierarchyDDMForm()

getGroupId

long getGroupId()

Specified by:

getGroupId in interface GroupedModel

getModifiedDate

java.util.Date getModifiedDate()

Specified by:

getModifiedDate in interface AuditedModel

Specified by:

getModifiedDate in interface StagedModel

getName

java.lang.String getName()

getName

java.lang.String getName(java.util.Locale locale)

getName

java.lang.String getName(java.util.Locale locale,
                         boolean useDefault)

getName

java.lang.String getName(java.lang.String languageId)

getName

java.lang.String getName(java.lang.String languageId,
                         boolean useDefault)

getNameCurrentLanguageId

java.lang.String getNameCurrentLanguageId()

getNameCurrentValue

java.lang.String getNameCurrentValue()

getNameMap

java.util.Map<java.util.Locale,java.lang.String> getNameMap()

getParentStructureId

long getParentStructureId()

getPrimaryKey

long getPrimaryKey()

getPrimaryKeyObj

java.io.Serializable getPrimaryKeyObj()

Specified by:

getPrimaryKeyObj in interface ClassedModel

getRootFieldNames

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

getStorageType

java.lang.String getStorageType()

getStructureId

long getStructureId()

getStructureKey

java.lang.String getStructureKey()

getTemplates

java.util.List<DDMTemplate> getTemplates()
                                  throws PortalException

Throws:

PortalException

getType

int getType()

getUserId

long getUserId()

Specified by:

getUserId in interface AuditedModel

getUserName

java.lang.String getUserName()

Specified by:

getUserName in interface AuditedModel

getUserUuid

java.lang.String getUserUuid()

Specified by:

getUserUuid in interface AuditedModel

getUuid

java.lang.String getUuid()

Specified by:

getUuid in interface StagedModel

getWebDavURL

java.lang.String getWebDavURL(ThemeDisplay themeDisplay,
                              java.lang.String webDAVToken)

hasField

boolean hasField(java.lang.String fieldName)

isFieldRepeatable

boolean isFieldRepeatable(java.lang.String fieldName)
                   throws PortalException

Throws:

PortalException

isFieldTransient

boolean isFieldTransient(java.lang.String fieldName)
                  throws PortalException

Throws:

PortalException

isNew

boolean isNew()

prepareLocalizedFieldsForImport

void prepareLocalizedFieldsForImport()
                              throws LocaleException

Throws:

LocaleException

prepareLocalizedFieldsForImport

void prepareLocalizedFieldsForImport(java.util.Locale defaultImportLocale)
                              throws LocaleException

Throws:

LocaleException

setDefinition

void setDefinition(java.lang.String definition)

toXmlString

java.lang.String toXmlString()