com.fatwire.assetapi.def
Interface AssetTypeDef

public interface AssetTypeDef

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

Asset tuye 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
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)
void	setAttributeDefs(java.util.List<AttributeDef> def)
void	setCaBeChild(boolean val)
void	setDescription(java.lang.String descr)
void	setName(java.lang.String name)
void	setParentDefs(java.util.List<AttributeDef> def)
void	setPlural(java.lang.String pluralname)
void	setProperties(AssetTypeDefProperties props)
void	setSubtype(java.lang.String 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 AttributeDef

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:

Map 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)

setDescription

void setDescription(java.lang.String descr)

setSubtype

void setSubtype(java.lang.String subtype)

setPlural

void setPlural(java.lang.String pluralname)

setCaBeChild

void setCaBeChild(boolean val)

setAttributeDefs

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

setProperties

void setProperties(AssetTypeDefProperties props)

setParentDefs

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

setAssociations

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