AttributeDefProperties (Oracle WebCenter Sites Java API Reference)

java.lang.Object
- com.fatwire.assetapi.def.AttributeDefProperties

```
@Exported
public final class AttributeDefProperties
extends Object
```
This class is a container for all properties associated with AttributeDef. These properties and their values (defined here against each property) establish part of the data and part of the run time characteristics for attributes.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`AttributeDefProperties.EnumData` Indicates the data definition associated with an attribute of type ENUM.
`static class`	`AttributeDefProperties.ValueCount` Indicates whether the attribute is single valued, multiple valued or a multiple value ordered.

Field Summary

Fields
Modifier and Type Field and Description

static String ANYTYPE

static String FILENAME

static String FOLDER

Fields
Modifier and Type	Field and Description
`static String`	`ANYTYPE`
`static String`	`FILENAME`
`static String`	`FOLDER`

Constructor Summary

Constructors
Constructor and Description

AttributeDefProperties()

Constructors
Constructor and Description
`AttributeDefProperties()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AttributeDefProperties`	`copy()`
`AttributeDef`	`getAssetid()` Retrieves the assetid information for the attribute.
`Map<String,String>`	`getAssetRef()` Gets the asset reference map of attribute typed Asset.
`String`	`getAssetType()` Retrieves the asset type for attribute typed of asset.
`List<String>`	`getAssetTypeDef()` Retrieves the asset type for attribute typed of asset.
`String`	`getAttributeEditor()` Retrieves the attribute editor name for this flex attribute type.
`long`	`getAttributeId()` Gets the flex attribute id for a flex attribute.
`String`	`getCharset()` Gets the charset for the flex attribute.
`String`	`getContentType()` Gets the content type for a blob typed flex attribute.
`String`	`getConvertEngine()` Gets the convert engine name for the attribute.
`Map<String,AttributeDef>`	`getDataMap()` Gets the datamap for attribute typed List/Array etc.
`String`	`getDefaultValue()` gets the default value for the Attribute if no other value is specified.
`DependencyTypeEnum`	`getDepType()` Gets the dependency type of the attribute.
`String`	`getEditingStyple()` Gets the editing style, local, or remote for flex attribute.
`Number`	`getEndEnum()` Gets the ending enum value of attribute typed of STRUCT, ARRAY, and so on.
`String`	`getEnhancedAttributeEditor()` Retrieves the attribute editor name for this flex attribute type.
`AttributeDefProperties.EnumData`	`getEnumData()` Gets the enum data that the attribute could be valued.
`String`	`getExternalCol()` Gets the external table column name for flex attribute.
`String`	`getExternalId()` Gets the external table column name for the value of external saved flex attribute.
`String`	`getExternalTable()` Gets the external table name of the flex attribute.
`AttributeDef`	`getFilter()` Gets the filter for this attribute.
`String`	`getFilterID()` Retrieves the flex filter id associated with a flex attribute.
`int`	`getMinElementCount()` Gets the minimum element count for attribute typed List.
`int`	`getMinRowCount()` Gets the minimum row count for attribute typed List.
`DependencyTypeEnum`	`getMirrorDepType()` Retrieves the dependency type for this attribute in term of mirror publishing.
`AttributeDef`	`getMultiple()` Retrieves the multiple information about the attribute.
`AttributeDef`	`getOrdinal()` Retrieves the ordinal information for the attribute.
`AttributeDef`	`getRequired()` Retrieves the required information for the attribute.
`String`	`getSearchEngineName()` Gets the search engine name for the flex attribute.
`int`	`getSize()` Retrieves the data size of the attribute type.
`Number`	`getStartEnum()` Gets the starting enum value of an attribute of type STRUCT, ARRAY, and so on with enum data specified.
`String`	`getStorageStyle()` Gets the storage style, local or external, for flex attribute.
`List<String>`	`getSubtypes()`
`String`	`getUploadDir()` Gets the upload folder for the flex attribute typed URL.
`AttributeDefProperties.ValueCount`	`getValueCount()` Retrieves the ValueCount information (whether attribute is single, multiple, or multiple ordered) of the attribute in the asset definition.
`boolean`	`isAllowEmbeddedLinks()` Gets whether embedded links are allowed in this flex attribute or not.
`boolean`	`isDerivedFlexAttribute()` Retrieves whether the attribute is a derived attribute in the asset definition that contains it.
`boolean`	`isEditable()` Retrieves whether the attribute is editable or not in the asset.
`boolean`	`isExtendedAttribute()`
`boolean`	`isInheritedFlexAttribute()` Retrieves whether the attribute is an inherited parent attribute or not.
`void`	`setAllowEmbeddedLinks(boolean allowEmbeddedLinks)` Sets whether the attribute allows embedded links to be created inside its content.
`void`	`setAssetid(AttributeDef assetid)` Specifies the assetid information of the attribute.
`void`	`setAssetRef(Map<String,String> assetRef)` Sets the asset reference map of attribute typed Asset.
`void`	`setAssettTypeDef(List<String> assetTypeDef)` Specifies the asset type definition for the attribute typed of asset.
`void`	`setAssetType(String assetType)` Specifies The asset type for attribute typed of asset.
`void`	`setAttributeEditor(String attributeEditor)` Specifies the attribute editor name for this flex attribute type.
`void`	`setAttributeId(long attributeId)` Sets the id for the attribute.
`void`	`setCharset(String charset)` Sets charset for flex attribute.
`void`	`setContentType(String contentType)` Sets the content type for a blob typed flex attribute.
`void`	`setConvertEngine(String convertEngine)` Sets the convert engine for the attribute.
`void`	`setDataMap(Map<String,AttributeDef> dataMap)` Sets the datamap for attribute typed List/Array etc.
`void`	`setDefaultValue(String defaultValue)` Sets the default value for the Attribute.
`void`	`setDepType(DependencyTypeEnum depType)` Sets the dependency type of this attribute.
`void`	`setDerivedFlexAttribute(boolean derivedFlexAttribute)` Specifies whether the attribute is an derived attribute in the asset defintion that contains it.
`void`	`setEditable(boolean editable)` Specifies whether the attribute is editable or not in the asset.
`void`	`setEditingStyple(String editingStyple)` Sets the editing styple of the flex attribute.
`void`	`setEndEnum(Number endEnum)` Sets the ending enum value of attribute typed of STRUCT, ARRAY, and so on.
`void`	`setEnhancedAttributeEditor(String attributeEditor)` Specifies the attribute editor name for this flex attribute type.
`void`	`setEnumData(AttributeDefProperties.EnumData enumData)` Sets the enum data that the attribute could be valued.
`void`	`setExtendedAttribute(boolean extendedAttribute)`
`void`	`setExternalCol(String externalCol)` Sets the Column name of the external table where the attribute is stored.
`void`	`setExternalId(String externalId)` Sets the ID in the external table where the flex attribute is stored.
`void`	`setExternalTable(String externalTable)` Sets the external table name for the flex attribute that stored externally.
`void`	`setFilter(AttributeDef filter)` Sets the filter for this attribute.
`void`	`setFilterID(String filterID)` Specifies the flex filter id associated with a flex attribute.
`void`	`setInheritedFlexAttribute(boolean inheritedFlexAttribute)` Specifies whether the flex attribute is an attribute that has its values inherited from its parents.
`void`	`setMinElementCount(int minElementCount)` Sets the minimum element count for attribute typed List.
`void`	`setMinRowCount(int minRowCount)` Sets the minimum row count for attribute typed List.
`void`	`setMirrorDepType(DependencyTypeEnum mirrorDepType)` Specifies the dependency type for this attribute in term of mirror publishing.
`void`	`setMultiple(AttributeDef multiple)` Specifies the multiple information about the attribute.
`void`	`setOrdinal(AttributeDef ordinal)` Specifies the ordinal information for the attribute.
`void`	`setRequired(AttributeDef required)` Specifies the required information for the attribute.
`void`	`setSearchEngineName(String searchEngineName)` Sets the search engine name for the attribute to be indexed with.
`void`	`setSize(int size)` Specifies the size of the attribute.
`void`	`setStartEnum(Number startEnum)` Sets the starting enum value of attribute typed of STRUCT, ARRAY, ect.
`void`	`setStorageStyle(String storageStyle)` Sets the storage styple, local/external for the flex attribute; local indicates the attribute is stored in Content Server managed table, external indicates the attribute is from other table.
`void`	`setSubtypes(List<String> subtypes)`
`void`	`setUploadDir(String uploadDir)` Sets the upload folder for the flex attribute typed URL.
`void`	`setValueCount(AttributeDefProperties.ValueCount valueCount)` Specifies the ValueCount information(whether attribute is single, multiple, or multiple ordered) of the attribute in the asset definition.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - FOLDER
```
public static String FOLDER
```
  - FILENAME
