Asset (AEM Forms API)

java.lang.Object
- com.adobe.icc.dbforms.obj.Asset

All Implemented Interfaces:

ILocalizable, ILocalizationResourceContainer, Serializable

Direct Known Subclasses:

ContainerLayout, DataModule, Form, Letter
```
public abstract class Asset
extends Object
implements Serializable, ILocalizable, ILocalizationResourceContainer
```
Base class (POJO) for all asset types in the system, like DataModule, TextModule, ListDataModule, etc.

Contains basic common attributes for an Asset, such as name, description, version, etc.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Date`	`activeEndDate`
`protected Date`	`activeStartDate`
`static String`	`ASSET_CLASS`
`static String`	`ASSOCIATION_CUTPOINT`
`protected String`	`comment`
`protected String`	`crxVersion`
`protected String`	`desc`
`protected Map<String,Object>`	`extendedProperties`
`static String`	`FIRST_LEVEL_CUTPOINT`
`static String`	`FIRST_LEVEL_WITH_CAT_NAMES_CUTPOINT`
`protected String`	`folderId`
`static String`	`HIERARCHY_CUTPOINT`
`protected String`	`id`
`protected String`	`lastChangeBy`
`protected Date`	`lastPublishDate`
`protected String`	`lastPublishedBy`
`protected String`	`lastReplicationAction`
`protected Date`	`lastUpdateDate`
`protected Calendar`	`lastVersionDate`
`protected com.adobe.icc.dbforms.obj.Category`	`lcat`
`protected String`	`name`
`static String`	`PROPERTY_NAME_DESCRIPTION`
`static String`	`PROPERTY_NAME_TITLE`
`static String`	`PROPERTY_NAME_VERSION`
`static String`	`READY_TO_PUBLISH_CUTPOINT`
`protected int`	`state`
`protected String[]`	`tags`
`protected String`	`title`
`protected Map<String,Object>`	`transientProperties`
`protected com.adobe.icc.dbforms.obj.Category`	`ucat`
`protected int`	`updatedBy`
`protected int`	`version`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`Asset()` Default constructor.
`protected`	`Asset(String name, String desc, int version, String comment, int state, Date activeStartDate, Date activeEndDate, String lastChangeBy)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Date`	`getActiveEndDate()` Deprecated.
`Date`	`getActiveStartDate()` Deprecated.
`String`	`getComment()` Get the comment for the Asset.
`String`	`getCrxVersion()` Get the crxVersion for the Asset.
`String`	`getDesc()` Get the description for the Asset.
`String`	`getDisplayField()` Get the Display Name of an asset if title is null then name will be displayed.
`Map<String,Object>`	`getExtendedProperties()` Get the extended properties for the Asset.
`String`	`getFolderId()` Get the parent folder location for the Asset.
`String`	`getId()` Get the unique identifier for the Asset.
`String`	`getLastChangeBy()` Get the user who last changed the Asset.
`Date`	`getLastPublishDate()` Get the last publish date of this Asset.
`String`	`getLastPublishedBy()` Get the user who last published the Asset.
`String`	`getLastReplicationAction()`
`Date`	`getLastUpdateDate()` Get the last update date of this Asset.
`Calendar`	`getLastVersionDate()`
`com.adobe.icc.dbforms.obj.Category`	`getLcat()` Get the Subcategory for the Asset.
`String`	`getLocalizationPrefix()` The prefix that is appended to all the localizable properties of the this object while generating localization keys
`List<LocalizationResourceInfo>`	`getLocalizationResourceInfoList()` gets the list containing localization data associated with this object
`String`	`getName()` Get the name for the Asset.
`int`	`getState()` Get the state for the Asset.
`String[]`	`getTags()`
`String`	`getTitle()` Get the title for the Asset.
`Map<String,Object>`	`getTransientProperties()`
`com.adobe.icc.dbforms.obj.Category`	`getUcat()` Get the Category for the Asset.
`int`	`getUpdatedBy()`
`int`	`getVersion()` Get the version for the Asset.
`int`	`hashCode()`
`void`	`setActiveEndDate(Date activeEndDate)` Deprecated.
`void`	`setActiveStartDate(Date activeStartDate)` Deprecated.
`void`	`setComment(String comment)` Sets the comment for the Asset.
`void`	`setCrxVersion(String crxVersion)` Set the crxVersion for the Asset.
`void`	`setDesc(String desc)` Sets the description for the Asset.
`void`	`setExtendedProperties(Map<String,Object> extendedProperties)` Sets the extended properties for the Asset.
`void`	`setFolderId(String folderId)` Sets the parent folder location for the Asset.
`void`	`setId(String id)` Sets the unique identifier for the Asset.
`void`	`setLastChangeBy(String lastChangeBy)` Sets the user who last changed the Asset.
`void`	`setLastPublishDate(Date lastPublishDate)` Sets the last publish date of this Asset.
`void`	`setLastPublishedBy(String lastPublishedBy)` Sets the user who last published the Asset.
`void`	`setLastReplicationAction(String lastReplicationAction)`
`void`	`setLastUpdateDate(Date lastUpdateDate)` Sets the last update date of this Asset.
`void`	`setLastVersionDate(Calendar lastVersionDate)`
`void`	`setLcat(com.adobe.icc.dbforms.obj.Category lcat)` Sets the Subcategory for the Asset.
`void`	`setLocalizationPrefix(String prefix)`
`void`	`setLocalizationResourceInfoList(List<LocalizationResourceInfo> localizationResourceInfoList)` Sets the list of `LocalizationResourceInfo` on this object
`void`	`setName(String name)` Sets the name for the Asset.
`void`	`setState(int state)` Sets the state for the Asset.
`void`	`setTags(String[] tags)`
`void`	`setTitle(String title)` Sets the title for the Asset.
`void`	`setTransientProperties(Map<String,Object> transientProperties)`
`void`	`setUcat(com.adobe.icc.dbforms.obj.Category ucat)` Sets the Category for the Asset.
`void`	`setUpdatedBy(int updatedBy)`
`void`	`setVersion(int version)` Sets the version for the Asset.

- Field Detail
  - id
```
protected String id
```
  - folderId
```
protected String folderId
```
  - ASSET_CLASS
```
public static final String ASSET_CLASS
```
  - ASSOCIATION_CUTPOINT
```
public static final String ASSOCIATION_CUTPOINT
```
  - FIRST_LEVEL_WITH_CAT_NAMES_CUTPOINT
```
public static final String FIRST_LEVEL_WITH_CAT_NAMES_CUTPOINT
```
  - HIERARCHY_CUTPOINT
```
public static final String HIERARCHY_CUTPOINT
```
  - FIRST_LEVEL_CUTPOINT
```
public static final String FIRST_LEVEL_CUTPOINT
```
  - READY_TO_PUBLISH_CUTPOINT
```
public static final String READY_TO_PUBLISH_CUTPOINT
```
  - PROPERTY_NAME_DESCRIPTION
```
public static final String PROPERTY_NAME_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - PROPERTY_NAME_TITLE
```
public static final String PROPERTY_NAME_TITLE
```
    See Also:
    
    Constant Field Values
  - PROPERTY_NAME_VERSION
