Skip navigation links

com.fatwire.assetapi.def
Interface AssetTypeDef

All Known Implementing Classes:

AssetTypeDefImpl

public interface AssetTypeDef

This interface defines an Asset Type definition. Definition is the metadata information about the type.

Asset type definition contains

• General information, such as name, description etc
• Definition of attributes contained using AssetTypeDef.getAttributeDefs()
• Definition asset associations using AssetTypeDef.getAssociations()
• Parent definitions using AssetTypeDef.getParentDefs()
• Misellaneous asset type properties using AssetTypeDef.getProperties()

An instance of AssetTypeDef for a given asset type (and subtype, if applicable) can be obtained using AssetTypeDefManager.

Method Summary

java.util.List<AssetAssociationDef>	getAssociations() Gets association definitions for this asset type
AttributeDef	getAttributeDef(java.lang.String name, boolean isMetaAttribute) Return the attribute definition for that given name and specified user defined or not type
java.util.List<AttributeDef>	getAttributeDefs() Returns all attribute definitions that make up this asset type definition
boolean	getCanBeChild() Indicates if instances of this asset type can be a child of instances of other asset types.
java.lang.String	getDescription() Gets the description associated with the asset type.
java.lang.String	getName() Gets the name of the Asset type
java.util.List<AttributeDef>	getParentDefs() Lists parent definitions for thsi asset type
java.lang.String	getPlural() Gets the plural name associated with the asset type.
AssetTypeDefProperties	getProperties() Returns properties associated with asset type
java.lang.String	getSubtype() Returns the name of subtype, if present.
void	setAssociations(java.util.List<AssetAssociationDef> associations) Sets the association definitions of this asset type
void	setAttributeDefs(java.util.List<AttributeDef> def) Sets the list of attribute definitions that the asset type contains
void	setCaBeChild(boolean val) Sets whether the asset type could be child asset type of other asset types or not
void	setDescription(java.lang.String desc) Sets the description of the asset type definition
void	setName(java.lang.String name) Sets the asset type
void	setParentDefs(java.util.List<AttributeDef> def) Sets the list of parent definitions
void	setPlural(java.lang.String pluralname) Sets the plural name of the asset type
void	setProperties(AssetTypeDefProperties props) Sets the properties for the asset type
void	setSubtype(java.lang.String subtype) Sets the asset subtype

Method Detail

getName

java.lang.String getName()

Gets the name of the Asset type

Returns:

name of the asset type this definition belongs

getDescription

java.lang.String getDescription()

Gets the description associated with the asset type.

Returns:

description associated with the asset type.

getSubtype

java.lang.String getSubtype()

Returns the name of subtype, if present. Subtype in this sense is the flex definition of the flex asset or flex parent asset type.

Returns:

Subtype, if applicable

getPlural

java.lang.String getPlural()

Gets the plural name associated with the asset type.

Returns:

plural name associated with the asset type.

getCanBeChild

boolean getCanBeChild()

Indicates if instances of this asset type can be a child of instances of other asset types.

Returns:

true if instances can be child, false otherwise.

getAttributeDefs

java.util.List<AttributeDef> getAttributeDefs()

Returns all attribute definitions that make up this asset type definition

Returns:

List of AttributeDefs

getAttributeDef

AttributeDef getAttributeDef(java.lang.String name,
                             boolean isMetaAttribute)

Return the attribute definition for that given name and specified user defined or not type

Parameters:

name - the name of the attribute

isMetaAttribute - whether the attribute is user defined or system, true indicates it is user defined, false indicates it is system attribute

Returns:

the attribute definition; null if no attribute defintion found.

getProperties

AssetTypeDefProperties getProperties()

Returns properties associated with asset type

Returns:

Map Properties with AssetTypeDefProperties.Keys as kays and pre defined values.

getAssociations

java.util.List<AssetAssociationDef> getAssociations()

Gets association definitions for this asset type

Returns:

List of Asset association name and asset type name

getParentDefs

java.util.List<AttributeDef> getParentDefs()

Lists parent definitions for thsi asset type

Returns:

List of AssetTypeDef of parent asset type definitions.

setName

void setName(java.lang.String name)

Sets the asset type

Parameters:

name - the name of the asset type

setDescription

void setDescription(java.lang.String desc)

Sets the description of the asset type definition

Parameters:

desc - the description

setSubtype

void setSubtype(java.lang.String subtype)

Sets the asset subtype

Parameters:

subtype - the subtype

setPlural

void setPlural(java.lang.String pluralname)

Sets the plural name of the asset type

Parameters:

pluralname - the plural

setCaBeChild

void setCaBeChild(boolean val)

Sets whether the asset type could be child asset type of other asset types or not

Parameters:

val - true if the asset type could be child; false if not

setAttributeDefs

void setAttributeDefs(java.util.List<AttributeDef> def)

Sets the list of attribute definitions that the asset type contains

Parameters:

def - the list of attribute definitions

setProperties

void setProperties(AssetTypeDefProperties props)

Sets the properties for the asset type

Parameters:

props - the AssetTypeDefProperties

setParentDefs

void setParentDefs(java.util.List<AttributeDef> def)

Sets the list of parent definitions

Parameters:

def - the list of parent defintions

setAssociations

void setAssociations(java.util.List<AssetAssociationDef> associations)

Sets the association definitions of this asset type

Parameters:

associations - the list of AssetAssocationDefs

Skip navigation links