```
public static String FILENAME
```
  - ANYTYPE
```
public static String ANYTYPE
```
- Constructor Detail
  - AttributeDefProperties
```
public AttributeDefProperties()
```
- Method Detail
  - isExtendedAttribute
```
public boolean isExtendedAttribute()
```
  - setExtendedAttribute
```
public void setExtendedAttribute(boolean extendedAttribute)
```
  - getFilterID
```
public String getFilterID()
```
    Retrieves the flex filter id associated with a flex attribute.
    
    Returns:
    
    The String filter id.
  - setFilterID
```
public void setFilterID(String filterID)
```
    Specifies the flex filter id associated with a flex attribute.
    
    Parameters:
    
    filterID - The String filter ID.
  - getDepType
```
public DependencyTypeEnum getDepType()
```
    Gets the dependency type of the attribute.
    
    Returns:
    
    The type of the dependency.
  - setDepType
```
public void setDepType(DependencyTypeEnum depType)
```
    Sets the dependency type of this attribute.
    
    Parameters:
    
    depType - The dependency type.
  - isInheritedFlexAttribute
```
public boolean isInheritedFlexAttribute()
```
    Retrieves whether the attribute is an inherited parent attribute or not.
    
    Returns:
    
    True, if it is an inherited attribute from parent; false, if it is not.
  - setInheritedFlexAttribute
