com.liferay.portlet.dynamicdatamapping.model

Interface DDMStructure

All Superinterfaces:

AuditedModel, BaseModel<DDMStructure>, ClassedModel, java.lang.Cloneable, java.lang.Comparable<DDMStructure>, DDMStructureModel, GroupedModel, PersistedModel, java.io.Serializable, 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.

Author:

Brian Wing Shun Chan

See Also:

DDMStructureModel, DDMStructureImpl, DDMStructureModelImpl

Generated:

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getChildrenFieldNames(java.lang.String fieldName)
java.lang.String	getCompleteXsd()
Document	getDocument()
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)
java.lang.String	getFieldProperty(java.lang.String fieldName, java.lang.String property, java.lang.String locale)
boolean	getFieldRepeatable(java.lang.String fieldName)
boolean	getFieldRequired(java.lang.String fieldName)
java.util.Map<java.lang.String,java.lang.String>	getFields(java.lang.String fieldName, java.lang.String attributeName, java.lang.String attributeValue)
java.util.Map<java.lang.String,java.lang.String>	getFields(java.lang.String fieldName, java.lang.String attributeName, java.lang.String attributeValue, java.lang.String locale)
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	getFieldsMap()
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	getFieldsMap(boolean includeTransientFields)
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	getFieldsMap(java.lang.String locale)
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	getFieldsMap(java.lang.String locale, boolean includeTransientFields)
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)
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>>	getLocalizedFieldsMap()
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>>	getLocalizedPersistentFieldsMap()
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>>	getLocalizedTransientFieldsMap()
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	getPersistentFieldsMap(java.lang.String locale)
java.util.List<java.lang.String>	getRootFieldNames()
java.util.List<DDMTemplate>	getTemplates()
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	getTransientFieldsMap(java.lang.String 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	isFieldPrivate(java.lang.String fieldName)
boolean	isFieldRepeatable(java.lang.String fieldName)
boolean	isFieldTransient(java.lang.String fieldName)
void	setDocument(Document document)
void	setLocalizedFieldsMap(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>> localizedFieldsMap)
void	setLocalizedPersistentFieldsMap(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>> localizedPersistentFieldsMap)
void	setLocalizedTransientFieldsMap(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>> localizedTransientFieldsMap)

Methods inherited from interface com.liferay.portlet.dynamicdatamapping.model.DDMStructureModel

clone, compareTo, getAvailableLanguageIds, getClassName, getClassNameId, getCompanyId, getCreateDate, getDefaultLanguageId, 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, getXsd, hashCode, isCachedModel, isEscapedModel, isNew, prepareLocalizedFieldsForImport, prepareLocalizedFieldsForImport, setCachedModel, setClassName, setClassNameId, setCompanyId, setCreateDate, 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, setXsd, toCacheModel, toEscapedModel, toString, toUnescapedModel, toXmlString

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

getModelAttributes, resetOriginalValues, setModelAttributes

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

getModelClass, getModelClassName

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

getStagedModelType

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

persist

Method Detail

getChildrenFieldNames

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

Throws:

PortalException

SystemException

getCompleteXsd

java.lang.String getCompleteXsd()
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

getDocument

Document getDocument()

getFieldDataType

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

Throws:

PortalException

SystemException

getFieldLabel

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

Throws:

PortalException

SystemException

getFieldLabel

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

Throws:

PortalException

SystemException

getFieldNames

java.util.Set<java.lang.String> getFieldNames()
                                              throws PortalException,
                                                     SystemException

Throws:

PortalException

SystemException

getFieldProperty

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

Throws:

PortalException

SystemException

getFieldProperty

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

Throws:

PortalException

SystemException

getFieldRepeatable

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

Throws:

PortalException

SystemException

getFieldRequired

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

Throws:

PortalException

SystemException

getFields

java.util.Map<java.lang.String,java.lang.String> getFields(java.lang.String fieldName,
                                                         java.lang.String attributeName,
                                                         java.lang.String attributeValue)

getFields

java.util.Map<java.lang.String,java.lang.String> getFields(java.lang.String fieldName,
                                                         java.lang.String attributeName,
                                                         java.lang.String attributeValue,
                                                         java.lang.String locale)

getFieldsMap

java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getFieldsMap()
                                                                                              throws PortalException,
                                                                                                     SystemException

Throws:

PortalException

SystemException

getFieldsMap

java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getFieldsMap(boolean includeTransientFields)
                                                                                              throws PortalException,
                                                                                                     SystemException

Throws:

PortalException

SystemException

getFieldsMap

java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getFieldsMap(java.lang.String locale)
                                                                                              throws PortalException,
                                                                                                     SystemException

Throws:

PortalException

SystemException

getFieldsMap

java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getFieldsMap(java.lang.String locale,
                                                                                            boolean includeTransientFields)
                                                                                              throws PortalException,
                                                                                                     SystemException

Throws:

PortalException

SystemException

getFieldTip

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

Throws:

PortalException

SystemException

getFieldTip

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

Throws:

PortalException

SystemException

getFieldType

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

Throws:

PortalException

SystemException

getLocalizedFieldsMap

java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>> getLocalizedFieldsMap()

getLocalizedPersistentFieldsMap

java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>> getLocalizedPersistentFieldsMap()

getLocalizedTransientFieldsMap

java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>> getLocalizedTransientFieldsMap()

getPersistentFieldsMap

java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getPersistentFieldsMap(java.lang.String locale)
                                                                                                        throws PortalException,
                                                                                                               SystemException

Throws:

PortalException

SystemException

getRootFieldNames

java.util.List<java.lang.String> getRootFieldNames()
                                                   throws PortalException,
                                                          SystemException

Throws:

PortalException

SystemException

getTemplates

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

Throws:

SystemException

getTransientFieldsMap

java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getTransientFieldsMap(java.lang.String locale)
                                                                                                       throws PortalException,
                                                                                                              SystemException

Throws:

PortalException

SystemException

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)
                 throws PortalException,
                        SystemException

Throws:

PortalException

SystemException

isFieldPrivate

boolean isFieldPrivate(java.lang.String fieldName)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

isFieldRepeatable

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

Throws:

PortalException

SystemException

isFieldTransient

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

Throws:

PortalException

SystemException

setDocument

void setDocument(Document document)

setLocalizedFieldsMap

void setLocalizedFieldsMap(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>> localizedFieldsMap)

setLocalizedPersistentFieldsMap

void setLocalizedPersistentFieldsMap(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>> localizedPersistentFieldsMap)

setLocalizedTransientFieldsMap

void setLocalizedTransientFieldsMap(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>> localizedTransientFieldsMap)