```
public static final String PROPERTY_NAME_VERSION
```
    See Also:
    
    Constant Field Values
  - name
```
protected String name
```
  - title
```
protected String title
```
  - desc
```
protected String desc
```
  - version
```
protected int version
```
  - crxVersion
```
protected String crxVersion
```
  - lastVersionDate
```
protected Calendar lastVersionDate
```
  - comment
```
protected String comment
```
  - state
```
protected int state
```
  - activeStartDate
```
protected Date activeStartDate
```
  - activeEndDate
```
protected Date activeEndDate
```
  - lastUpdateDate
```
protected Date lastUpdateDate
```
  - lastPublishDate
```
protected Date lastPublishDate
```
  - lastReplicationAction
```
protected String lastReplicationAction
```
  - lastPublishedBy
```
protected String lastPublishedBy
```
  - updatedBy
```
protected int updatedBy
```
  - lastChangeBy
```
protected String lastChangeBy
```
  - ucat
```
protected com.adobe.icc.dbforms.obj.Category ucat
```
  - lcat
```
protected com.adobe.icc.dbforms.obj.Category lcat
```
  - extendedProperties
```
protected Map<String,Object> extendedProperties
```
  - transientProperties
```
protected Map<String,Object> transientProperties
```
  - tags
```
protected String[] tags
```
- Constructor Detail
  - Asset
```
public Asset()
```
    Default constructor.
  - Asset
```
protected Asset(String name,
                String desc,
                int version,
                String comment,
                int state,
                Date activeStartDate,
                Date activeEndDate,
                String lastChangeBy)
```
- Method Detail
  - setId
```
public void setId(String id)
```
    Sets the unique identifier for the Asset.
    
    Parameters:
    
    id - The unique identifier for the Asset.
  - getId
```
public String getId()
```
    Get the unique identifier for the Asset.
    
    Returns:
    
    The unique identifier for the Asset.
  - setLcat
```
public void setLcat(com.adobe.icc.dbforms.obj.Category lcat)
```
    Sets the Subcategory for the Asset.
    
    Parameters:
    
    lcat - The Subcategory for the Asset
  - setUcat