```
public void setInheritedFlexAttribute(boolean inheritedFlexAttribute)
```
    Specifies whether the flex attribute is an attribute that has its values inherited from its parents.
    
    Parameters:
    
    inheritedFlexAttribute - true indicates this attribute is an inherited attribute, false indicates not.
  - getFilter
```
public AttributeDef getFilter()
```
    Gets the filter for this attribute.
    
    Returns:
    
    the filter.
  - setFilter
```
public void setFilter(AttributeDef filter)
```
    Sets the filter for this attribute.
    
    Parameters:
    
    filter - the filter.
  - getMultiple
```
public AttributeDef getMultiple()
```
    Retrieves the multiple information about the attribute.
    
    Returns:
    
    The object typed of AttributeDef to indicates whether the attribute is multiple or not.
  - setMultiple
```
public void setMultiple(AttributeDef multiple)
```
    Specifies the multiple information about the attribute.
    
    Parameters:
    
    multiple - the object typed of AttributeDef to indicates whether the attribute is multiple or not.
  - getAssetid
```
public AttributeDef getAssetid()
```
    Retrieves the assetid information for the attribute.
    
    Returns:
    
    the object that contains the object id information.
  - setAssetid
```
public void setAssetid(AttributeDef assetid)
```
    Specifies the assetid information of the attribute.
    
    Parameters:
    
    assetid - the object that contains the object id information.
  - getOrdinal
```
public AttributeDef getOrdinal()
```
    Retrieves the ordinal information for the attribute.
    
    Returns:
    
    The ordinal information.
  - setOrdinal
```
public void setOrdinal(AttributeDef ordinal)
```
    Specifies the ordinal information for the attribute.
    
    Parameters:
    
    ordinal - The ordinal information.
  - getRequired
```
public AttributeDef getRequired()
```
    Retrieves the required information for the attribute.
    
    Returns:
    
    The required information for the attribute.
  - setRequired
```
public void setRequired(AttributeDef required)
```
    Specifies the required information for the attribute.
    
    Parameters:
    
    Required - the required information for the attribute.
  - isDerivedFlexAttribute
```
public boolean isDerivedFlexAttribute()
```
    Retrieves whether the attribute is a derived attribute in the asset definition that contains it.
    
    Returns:
    
    true indicates this attribute is a derived attribute in the definition, false otherwise.
  - setDerivedFlexAttribute
