@Exported public final class AttributeDefProperties extends Object
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.
|
Modifier and Type | Field and Description |
---|---|
static String |
ANYTYPE |
static String |
FILENAME |
static String |
FOLDER |
Constructor and Description |
---|
AttributeDefProperties() |
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.
|
public static String FOLDER
public static String FILENAME
public static String ANYTYPE
public boolean isExtendedAttribute()
public void setExtendedAttribute(boolean extendedAttribute)
public String getFilterID()
public void setFilterID(String filterID)
filterID
- The String filter ID.public DependencyTypeEnum getDepType()
public void setDepType(DependencyTypeEnum depType)
depType
- The dependency type.public boolean isInheritedFlexAttribute()
public void setInheritedFlexAttribute(boolean inheritedFlexAttribute)
inheritedFlexAttribute
- true
indicates this attribute is an inherited attribute, false
indicates not.public AttributeDef getFilter()
public void setFilter(AttributeDef filter)
filter
- the filter.public AttributeDef getMultiple()
public void setMultiple(AttributeDef multiple)
multiple
- the object typed of AttributeDef to indicates whether the attribute is multiple or not.public AttributeDef getAssetid()
public void setAssetid(AttributeDef assetid)
assetid
- the object that contains the object id information.public AttributeDef getOrdinal()
public void setOrdinal(AttributeDef ordinal)
ordinal
- The ordinal information.public AttributeDef getRequired()
public void setRequired(AttributeDef required)
Required
- the required information for the attribute.public boolean isDerivedFlexAttribute()
true
indicates this attribute is a derived attribute in the definition, false
otherwise.public void setDerivedFlexAttribute(boolean derivedFlexAttribute)
derivedFlexAttribute
- true
indicates this attribute is a derived attribute in the definition, false
otherwise.public AttributeDefProperties.ValueCount getValueCount()
public void setValueCount(AttributeDefProperties.ValueCount valueCount)
valueCount
- The valuecount for this attribute definition.public String getAssetType()
public void setAssetType(String assetType)
assetType
- the asset type name.public List<String> getAssetTypeDef()
public void setAssettTypeDef(List<String> assetTypeDef)
assetTypeDef
- the asset type definition.public DependencyTypeEnum getMirrorDepType()
public void setMirrorDepType(DependencyTypeEnum mirrorDepType)
mirrorDepType
- the dependency type.public String getAttributeEditor()
public void setAttributeEditor(String attributeEditor)
attributeEditor
- the name of the attribute editor.public String getEnhancedAttributeEditor()
public void setEnhancedAttributeEditor(String attributeEditor)
attributeEditor
- the name of the attribute editor.public int getSize()
public void setSize(int size)
size
- the size of the attribute data.public boolean isEditable()
true
indicates the attribute is editable, false
indicates otherwise.public void setEditable(boolean editable)
editable
- true
indicates the attribute is editable, false
indicates otherwise.public Map<String,AttributeDef> getDataMap()
public void setDataMap(Map<String,AttributeDef> dataMap)
dataMap
- the datamap.public AttributeDefProperties.EnumData getEnumData()
public void setEnumData(AttributeDefProperties.EnumData enumData)
enumData
- the enum data.public int getMinRowCount()
public void setMinRowCount(int minRowCount)
minRowCount
- the minimum row count.public int getMinElementCount()
public void setMinElementCount(int minElementCount)
minElementCount
- the minimum row count.public Number getStartEnum()
public void setStartEnum(Number startEnum)
startEnum
- the start enum object.public Number getEndEnum()
public void setEndEnum(Number endEnum)
endEnum
- the end enum object.public Map<String,String> getAssetRef()
public void setAssetRef(Map<String,String> assetRef)
assetRef
- the reference map.public String getUploadDir()
public void setUploadDir(String uploadDir)
uploadDir
- the string folder name.public boolean isAllowEmbeddedLinks()
public void setAllowEmbeddedLinks(boolean allowEmbeddedLinks)
allowEmbeddedLinks
- TRUE
indicates embeddedLinks are allowed, FALSE
indicates otherwise.public String getEditingStyple()
public void setEditingStyple(String editingStyple)
editingStyple
- the editing styple of the flex attribute.public String getStorageStyle()
public void setStorageStyle(String storageStyle)
storageStyle
- local or external.public String getExternalId()
public void setExternalId(String externalId)
externalId
- the identifier.public String getExternalCol()
public void setExternalCol(String externalCol)
externalCol
- the column name in the external table.public String getExternalTable()
public void setExternalTable(String externalTable)
externalTable
- table name.public String getCharset()
public void setCharset(String charset)
charset
- the String form of the charset.public String getContentType()
public void setContentType(String contentType)
contentType
- the String form of the content type.public String getSearchEngineName()
public void setSearchEngineName(String searchEngineName)
searchEngineName
- the search engine name (Verity, for example).public String getConvertEngine()
public void setConvertEngine(String convertEngine)
convertEngine
- the convert engine for the attribute.public long getAttributeId()
public void setAttributeId(long attributeId)
attributeId
- the id for the attribute.public String getDefaultValue()
public void setDefaultValue(String defaultValue)
defaultValue
- the String format of the default value.public final AttributeDefProperties copy()