```
public void setUcat(com.adobe.icc.dbforms.obj.Category ucat)
```
    Sets the Category for the Asset.
    
    Parameters:
    
    ucat - The Category for the Asset.
  - getLcat
```
public com.adobe.icc.dbforms.obj.Category getLcat()
```
    Get the Subcategory for the Asset.
    
    Returns:
    
    The Subcategory for the Asset.
  - getUcat
```
public com.adobe.icc.dbforms.obj.Category getUcat()
```
    Get the Category for the Asset.
    
    Returns:
    
    The Category for the Asset.
  - setName
```
public void setName(String name)
```
    Sets the name for the Asset.
    
    Parameters:
    
    name - The name for the Asset.
  - getName
```
public String getName()
```
    Get the name for the Asset.
    
    Specified by:
    
    getName in interface ILocalizationResourceContainer
    
    Returns:
    
    The name for the Asset.
  - setTitle
```
public void setTitle(String title)
```
    Sets the title for the Asset.
    
    Parameters:
    
    title - The title for the Asset.
  - getTitle
```
public String getTitle()
```
    Get the title for the Asset.
    
    Returns:
    
    The title for the Asset.
  - getDisplayField
```
public String getDisplayField()
```
    Get the Display Name of an asset if title is null then name will be displayed. for the Asset.
    
    Returns:
    
    The displayField for the Asset.
  - setDesc
```
public void setDesc(String desc)
```
    Sets the description for the Asset.
    
    Parameters:
    
    desc - The description for the Asset.
  - getDesc
```
public String getDesc()
```
    Get the description for the Asset.
    
    Returns:
    
    The description for the Asset.
  - setVersion
```
public void setVersion(int version)
```
    Sets the version for the Asset.
    
    Parameters:
    
    version - The version for the Asset.
  - getVersion
```
public int getVersion()
```
    Get the version for the Asset.
    
    Returns:
    
    The version for the Asset.
  - getCrxVersion
```
public String getCrxVersion()
```
    Get the crxVersion for the Asset.
    
    Returns:
    
    the crxVersion.
  - setCrxVersion
```
public void setCrxVersion(String crxVersion)
```
    Set the crxVersion for the Asset.
    
    Parameters:
    
    crxVersion - the crxVersion to set.
  - setComment
```
public void setComment(String comment)
```
    Sets the comment for the Asset.
    
    Parameters:
    
    comment - The comment for the Asset.
  - getComment
```
public String getComment()
```
    Get the comment for the Asset.
    
    Returns:
    
    The comment for the Asset.
  - setState
```
public void setState(int state)
```
    Sets the state for the Asset.
    
    Parameters:
    
    state - The state for the Asset.
  - getState
```
public int getState()
```
    Get the state for the Asset.
    
    Returns:
    
    The state for the Asset.
  - getActiveStartDate
```
public Date getActiveStartDate()
```
    Deprecated.
    
    Get the activation start date for the Asset.
    
    Returns:
    
    The activation start date for the Asset.
  - setActiveStartDate
```
public void setActiveStartDate(Date activeStartDate)
```
    Deprecated.
    
    Sets the activation start date for the Asset.
    
    Parameters:
    
    activeStartDate - The activation start date for the Asset.
  - getActiveEndDate
```
public Date getActiveEndDate()
```
    Deprecated.
    
    Get the activation end date for the Asset.
    
    Returns:
    
    The activation end date for the Asset.
  - setActiveEndDate
```
public void setActiveEndDate(Date activeEndDate)
```
    Deprecated.
    
    Sets the activation end date for the Asset.
    
    Parameters:
    
    activeEndDate - The activation end date for the Asset.
  - getLastUpdateDate
```
public Date getLastUpdateDate()
```
    Get the last update date of this Asset.
    
    Returns:
    
    the lastUpdateDate.
  - setLastUpdateDate
```
public void setLastUpdateDate(Date lastUpdateDate)
```
    Sets the last update date of this Asset.
    
    Parameters:
    
    lastUpdateDate - the lastUpdateDate to set.
  - getLastPublishDate
```
public Date getLastPublishDate()
```
    Get the last publish date of this Asset.
    
    Returns:
    
    the lastPublishDate.
  - setLastPublishDate
```
public void setLastPublishDate(Date lastPublishDate)
```
    Sets the last publish date of this Asset.
    
    Parameters:
    
    lastPublishDate - the lastPublishDate to set.
  - getUpdatedBy
```
public int getUpdatedBy()
```
  - setUpdatedBy
```
public void setUpdatedBy(int updatedBy)
```
  - getExtendedProperties
```
public Map<String,Object> getExtendedProperties()
```
    Get the extended properties for the Asset.
    
    Returns:
    
    The Map of extended properties for the Asset.
  - setExtendedProperties