```
public void setDerivedFlexAttribute(boolean derivedFlexAttribute)
```
    Specifies whether the attribute is an derived attribute in the asset defintion that contains it.
    
    Parameters:
    
    derivedFlexAttribute - true indicates this attribute is a derived attribute in the definition, false otherwise.
  - getValueCount
```
public AttributeDefProperties.ValueCount getValueCount()
```
    Retrieves the ValueCount information (whether attribute is single, multiple, or multiple ordered) of the attribute in the asset definition.
    
    Returns:
    
    The valuecount for this attribute definition.
  - setValueCount
```
public void setValueCount(AttributeDefProperties.ValueCount valueCount)
```
    Specifies the ValueCount information(whether attribute is single, multiple, or multiple ordered) of the attribute in the asset definition.
    
    Parameters:
    
    valueCount - The valuecount for this attribute definition.
  - getAssetType
```
public String getAssetType()
```
    Retrieves the asset type for attribute typed of asset.
    
    Returns:
    
    The asset type name.
  - setAssetType
```
public void setAssetType(String assetType)
```
    Specifies The asset type for attribute typed of asset.
    
    Parameters:
    
    assetType - the asset type name.
  - getAssetTypeDef
```
public List<String> getAssetTypeDef()
```
    Retrieves the asset type for attribute typed of asset.
    
    Returns:
    
    The asset type name.
  - setAssettTypeDef
```
public void setAssettTypeDef(List<String> assetTypeDef)
```
    Specifies the asset type definition for the attribute typed of asset.
    
    Parameters:
    
    assetTypeDef - the asset type definition.
  - getMirrorDepType
```
public DependencyTypeEnum getMirrorDepType()
```
    Retrieves the dependency type for this attribute in term of mirror publishing.
    
    Returns:
    
    the dependency type.
  - setMirrorDepType
```
public void setMirrorDepType(DependencyTypeEnum mirrorDepType)
```
    Specifies the dependency type for this attribute in term of mirror publishing.
    
    Parameters:
    
    mirrorDepType - the dependency type.
  - getAttributeEditor
```
public String getAttributeEditor()
```
    Retrieves the attribute editor name for this flex attribute type.
    
    Returns:
    
    The name of the attribute editor.
  - setAttributeEditor
```
public void setAttributeEditor(String attributeEditor)
```
    Specifies the attribute editor name for this flex attribute type.
    
    Parameters:
    
    attributeEditor - the name of the attribute editor.
  - getEnhancedAttributeEditor
```
public String getEnhancedAttributeEditor()
```
    Retrieves the attribute editor name for this flex attribute type.
    
    Returns:
    
    The name of the attribute editor.
  - setEnhancedAttributeEditor
```
public void setEnhancedAttributeEditor(String attributeEditor)
```
    Specifies the attribute editor name for this flex attribute type.
    
    Parameters:
    
    attributeEditor - the name of the attribute editor.
  - getSize
```
public int getSize()
```
    Retrieves the data size of the attribute type.
    
    Returns:
    
    The size of the attribute data.
  - setSize
```
public void setSize(int size)
```
    Specifies the size of the attribute.
    
    Parameters:
    
    size - the size of the attribute data.
  - isEditable
```
public boolean isEditable()
```
    Retrieves whether the attribute is editable or not in the asset.
    
    Returns:
    
    true indicates the attribute is editable, false indicates otherwise.
  - setEditable
```
public void setEditable(boolean editable)
```
    Specifies whether the attribute is editable or not in the asset.
    
    Parameters:
    
    editable - true indicates the attribute is editable, false indicates otherwise.
  - getDataMap
```
public Map<String,AttributeDef> getDataMap()
```
    Gets the datamap for attribute typed List/Array etc.
    
    Returns:
    
    The data map.
  - setDataMap
```
public void setDataMap(Map<String,AttributeDef> dataMap)
```
    Sets the datamap for attribute typed List/Array etc.
    
    Parameters:
    
    dataMap - the datamap.
  - getEnumData
```
public AttributeDefProperties.EnumData getEnumData()
```
    Gets the enum data that the attribute could be valued.
    
    Returns:
    
    The enum data object.
  - setEnumData
