com.ibm.ram.common.data
Class Activity

java.lang.Object
  extended by com.ibm.ram.common.data.Activity
Direct Known Subclasses:
AssetActivity

public class Activity
extends java.lang.Object

Represents events that occur in the system, such as creating, modifying, or downloading assets

Since:
7.1
See Also:
for activities specific to an Asset

Constructor Summary
Activity()
           
 
Method Summary
 long getActivityId()
          Every activity instance has a unique database id.
 java.lang.String getName()
          The name of a activity refers to the name of the activity type.
 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 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
 

Constructor Detail

Activity

public Activity()
Method Detail

getTypeId

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

Returns:
Returns the activity type id
Since:
7.1

setTypeId

public void setTypeId(int typeId)
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

Parameters:
typeId - The typeId to set.
Since:
7.1
See Also:
AssetActivity, CustomAssetActivity

getName

public java.lang.String getName()
The name of a activity refers to the name of the activity type.

Returns:
The name of the activity type
Since:
7.1

setName

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

Parameters:
name -
Since:
7.1

getTarget

public java.lang.String getTarget()
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.

Returns:
The display name of the Object this activity applies to
Since:
7.1

setTarget

public void setTarget(java.lang.String target)
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.

Parameters:
target -
Since:
7.1

getTimestamp

public long getTimestamp()
Every activity has a timestamp as to when the activity occurred. This method returns that timestamp in long format.

Returns:
The time this activity took place
Since:
7.1

setTimestamp

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

Parameters:
timestamp -
Since:
7.1

getTargetURL

public java.lang.String getTargetURL()
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.

Returns:
The display name of the Object this activity applies to
Since:
7.1

setTargetURL

public void setTargetURL(java.lang.String url)
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.

Parameters:
target -
Since:
7.1

getUser

public UserInformation getUser()
Each activity records the user who performed the activity. This method return that user

Returns:
The User who performed this activity
Since:
7.1

setUser

public void setUser(UserInformation user)
Each activity records the user who performed the activity. In most cases the user is only settable by the server.

Parameters:
user - The user who performed this activity
Since:
7.1

getActivityId

public long getActivityId()
Every activity instance has a unique database id. This method returns this id.

Returns:
the activities unique database id.
Since:
7.1

setActivityId

public void setActivityId(long activityId)
Every activity instance has a unique database id. The id is only settable by the server.

Parameters:
activityId - the activities unique database id.
Since:
7.1