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 Details

    • STRUCTURE_ID_ACCESSOR

      static final com.liferay.portal.kernel.util.Accessor<DDMStructure,Long> STRUCTURE_ID_ACCESSOR
  • Method Details

    • createFullHierarchyDDMForm

      DDMForm createFullHierarchyDDMForm() throws com.liferay.portal.kernel.exception.PortalException
      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

      List<DDMFormField> getDDMFormFields(boolean includeTransientFields)
    • getDDMFormLayout

      DDMFormLayout getDDMFormLayout() throws com.liferay.portal.kernel.exception.PortalException
      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

      Set<String> 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

      String getFieldType(String fieldName) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getFullHierarchyDDMForm

      DDMForm getFullHierarchyDDMForm()
    • getFullHierarchyDDMFormFieldsMap

      Map<String,DDMFormField> getFullHierarchyDDMFormFieldsMap(boolean includeNestedDDMFormFields)
    • getLatestStructureVersion

      DDMStructureVersion getLatestStructureVersion() throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getRootFieldNames

      List<String> 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

      String getWebDavURL(com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay, 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(String fieldName)
    • hasFieldByFieldReference

      boolean hasFieldByFieldReference(String fieldReference)
    • 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

      void setDDMForm(DDMForm ddmForm)