```
public void setEnumData(AttributeDefProperties.EnumData enumData)
```
    Sets the enum data that the attribute could be valued.
    
    Parameters:
    
    enumData - the enum data.
  - getMinRowCount
```
public int getMinRowCount()
```
    Gets the minimum row count for attribute typed List.
    
    Returns:
    
    The minimum row count.
  - setMinRowCount
```
public void setMinRowCount(int minRowCount)
```
    Sets the minimum row count for attribute typed List.
    
    Parameters:
    
    minRowCount - the minimum row count.
  - getMinElementCount
```
public int getMinElementCount()
```
    Gets the minimum element count for attribute typed List.
    
    Returns:
    
    the minimum row count.
  - setMinElementCount
```
public void setMinElementCount(int minElementCount)
```
    Sets the minimum element count for attribute typed List.
    
    Parameters:
    
    minElementCount - the minimum row count.
  - getStartEnum
```
public Number getStartEnum()
```
    Gets the starting enum value of an attribute of type STRUCT, ARRAY, and so on with enum data specified.
    
    Returns:
    
    The start enum object.
  - setStartEnum
```
public void setStartEnum(Number startEnum)
```
    Sets the starting enum value of attribute typed of STRUCT, ARRAY, ect. and with enum data specified.
    
    Parameters:
    
    startEnum - the start enum object.
  - getEndEnum
```
public Number getEndEnum()
```
    Gets the ending enum value of attribute typed of STRUCT, ARRAY, and so on. and with enum data specified.
    
    Returns:
    
    The end enum object.
  - setEndEnum
```
public void setEndEnum(Number endEnum)
```
    Sets the ending enum value of attribute typed of STRUCT, ARRAY, and so on. and with enum data specified.
    
    Parameters:
    
    endEnum - the end enum object.
  - getAssetRef
```
public Map<String,String> getAssetRef()
```
    Gets the asset reference map of attribute typed Asset.
    
    Returns:
    
    The reference map.
  - setAssetRef
```
public void setAssetRef(Map<String,String> assetRef)
```
    Sets the asset reference map of attribute typed Asset.
    
    Parameters:
    
    assetRef - the reference map.
  - getUploadDir
```
public String getUploadDir()
```
    Gets the upload folder for the flex attribute typed URL.
    
    Returns:
    
    The string folder name.
  - setUploadDir
```
public void setUploadDir(String uploadDir)
```
    Sets the upload folder for the flex attribute typed URL.
    
    Parameters:
    
    uploadDir - the string folder name.
  - isAllowEmbeddedLinks
```
public boolean isAllowEmbeddedLinks()
```
    Gets whether embedded links are allowed in this flex attribute or not.
    
    Returns:
    
    TRUE/FALSE
  - setAllowEmbeddedLinks
```
public void setAllowEmbeddedLinks(boolean allowEmbeddedLinks)
```
    Sets whether the attribute allows embedded links to be created inside its content.
    
    Parameters:
    
    allowEmbeddedLinks - TRUE indicates embeddedLinks are allowed, FALSE indicates otherwise.
  - getEditingStyple
```
public String getEditingStyple()
```
    Gets the editing style, local, or remote for flex attribute.
    
    Returns:
    
    The editing style.
  - setEditingStyple
```
public void setEditingStyple(String editingStyple)
```
    Sets the editing styple of the flex attribute.
    
    Parameters:
    
    editingStyple - the editing styple of the flex attribute.
  - getStorageStyle
```
public String getStorageStyle()
```
    Gets the storage style, local or external, for flex attribute.
    
    Returns:
    
    The storage style.
  - setStorageStyle
```
public void setStorageStyle(String storageStyle)
```
    Sets the storage styple, local/external for the flex attribute; local indicates the attribute is stored in Content Server managed table, external indicates the attribute is from other table.
    
    Parameters:
    
    storageStyle - local or external.
  - getExternalId
```
public String getExternalId()
```
    Gets the external table column name for the value of external saved flex attribute.
    
    Returns:
    
    The external table column name.
  - setExternalId
```
public void setExternalId(String externalId)
```
    Sets the ID in the external table where the flex attribute is stored.
    
    Parameters:
    
    externalId - the identifier.
  - getExternalCol