```
public void setExtendedProperties(Map<String,Object> extendedProperties)
```
    Sets the extended properties for the Asset.
    
    Parameters:
    
    extendedProperties - The Map of extended properties for the Asset.
  - getLastChangeBy
```
public String getLastChangeBy()
```
    Get the user who last changed the Asset.
    
    Returns:
    
    The user who last changed the Asset.
  - setLastChangeBy
```
public void setLastChangeBy(String lastChangeBy)
```
    Sets the user who last changed the Asset.
    
    Parameters:
    
    lastChangeBy - The user who last changed the Asset.
  - getLocalizationPrefix
```
public String getLocalizationPrefix()
```
    The prefix that is appended to all the localizable properties of the this object while generating localization keys
    
    Specified by:
    
    getLocalizationPrefix in interface ILocalizable
    
    Returns:
    
    prefix
  - setLocalizationPrefix
```
public void setLocalizationPrefix(String prefix)
```
  - getLocalizationResourceInfoList
```
public List<LocalizationResourceInfo> getLocalizationResourceInfoList()
```
    gets the list containing localization data associated with this object
    
    Specified by:
    
    getLocalizationResourceInfoList in interface ILocalizationResourceContainer
    
    Returns:
    
    list containing LocalizationResourceInfo objects
  - setLocalizationResourceInfoList
```
public void setLocalizationResourceInfoList(List<LocalizationResourceInfo> localizationResourceInfoList)
```
    Sets the list of LocalizationResourceInfo on this object
    
    Specified by:
    
    setLocalizationResourceInfoList in interface ILocalizationResourceContainer
    
    Parameters:
    
    localizationResourceInfoList - list containing LocalizationResourceInfo objects
  - getTransientProperties
```
public Map<String,Object> getTransientProperties()
```
    Returns:
    
    Return the map of transient properties
  - setTransientProperties
```
public void setTransientProperties(Map<String,Object> transientProperties)
```
  - getTags
```
public String[] getTags()
```
  - setTags
```
public void setTags(String[] tags)
```
  - getLastReplicationAction
```
public String getLastReplicationAction()
```
  - setLastReplicationAction
```
public void setLastReplicationAction(String lastReplicationAction)
```
  - getLastVersionDate
```
public Calendar getLastVersionDate()
```
  - setLastVersionDate
```
public void setLastVersionDate(Calendar lastVersionDate)
```
  - setFolderId
```
public void setFolderId(String folderId)
```
    Sets the parent folder location for the Asset.
    
    Parameters:
    
    folderId - The parent folder location for the Asset.
  - getFolderId
```
public String getFolderId()
```
    Get the parent folder location for the Asset.
    
    Returns:
    
    The parent folder location for the Asset.
  - getLastPublishedBy
```
public String getLastPublishedBy()
```
    Get the user who last published the Asset.
    
    Returns:
    
    The user who last published the Asset.
  - setLastPublishedBy
```
public void setLastPublishedBy(String lastPublishedBy)
```
    Sets the user who last published the Asset.
    
    Parameters:
    
    lastPublishedBy - The user who last published the Asset.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class Asset

Field Summary

Constructor Summary

Method Summary

Field Detail

id

folderId

ASSET_CLASS

ASSOCIATION_CUTPOINT

FIRST_LEVEL_WITH_CAT_NAMES_CUTPOINT

HIERARCHY_CUTPOINT

FIRST_LEVEL_CUTPOINT

READY_TO_PUBLISH_CUTPOINT

PROPERTY_NAME_DESCRIPTION

PROPERTY_NAME_TITLE

PROPERTY_NAME_VERSION

name

title

desc

version

crxVersion

lastVersionDate

comment

state

activeStartDate

activeEndDate

lastUpdateDate

lastPublishDate

lastReplicationAction

lastPublishedBy

updatedBy

lastChangeBy

ucat

lcat

extendedProperties

transientProperties

tags

Constructor Detail

Asset

Asset

Method Detail

setId

getId

setLcat

setUcat

getLcat

getUcat

setName

getName

setTitle

getTitle

getDisplayField

setDesc

getDesc

setVersion

getVersion

getCrxVersion

setCrxVersion

setComment

getComment

setState

getState

getActiveStartDate

setActiveStartDate

getActiveEndDate

setActiveEndDate

getLastUpdateDate

setLastUpdateDate

getLastPublishDate

setLastPublishDate

getUpdatedBy

setUpdatedBy

getExtendedProperties

setExtendedProperties

getLastChangeBy

setLastChangeBy

getLocalizationPrefix

setLocalizationPrefix

getLocalizationResourceInfoList

setLocalizationResourceInfoList