com.ibm.ram.client
Class RAMAssetActivity

java.lang.Object
  extended by com.ibm.ram.common.data.Activity
      extended by com.ibm.ram.common.data.AssetActivity
          extended by com.ibm.ram.client.RAMAssetActivity

public class RAMAssetActivity
extends AssetActivity

Represents an asset activity, which is recorded when an asset is modified in any way.

Since:
7.1
Author:
kbauer

Nested Class Summary
 class RAMAssetActivity.RawData
          Raw metric data when retrieved from the server
 
Method Summary
 long getActivityId()
          Every activity instance has a unique database id.
 java.lang.String getAssetGUID()
           
 java.lang.String getAssetName()
           
 java.lang.String getAssetVersion()
           
 java.lang.String getName()
          The name of a activity refers to the name of the activity type.
 RAMAsset getRAMAsset()
          Return the Asset this Activity was recorded on.
 RAMAssetActivity.RawData getRawData()
          Return the raw database metric data for the activity when retrieved from the server
 java.lang.String getTarget()
          Each activity has a target object in RAM.
 java.lang.String getTargetURL()
          Each activity has a target object in RAM.
 long getTimestamp()
          Every activity has a timestamp as to when the activity occurred.
 int getTypeId()
          Each activity type has an id.
 UserInformation getUser()
          Each activity records the user who performed the activity.
 void setActivityId(long activityId)
          Every activity instance has a unique database id.
 void setAssetGUID(java.lang.String assetGuid)
           
 void setAssetName(java.lang.String assetName)
           
 void setAssetVersion(java.lang.String assetVersion)
           
 void setName(java.lang.String name)
          The name of a activity refers to the name of the activity type.
 void setTarget(java.lang.String target)
          Each activity has a target object in RAM.
 void setTargetURL(java.lang.String url)
          Each activity has a target object in RAM.
 void setTimestamp(long timestamp)
          Every activity has a timestamp as to when the activity occurred.
 void setTypeId(int typeId)
          Each activity type has an id.
 void setUser(UserInformation user)
          Each activity records the user who performed the activity.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getRAMAsset

public RAMAsset getRAMAsset()
Return the Asset this Activity was recorded on.

Returns:
the asset
Since:
7.1

getAssetGUID

public java.lang.String getAssetGUID()
Overrides:
getAssetGUID in class AssetActivity
Returns:
Returns the assetGuid.

getAssetName

public java.lang.String getAssetName()
Overrides:
getAssetName in class AssetActivity
Returns:
Returns the assetName.

getAssetVersion

public java.lang.String getAssetVersion()
Overrides:
getAssetVersion in class AssetActivity
Returns:
Returns the assetVersion.

setAssetGUID

public void setAssetGUID(java.lang.String assetGuid)
Overrides:
setAssetGUID in class AssetActivity
Parameters:
assetGuid - The assetGuid to set.

setAssetName

public void setAssetName(java.lang.String assetName)
Overrides:
setAssetName in class AssetActivity
Parameters:
assetName - The assetName to set.

setAssetVersion

public void setAssetVersion(java.lang.String assetVersion)
Overrides:
setAssetVersion in class AssetActivity
Parameters:
assetVersion - The assetVersion to set.

getActivityId

public long getActivityId()
Description copied from class: Activity
Every activity instance has a unique database id. This method returns this id.

Overrides:
getActivityId in class Activity
Returns:
the activities unique database id.

getName

public java.lang.String getName()
Description copied from class: Activity
The name of a activity refers to the name of the activity type.

Overrides:
getName in class Activity
Returns:
The name of the activity type

getTarget

public java.lang.String getTarget()
Description copied from class: Activity
Each activity has a target object in RAM. This method returns a printable String representing name of the object. i.e. AssetActivities target will be the name and version of the asset.

Overrides:
getTarget in class Activity
Returns:
The display name of the Object this activity applies to

getTargetURL

public java.lang.String getTargetURL()
Description copied from class: Activity
Each activity has a target object in RAM. This method returns a String representing URL of the object. i.e. AssetActivities target will be the URL to the asset details on the web.

Overrides:
getTargetURL in class Activity
Returns:
The display name of the Object this activity applies to

getTimestamp

public long getTimestamp()
Description copied from class: Activity
Every activity has a timestamp as to when the activity occurred. This method returns that timestamp in long format.

Overrides:
getTimestamp in class Activity
Returns:
The time this activity took place

getTypeId

public int getTypeId()
Description copied from class: Activity
Each activity type has an id. This method returns the id for this Activity instance. These constants can be found in CommonConstants

Overrides:
getTypeId in class Activity
Returns:
Returns the activity type id

getUser

public UserInformation getUser()
Description copied from class: Activity
Each activity records the user who performed the activity. This method return that user

Overrides:
getUser in class Activity
Returns:
The User who performed this activity

setActivityId

public void setActivityId(long activityId)
Description copied from class: Activity
Every activity instance has a unique database id. The id is only settable by the server.

Overrides:
setActivityId in class Activity
Parameters:
activityId - the activities unique database id.

setName

public void setName(java.lang.String name)
Description copied from class: Activity
The name of a activity refers to the name of the activity type. Activity names are only settable by the server.

Overrides:
setName in class Activity

setTarget

public void setTarget(java.lang.String target)
Description copied from class: Activity
Each activity has a target object in RAM. i.e. AssetActivities target will be the name and version of the asset. The target is only settable by the server.

Overrides:
setTarget in class Activity

setTargetURL

public void setTargetURL(java.lang.String url)
Description copied from class: Activity
Each activity has a target object in RAM. This method returns a String representing URL of the object. The target URL is only settable by the server.

Overrides:
setTargetURL in class Activity

setTimestamp

public void setTimestamp(long timestamp)
Description copied from class: Activity
Every activity has a timestamp as to when the activity occurred. In most cases only the server may set this timestamp.

Overrides:
setTimestamp in class Activity

setTypeId

public void setTypeId(int typeId)
Description copied from class: Activity
Each activity type has an id. This method sets the id for this Activity instance. These constants can be found in CommonConstants Most activities are only settable by the server

Overrides:
setTypeId in class Activity
Parameters:
typeId - The typeId to set.
See Also:
AssetActivity, CustomAssetActivity

setUser

public void setUser(UserInformation user)
Description copied from class: Activity
Each activity records the user who performed the activity. In most cases the user is only settable by the server.

Overrides:
setUser in class Activity
Parameters:
user - The user who performed this activity

getRawData

public RAMAssetActivity.RawData getRawData()
Return the raw database metric data for the activity when retrieved from the server

Since:
7.5