com.fatwire.services.beans.asset

Class TypeBean

java.lang.Object

com.fatwire.services.beans.BaseBean

com.fatwire.services.beans.asset.TypeBean

All Implemented Interfaces:

Serializable

public class TypeBean
extends BaseBean

The TypeBean is the classification of an asset. Every asset is an instance of an asset type composed of an ensemble of associated properties called attributes. An asset may also be further classified into a sub-type defined using a subset of those attributes from its enclosing type.

• For Assetmaker assets, an asset may optionally be classified into a sub-type.
• For Flex assets, every asset is necessarily an instance of a type definition (which is essentially a sub-type).
• tracked - flag to indicate if the asset type is revision tracked; this flag is set to true if the asset type is revision tracked

The type returned by TypeBean.getType() should match the string returned by the link AssetId getType() method.

See Also:

AssetId, AssetBean, Serialized Form

Constructor Summary

Constructors

Constructor and Description
TypeBean() Default constructor does not set a type or sub-type.
TypeBean(String type) Overloaded Constructor which sets only a type.
TypeBean(String type, String subtype) Overloaded Constructor which sets a type and a sub-type.

Method Summary

Modifier and Type	Method and Description
String	getAssetTypeDescription() Returns the description of the asset type
String	getSubType() Returns the sub type of an asset.
String	getType() Returns the type of an asset.
boolean	isFlex()
Boolean	isTracked() Returns true if this asset type is revision tracked.
void	setAssetTypeDescription(String assetTypeDescription) Set the description of the asset type.
void	setFlex(boolean isFlex)
void	setSubType(String subType) Sets the sub-type for an asset.
void	setTracked(Boolean tracked) Sets a flag to indicate if the asset type is revision tracked.
void	setType(String type) Sets the type for an asset.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TypeBean

public TypeBean()

Default constructor does not set a type or sub-type.

TypeBean

public TypeBean(String type)

Overloaded Constructor which sets only a type.

Parameters:

type - the type to set.

TypeBean

public TypeBean(String type,
                String subtype)

Overloaded Constructor which sets a type and a sub-type.

Parameters:

type - the type to set.

subtype - the subtype to set.

Method Detail

getSubType

public String getSubType()

Returns the sub type of an asset. For Assetmaker assets, this may return null if there is no sub-type classification for the asset. For Flex assets, it is guaranteed to return the type definition for the asset instance.

Returns:

the sub type for an asset, may return null for assetmaker assets in case of no sub-type classification.

getType

public String getType()

Returns the type of an asset.

Returns:

the type of an asset.

setType

public void setType(String type)

Sets the type for an asset.

Parameters:

type - the name of the type to set for an asset.

setSubType

public void setSubType(String subType)

Sets the sub-type for an asset. For Assetmaker assets, sub-type is an optional classification for the asset, so this setter need not be called. For Flex assets, it is necessary to set the type definition for the asset instance as the sub-type.

Parameters:

subType - the name of the sub-type to set for an asset.

isTracked

public Boolean isTracked()

Returns true if this asset type is revision tracked.

Returns:

true if this asset type is revision tracked,false otherwise.

setTracked

public void setTracked(Boolean tracked)

Sets a flag to indicate if the asset type is revision tracked. Set the flag to true if the asset type is tracked. This information can be utilized by versioning related modules.

Parameters:

tracked - the flag to indicate if this asset type is tracked; set to true if the asset type is revision tracked, false otherwise.

getAssetTypeDescription

public String getAssetTypeDescription()

Returns the description of the asset type

Returns:

Returns the description of the asset type

setAssetTypeDescription

public void setAssetTypeDescription(String assetTypeDescription)

Set the description of the asset type.

Parameters:

assetTypeDescription - description of the asset type.

isFlex

public boolean isFlex()

setFlex

public void setFlex(boolean isFlex)