com.liferay.portlet.dynamicdatamapping.model
Interface DDMStructure

All Superinterfaces:

AuditedModel, BaseModel<DDMStructure>, ClassedModel, Cloneable, Comparable<DDMStructure>, DDMStructureModel, GroupedModel, 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.

Method Summary

abstract List<String>	getChildrenFieldNames(String fieldName)
abstract String	getCompleteXsd()
abstract Document	getDocument()
abstract String	getFieldDataType(String fieldName)
abstract String	getFieldLabel(String fieldName, Locale locale)
abstract String	getFieldLabel(String fieldName, String locale)
abstract Set<String>	getFieldNames()
abstract String	getFieldProperty(String fieldName, String property)
abstract String	getFieldProperty(String fieldName, String property, String locale)
abstract boolean	getFieldRepeatable(String fieldName)
abstract boolean	getFieldRequired(String fieldName)
abstract Map<String,String>	getFields(String fieldName, String attributeName, String attributeValue)
abstract Map<String,String>	getFields(String fieldName, String attributeName, String attributeValue, String locale)
abstract Map<String,Map<String,String>>	getFieldsMap()
abstract Map<String,Map<String,String>>	getFieldsMap(String locale)
abstract String	getFieldTip(String fieldName, Locale locale)
abstract String	getFieldTip(String fieldName, String locale)
abstract String	getFieldType(String fieldName)
abstract Map<String,Map<String,Map<String,String>>>	getLocalizedFieldsMap()
abstract Map<String,Map<String,Map<String,String>>>	getLocalizedTransientFieldsMap()
abstract List<String>	getRootFieldNames()
abstract List<DDMTemplate>	getTemplates()
abstract Map<String,Map<String,String>>	getTransientFieldsMap(String locale)
abstract String	getWebDavURL(ThemeDisplay themeDisplay, String webDAVToken) Returns the WebDAV URL to access the structure.
abstract boolean	hasField(String fieldName)
abstract boolean	isFieldPrivate(String fieldName)
abstract boolean	isFieldRepeatable(String fieldName)
abstract void	setDocument(Document document)
abstract void	setLocalizedFieldsMap(Map<String,Map<String,Map<String,String>>> localizedFieldsMap)
abstract void	setLocalizedTransientFieldsMap(Map<String,Map<String,Map<String,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

List<String> getChildrenFieldNames(String fieldName)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

getCompleteXsd

String getCompleteXsd()
                      throws PortalException,
                             SystemException

Throws:

PortalException

SystemException

getDocument

Document getDocument()

getFieldDataType

String getFieldDataType(String fieldName)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

getFieldLabel

String getFieldLabel(String fieldName,
                     Locale locale)
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

getFieldLabel

String getFieldLabel(String fieldName,
                     String locale)
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

getFieldNames

Set<String> getFieldNames()
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

getFieldProperty

String getFieldProperty(String fieldName,
                        String property)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

getFieldProperty

String getFieldProperty(String fieldName,
                        String property,
                        String locale)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

getFieldRepeatable

boolean getFieldRepeatable(String fieldName)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

getFieldRequired

boolean getFieldRequired(String fieldName)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

getFields

Map<String,String> getFields(String fieldName,
                             String attributeName,
                             String attributeValue)

getFields

Map<String,String> getFields(String fieldName,
                             String attributeName,
                             String attributeValue,
                             String locale)

getFieldsMap

Map<String,Map<String,String>> getFieldsMap()
                                            throws PortalException,
                                                   SystemException

Throws:

PortalException

SystemException

getFieldsMap

Map<String,Map<String,String>> getFieldsMap(String locale)
                                            throws PortalException,
                                                   SystemException

Throws:

PortalException

SystemException

getFieldTip

String getFieldTip(String fieldName,
                   Locale locale)
                   throws PortalException,
                          SystemException

Throws:

PortalException

SystemException

getFieldTip

String getFieldTip(String fieldName,
                   String locale)
                   throws PortalException,
                          SystemException

Throws:

PortalException

SystemException

getFieldType

String getFieldType(String fieldName)
                    throws PortalException,
                           SystemException

Throws:

PortalException

SystemException

getLocalizedFieldsMap

Map<String,Map<String,Map<String,String>>> getLocalizedFieldsMap()

getLocalizedTransientFieldsMap

Map<String,Map<String,Map<String,String>>> getLocalizedTransientFieldsMap()

getRootFieldNames

List<String> getRootFieldNames()
                               throws PortalException,
                                      SystemException

Throws:

PortalException

SystemException

getTemplates

List<DDMTemplate> getTemplates()
                               throws SystemException

Throws:

SystemException

getTransientFieldsMap

Map<String,Map<String,String>> getTransientFieldsMap(String locale)
                                                     throws PortalException,
                                                            SystemException

Throws:

PortalException

SystemException

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

Throws:

PortalException

SystemException

isFieldPrivate

boolean isFieldPrivate(String fieldName)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

isFieldRepeatable

boolean isFieldRepeatable(String fieldName)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

setDocument

void setDocument(Document document)

setLocalizedFieldsMap

void setLocalizedFieldsMap(Map<String,Map<String,Map<String,String>>> localizedFieldsMap)

setLocalizedTransientFieldsMap

void setLocalizedTransientFieldsMap(Map<String,Map<String,Map<String,String>>> localizedTransientFieldsMap)