com.liferay.portlet.dynamicdatamapping.model
Interface DDMStructure
- All Superinterfaces:
- AuditedModel, BaseModel<DDMStructure>, ClassedModel, Cloneable, Comparable<DDMStructure>, DDMStructureModel, GroupedModel, LocalizedModel, PersistedModel, Serializable, StagedGroupedModel, StagedModel, TypedModel
- All Known Implementing Classes:
- DDMStructureBaseImpl, DDMStructureImpl, 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,
DDMStructureImpl,
DDMStructureModelImpl- ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.
| Methods inherited from interface com.liferay.portlet.dynamicdatamapping.model.DDMStructureModel |
clone, compareTo, getAvailableLanguageIds, getClassName, getClassNameId, getCompanyId, getCreateDate, getDefaultLanguageId, getDefinition, getDescription, getDescription, getDescription, getDescription, getDescription, getDescriptionCurrentLanguageId, getDescriptionCurrentValue, getDescriptionMap, getExpandoBridge, getGroupId, getModifiedDate, getName, getName, getName, getName, getName, getNameCurrentLanguageId, getNameCurrentValue, getNameMap, getParentStructureId, getPrimaryKey, getPrimaryKeyObj, getStorageType, getStructureId, getStructureKey, getType, getUserId, getUserName, getUserUuid, getUuid, getVersion, getVersionUserId, getVersionUserName, getVersionUserUuid, hashCode, isCachedModel, isEscapedModel, isNew, prepareLocalizedFieldsForImport, prepareLocalizedFieldsForImport, setCachedModel, setClassName, setClassNameId, setCompanyId, setCreateDate, setDefinition, setDescription, setDescription, setDescription, setDescriptionCurrentLanguageId, setDescriptionMap, setDescriptionMap, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setExpandoBridgeAttributes, setGroupId, setModifiedDate, setName, setName, setName, setNameCurrentLanguageId, setNameMap, setNameMap, setNew, setParentStructureId, setPrimaryKey, setPrimaryKeyObj, setStorageType, setStructureId, setStructureKey, setType, setUserId, setUserName, setUserUuid, setUuid, setVersion, setVersionUserId, setVersionUserName, setVersionUserUuid, toCacheModel, toEscapedModel, toString, toUnescapedModel, toXmlString |
createFullHierarchyDDMForm
DDMForm createFullHierarchyDDMForm()
throws PortalException
- Throws:
PortalException
getChildrenFieldNames
List<String> getChildrenFieldNames(String fieldName)
throws PortalException
- Throws:
PortalException
getDDMForm
DDMForm getDDMForm()
getDDMFormField
DDMFormField getDDMFormField(String fieldName)
throws PortalException
- Throws:
PortalException
getDDMFormFields
List<DDMFormField> getDDMFormFields(boolean includeTransientFields)
getDDMFormLayout
DDMFormLayout getDDMFormLayout()
throws PortalException
- Throws:
PortalException
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()
getFullHierarchyDDMFormFieldsMap
Map<String,DDMFormField> getFullHierarchyDDMFormFieldsMap(boolean includeNestedDDMFormFields)
getRootFieldNames
List<String> getRootFieldNames()
getStructureVersion
DDMStructureVersion getStructureVersion()
throws PortalException
- Throws:
PortalException
getTemplates
List<DDMTemplate> getTemplates()
getUnambiguousName
String getUnambiguousName(List<DDMStructure> structures,
long groupId,
Locale locale)
throws PortalException
- Throws:
PortalException
getWebDavURL
String getWebDavURL(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)
isFieldRepeatable
boolean isFieldRepeatable(String fieldName)
throws PortalException
- Throws:
PortalException
isFieldTransient
boolean isFieldTransient(String fieldName)
throws PortalException
- Throws:
PortalException
setDDMForm
void setDDMForm(DDMForm ddmForm)
setFullHierarchyDDMForm
void setFullHierarchyDDMForm(DDMForm fullHierarchyDDMForm)
updateDDMForm
void updateDDMForm(DDMForm ddmForm)