Interface DDMStructure
- All Superinterfaces:
com.liferay.portal.kernel.model.AuditedModel
,com.liferay.portal.kernel.model.BaseModel<DDMStructure>
,com.liferay.portal.kernel.model.ClassedModel
,Cloneable
,Comparable<DDMStructure>
,com.liferay.portal.kernel.model.change.tracking.CTModel<DDMStructure>
,DDMStructureModel
,com.liferay.portal.kernel.model.ExternalReferenceCodeModel
,com.liferay.portal.kernel.model.GroupedModel
,com.liferay.portal.kernel.model.LocalizedModel
,com.liferay.portal.kernel.model.MVCCModel
,com.liferay.portal.kernel.model.PersistedModel
,Serializable
,com.liferay.portal.kernel.model.ShardedModel
,com.liferay.portal.kernel.model.StagedGroupedModel
,com.liferay.portal.kernel.model.StagedModel
,com.liferay.portal.kernel.model.TypedModel
- All Known Implementing Classes:
DDMStructureWrapper
@ProviderType
public interface DDMStructure
extends DDMStructureModel, com.liferay.portal.kernel.model.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:
- Generated:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final com.liferay.portal.kernel.util.Accessor<DDMStructure,
Long> -
Method Summary
Modifier and TypeMethodDescriptiongetChildrenFieldNames
(String fieldName) getDDMFormField
(String fieldName) getDDMFormFieldByFieldReference
(String fieldReference) getDDMFormFields
(boolean includeTransientFields) long
getFieldDataType
(String fieldName) getFieldLabel
(String fieldName, String locale) getFieldLabel
(String fieldName, Locale locale) getFieldProperty
(String fieldName, String property) getFieldPropertyByFieldReference
(String fieldReference, String property) boolean
getFieldRepeatable
(String fieldName) boolean
getFieldRequired
(String fieldName) getFieldTip
(String fieldName, String locale) getFieldTip
(String fieldName, Locale locale) getFieldType
(String fieldName) getFullHierarchyDDMFormFieldsMap
(boolean includeNestedDDMFormFields) getUnambiguousName
(List<DDMStructure> structures, long groupId, Locale locale) getWebDavURL
(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay, String webDAVToken) Returns the WebDAV URL to access the structure.boolean
boolean
hasFieldByFieldReference
(String fieldReference) boolean
isFieldRepeatable
(String fieldName) boolean
isFieldTransient
(String fieldName) void
setDDMForm
(DDMForm ddmForm) 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
Methods inherited from interface com.liferay.portal.kernel.model.ClassedModel
getModelClass, getModelClassName
Methods inherited from interface java.lang.Comparable
compareTo
Methods inherited from interface com.liferay.dynamic.data.mapping.model.DDMStructureModel
cloneWithOriginalValues, getAvailableLanguageIds, getClassName, getClassNameId, getCompanyId, getCreateDate, getCtCollectionId, getDefaultLanguageId, getDefinition, getDescription, getDescription, getDescription, getDescription, getDescription, getDescriptionCurrentLanguageId, getDescriptionCurrentValue, getDescriptionMap, getExternalReferenceCode, 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, setExternalReferenceCode, setGroupId, setLastPublishDate, setModifiedDate, setMvccVersion, setName, setName, setName, setNameCurrentLanguageId, setNameMap, setNameMap, setParentStructureId, setPrimaryKey, setStorageType, setStructureId, setStructureKey, setType, setUserId, setUserName, setUserUuid, setUuid, setVersion, setVersionUserId, setVersionUserName, setVersionUserUuid, toXmlString
Methods inherited from interface com.liferay.portal.kernel.model.PersistedModel
persist
Methods inherited from interface com.liferay.portal.kernel.model.StagedModel
clone, getStagedModelType
-
Field Details
-
STRUCTURE_ID_ACCESSOR
-
-
Method Details
-
createFullHierarchyDDMForm
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
fetchDDMStructureLayout
DDMStructureLayout fetchDDMStructureLayout() -
getChildrenFieldNames
List<String> getChildrenFieldNames(String fieldName) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getDDMForm
DDMForm getDDMForm() -
getDDMFormField
DDMFormField getDDMFormField(String fieldName) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getDDMFormFieldByFieldReference
DDMFormField getDDMFormFieldByFieldReference(String fieldReference) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getDDMFormFields
-
getDDMFormLayout
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getDefaultDDMStructureLayoutId
long getDefaultDDMStructureLayoutId() -
getFieldDataType
String getFieldDataType(String fieldName) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getFieldLabel
String getFieldLabel(String fieldName, Locale locale) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getFieldLabel
String getFieldLabel(String fieldName, String locale) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getFieldNames
-
getFieldProperty
String getFieldProperty(String fieldName, String property) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getFieldPropertyByFieldReference
String getFieldPropertyByFieldReference(String fieldReference, String property) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getFieldRepeatable
boolean getFieldRepeatable(String fieldName) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getFieldRequired
boolean getFieldRequired(String fieldName) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getFieldTip
String getFieldTip(String fieldName, Locale locale) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getFieldTip
String getFieldTip(String fieldName, String locale) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getFieldType
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getFullHierarchyDDMForm
DDMForm getFullHierarchyDDMForm() -
getFullHierarchyDDMFormFieldsMap
-
getLatestStructureVersion
DDMStructureVersion getLatestStructureVersion() throws com.liferay.portal.kernel.exception.PortalException- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getRootFieldNames
-
getStructureVersion
DDMStructureVersion getStructureVersion() throws com.liferay.portal.kernel.exception.PortalException- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getTemplates
List<DDMTemplate> getTemplates() -
getUnambiguousName
String getUnambiguousName(List<DDMStructure> structures, long groupId, Locale locale) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getWebDavURL
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
-
hasFieldByFieldReference
-
isFieldRepeatable
boolean isFieldRepeatable(String fieldName) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
isFieldTransient
boolean isFieldTransient(String fieldName) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
setDDMForm
-