com.ibm.ram.common.data
Class AssetInformation

java.lang.Object
  extended by com.ibm.ram.common.data.AssetInformation
Direct Known Subclasses:
Asset

public class AssetInformation
extends java.lang.Object

Returns information about an asset

Since:
7.1

Constructor Summary
AssetInformation()
          Constructor
 
Method Summary
 double getAverageRating()
           
 java.lang.String getCommunityName()
           
 java.lang.String getGUID()
          Deprecated. use AssetInformation#getIdentification()#getGUID()
 AssetIdentification getIdentification()
          The unique identifier for this asset.
 long getLastModified()
           
 AssetIdentification getMainAssetId()
          If this is a pending Asset, a revision of an approved asset that is in draft or under review, this method will return the identification of the main asset.
 int getManagementStyle()
           
 java.lang.String getName()
           
 AssetIdentification getPendingAssetId()
          If there is a pending revision of this Asset (one under review or a draft) this method will return the AssetIdentifcation of that pending asset.
 java.lang.String getShortDescription()
           
 int getStateID()
           
 java.lang.String getStateName()
           
 java.lang.String getTypeName()
           
 java.lang.String getVersion()
          Deprecated. use AssetInformation#getIdentification()#getVersion()
 void setAverageRating(double averageRating)
           
 void setCommunityName(java.lang.String groupName)
           
 void setGUID(java.lang.String id)
          Deprecated. use AssetInformation#getIdentification()#setGUID(String)
 void setIdentification(AssetIdentification identification)
          Set the unique identifier for this asset.
 void setLastModified(long lastModified)
           
 void setMainAssetId(AssetIdentification mainAsset)
          Set the Main Asset's Identification.
 void setManagementStyle(int managementStyle)
           
 void setName(java.lang.String name)
           
 void setPendingAssetId(AssetIdentification pendingAsset)
          Set the Pending Asset's Identification.
 void setShortDescription(java.lang.String shortDescription)
           
 void setStateID(int stateID)
           
 void setStateName(java.lang.String stateName)
           
 void setTypeName(java.lang.String typeName)
           
 void setVersion(java.lang.String version)
          Deprecated. use AssetInformation#getIdentification()#setVersion(String)
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AssetInformation

public AssetInformation()
Constructor

Since:
7.1
Method Detail

getIdentification

public AssetIdentification getIdentification()
The unique identifier for this asset. This includes the GUID, version and if it is the main or pending asset.

Returns:
Since:
7.1.1

setIdentification

public void setIdentification(AssetIdentification identification)
Set the unique identifier for this asset. This includes the GUID, version and if it is the main or pending asset.

Since:
7.1.1

getCommunityName

public java.lang.String getCommunityName()
Returns:
the name of the community this asset belongs to
Since:
7.1

setCommunityName

public void setCommunityName(java.lang.String groupName)
Parameters:
the - name of this asset's community.
Since:
7.1

getGUID

public java.lang.String getGUID()
Deprecated. use AssetInformation#getIdentification()#getGUID()

Returns:
the unique id for this asset.
Since:
7.1

setGUID

public void setGUID(java.lang.String id)
Deprecated. use AssetInformation#getIdentification()#setGUID(String)

Parameters:
the - unique id for this asset.
Since:
7.1

getLastModified

public long getLastModified()
Returns:
the date of the last modification to this asset.
Since:
7.1

setLastModified

public void setLastModified(long lastModified)
Parameters:
last - date this asset was modified.
Since:
7.1

getName

public java.lang.String getName()
Returns:
the name of this asset.
Since:
7.1

setName

public void setName(java.lang.String name)
Parameters:
name - the name of the asset.
Since:
7.1

getShortDescription

public java.lang.String getShortDescription()
Returns:
a short ddescription of this asset.
Since:
7.1

setShortDescription

public void setShortDescription(java.lang.String shortDescription)
Parameters:
shortDescription - a short description of this asset.
Since:
7.1

getStateName

public java.lang.String getStateName()
Returns:
the name of an asset's state.
Since:
7.1

setStateName

public void setStateName(java.lang.String stateName)
Parameters:
stateName - the name of the state this asset is in.
Since:
7.1

getVersion

public java.lang.String getVersion()
Deprecated. use AssetInformation#getIdentification()#getVersion()

Returns:
the version of this asset.
Since:
7.1

setVersion

public void setVersion(java.lang.String version)
Deprecated. use AssetInformation#getIdentification()#setVersion(String)

Parameters:
version - the version of this asset.
Since:
7.1

getPendingAssetId

public AssetIdentification getPendingAssetId()
If there is a pending revision of this Asset (one under review or a draft) this method will return the AssetIdentifcation of that pending asset. Otherwise this method will return null.

Since:
7.1.1

setPendingAssetId

public void setPendingAssetId(AssetIdentification pendingAsset)
Set the Pending Asset's Identification. A pending asset is a revision of this asset that is in draft or under review.

Parameters:
pendingAsset -
Since:
7.1.1

getMainAssetId

public AssetIdentification getMainAssetId()
If this is a pending Asset, a revision of an approved asset that is in draft or under review, this method will return the identification of the main asset. Otherwise this method will return null.

Since:
7.1.1

setMainAssetId

public void setMainAssetId(AssetIdentification mainAsset)
Set the Main Asset's Identification. A main asset is a revision of this asset that has been approved with this asset is reviewed or in draft.

Since:
7.1.1

getAverageRating

public double getAverageRating()
Returns:
Returns the averageRating.
Since:
7.1

setAverageRating

public void setAverageRating(double averageRating)
Parameters:
averageRating - The averageRating to set.
Since:
7.1

getStateID

public int getStateID()
Returns:
Returns the database id of an asset's state.
Since:
7.1

setStateID

public void setStateID(int stateID)
Parameters:
stateID - The stateID to set.
Since:
7.1

getTypeName

public java.lang.String getTypeName()
Returns:
Returns the name of this asset's type.
Since:
7.1

setTypeName

public void setTypeName(java.lang.String typeName)
Parameters:
type - The name of an Asset Type to apply to this asset.
Since:
7.1

getManagementStyle

public int getManagementStyle()
Returns:
Returns the managementStyle.
Since:
7.1

setManagementStyle

public void setManagementStyle(int managementStyle)
Parameters:
managementStyle - The managementStyle to set.
Since:
7.1

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object