com.liferay.dynamic.data.mapping.model

Interface DDMStructure

All Superinterfaces:

AuditedModel, BaseModel<DDMStructure>, ClassedModel, java.lang.Cloneable, java.lang.Comparable<DDMStructure>, CTModel<DDMStructure>, DDMStructureModel, GroupedModel, LocalizedModel, MVCCModel, PersistedModel, java.io.Serializable, ShardedModel, StagedGroupedModel, StagedModel, TypedModel

All Known Implementing Classes:

DDMStructureWrapper

@ProviderType
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

Field Summary

Fields

Modifier and Type	Field and Description
static Accessor<DDMStructure,java.lang.Long>	STRUCTURE_ID_ACCESSOR

Method Summary

Modifier and Type	Method and Description
DDMForm	createFullHierarchyDDMForm()
DDMStructureLayout	fetchDDMStructureLayout()
java.util.List<java.lang.String>	getChildrenFieldNames(java.lang.String fieldName)
DDMForm	getDDMForm()
DDMFormField	getDDMFormField(java.lang.String fieldName)
java.util.List<DDMFormField>	getDDMFormFields(boolean includeTransientFields)
DDMFormLayout	getDDMFormLayout()
long	getDefaultDDMStructureLayoutId()
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()
java.util.Map<java.lang.String,DDMFormField>	getFullHierarchyDDMFormFieldsMap(boolean includeNestedDDMFormFields)
DDMStructureVersion	getLatestStructureVersion()
java.util.List<java.lang.String>	getRootFieldNames()
DDMStructureVersion	getStructureVersion()
java.util.List<DDMTemplate>	getTemplates()
java.lang.String	getUnambiguousName(java.util.List<DDMStructure> structures, long groupId, java.util.Locale locale)
java.lang.String	getWebDavURL(ThemeDisplay themeDisplay, java.lang.String webDAVToken) Returns the WebDAV URL to access the structure.
boolean	hasField(java.lang.String fieldName)
boolean	isFieldRepeatable(java.lang.String fieldName)
boolean	isFieldTransient(java.lang.String fieldName)
void	setDDMForm(DDMForm ddmForm)

Methods inherited from interface com.liferay.dynamic.data.mapping.model.DDMStructureModel

getAvailableLanguageIds, getClassName, getClassNameId, getCompanyId, getCreateDate, getCtCollectionId, getDefaultLanguageId, getDefinition, getDescription, getDescription, getDescription, getDescription, getDescription, getDescriptionCurrentLanguageId, getDescriptionCurrentValue, getDescriptionMap, getGroupId, getLastPublishDate, getModifiedDate, getMvccVersion, getName, getName, getName, getName, getName, getNameCurrentLanguageId, getNameCurrentValue, getNameMap, getParentStructureId, getPrimaryKey, getStorageType, getStructureId, getStructureKey, getType, getUserId, getUserName, getUserUuid, getUuid, getVersion, getVersionUserId, getVersionUserName, getVersionUserUuid, prepareLocalizedFieldsForImport, prepareLocalizedFieldsForImport, setClassName, setClassNameId, setCompanyId, setCreateDate, setCtCollectionId, setDefinition, setDescription, setDescription, setDescription, setDescriptionCurrentLanguageId, setDescriptionMap, setDescriptionMap, setGroupId, setLastPublishDate, setModifiedDate, setMvccVersion, setName, setName, setName, setNameCurrentLanguageId, setNameMap, setNameMap, setParentStructureId, setPrimaryKey, setStorageType, setStructureId, setStructureKey, setType, setUserId, setUserName, setUserUuid, setUuid, setVersion, setVersionUserId, setVersionUserName, setVersionUserUuid

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

clone, getAttributeGetterFunctions, getAttributeSetterBiConsumers, getExpandoBridge, getModelAttributes, getPrimaryKeyObj, isCachedModel, isEntityCacheEnabled, isEscapedModel, isFinderCacheEnabled, isNew, resetOriginalValues, setCachedModel, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setModelAttributes, setNew, setPrimaryKeyObj, toCacheModel, toEscapedModel, toUnescapedModel, toXmlString

Methods inherited from interface java.lang.Comparable

compareTo

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

getModelClass, getModelClassName

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

clone, getStagedModelType

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

persist

Field Detail

STRUCTURE_ID_ACCESSOR

static final Accessor<DDMStructure,java.lang.Long> STRUCTURE_ID_ACCESSOR

Method Detail

createFullHierarchyDDMForm

DDMForm createFullHierarchyDDMForm()
                            throws PortalException

Throws:

PortalException

fetchDDMStructureLayout

DDMStructureLayout fetchDDMStructureLayout()

getChildrenFieldNames

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

Throws:

PortalException

getDDMForm

DDMForm getDDMForm()

getDDMFormField

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

Throws:

PortalException

getDDMFormFields

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

getDDMFormLayout

DDMFormLayout getDDMFormLayout()
                        throws PortalException

Throws:

PortalException

getDefaultDDMStructureLayoutId

long getDefaultDDMStructureLayoutId()

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()

getFullHierarchyDDMFormFieldsMap

java.util.Map<java.lang.String,DDMFormField> getFullHierarchyDDMFormFieldsMap(boolean includeNestedDDMFormFields)

getLatestStructureVersion

DDMStructureVersion getLatestStructureVersion()
                                       throws PortalException

Throws:

PortalException

getRootFieldNames

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

getStructureVersion

DDMStructureVersion getStructureVersion()
                                 throws PortalException

Throws:

PortalException

getTemplates

java.util.List<DDMTemplate> getTemplates()

getUnambiguousName

java.lang.String getUnambiguousName(java.util.List<DDMStructure> structures,
                                    long groupId,
                                    java.util.Locale locale)
                             throws PortalException

Throws:

PortalException

getWebDavURL

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

Returns the WebDAV URL to access the structure.

Parameters:

themeDisplay - the theme display needed to build the URL. It can set HTTPS access, the server name, the server port, the path context, and the scope group.

webDAVToken - the WebDAV token for the URL

Returns:

the WebDAV URL

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

setDDMForm

void setDDMForm(DDMForm ddmForm)