```
public String getExternalCol()
```
    Gets the external table column name for flex attribute.
    
    Returns:
    
    The external table column name.
  - setExternalCol
```
public void setExternalCol(String externalCol)
```
    Sets the Column name of the external table where the attribute is stored.
    
    Parameters:
    
    externalCol - the column name in the external table.
  - getExternalTable
```
public String getExternalTable()
```
    Gets the external table name of the flex attribute.
    
    Returns:
    
    The external table name.
  - setExternalTable
```
public void setExternalTable(String externalTable)
```
    Sets the external table name for the flex attribute that stored externally.
    
    Parameters:
    
    externalTable - table name.
  - getCharset
```
public String getCharset()
```
    Gets the charset for the flex attribute.
    
    Returns:
    
    The charset.
  - setCharset
```
public void setCharset(String charset)
```
    Sets charset for flex attribute.
    
    Parameters:
    
    charset - the String form of the charset.
  - getContentType
```
public String getContentType()
```
    Gets the content type for a blob typed flex attribute.
    
    Returns:
    
    The content type.
  - setContentType
```
public void setContentType(String contentType)
```
    Sets the content type for a blob typed flex attribute.
    
    Parameters:
    
    contentType - the String form of the content type.
  - getSearchEngineName
```
public String getSearchEngineName()
```
    Gets the search engine name for the flex attribute.
    
    Returns:
    
    The search engine name.
  - setSearchEngineName
```
public void setSearchEngineName(String searchEngineName)
```
    Sets the search engine name for the attribute to be indexed with.
    
    Parameters:
    
    searchEngineName - the search engine name (Verity, for example).
  - getConvertEngine
```
public String getConvertEngine()
```
    Gets the convert engine name for the attribute.
    
    Returns:
    
    The convert engine name.
  - setConvertEngine
```
public void setConvertEngine(String convertEngine)
```
    Sets the convert engine for the attribute.
    
    Parameters:
    
    convertEngine - the convert engine for the attribute.
  - getAttributeId
```
public long getAttributeId()
```
    Gets the flex attribute id for a flex attribute.
    
    Returns:
    
    The id of the flex attribute.
  - setAttributeId
```
public void setAttributeId(long attributeId)
```
    Sets the id for the attribute.
    
    Parameters:
    
    attributeId - the id for the attribute.
  - getSubtypes
```
public List<String> getSubtypes()
```
  - setSubtypes
```
public void setSubtypes(List<String> subtypes)
```
  - getDefaultValue
```
public String getDefaultValue()
```
    gets the default value for the Attribute if no other value is specified.
    
    Returns:
    
    the String format of the default value.
  - setDefaultValue
```
public void setDefaultValue(String defaultValue)
```
    Sets the default value for the Attribute.
    
    Parameters:
    
    defaultValue - the String format of the default value.
  - copy
```
public final AttributeDefProperties copy()
```

Class AttributeDefProperties

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FOLDER

FILENAME

ANYTYPE

Constructor Detail

AttributeDefProperties

Method Detail

isExtendedAttribute

setExtendedAttribute

getFilterID

setFilterID

getDepType

setDepType

isInheritedFlexAttribute

setInheritedFlexAttribute

getFilter

setFilter

getMultiple

setMultiple

getAssetid

setAssetid

getOrdinal

setOrdinal

getRequired

setRequired

isDerivedFlexAttribute

setDerivedFlexAttribute

getValueCount

setValueCount

getAssetType

setAssetType

getAssetTypeDef

setAssettTypeDef

getMirrorDepType

setMirrorDepType

getAttributeEditor

setAttributeEditor

getEnhancedAttributeEditor

setEnhancedAttributeEditor

getSize

setSize

isEditable

setEditable

getDataMap

setDataMap

getEnumData

setEnumData

getMinRowCount

setMinRowCount

getMinElementCount

setMinElementCount

getStartEnum

setStartEnum

getEndEnum

setEndEnum

getAssetRef

setAssetRef

getUploadDir

setUploadDir

isAllowEmbeddedLinks

setAllowEmbeddedLinks

getEditingStyple

setEditingStyple

getStorageStyle

setStorageStyle

getExternalId

setExternalId

getExternalCol

setExternalCol

getExternalTable

setExternalTable

getCharset

setCharset

getContentType