Skip navigation links

oracle.webcenter.activitystreaming
Interface ActivityElement

All Known Subinterfaces:

ActivityDisplayElement, SummaryActivityDisplayElement

public interface ActivityElement

ActivityStreamingElement represents an activity record.

Nested Class Summary

static class

ActivityElement.State

Method Summary

void	addCustAttr(ActivityCustAttr custAttr) Add custom attribute to this Activity Element
java.lang.String	getActivityID() Returns the activity's ID
java.util.Date	getActivityTime() Return the create date of this activity
oracle.webcenter.framework.service.ActivityType	getActivityType() Return the activity type
java.util.List<ActivityActor>	getActors() Return all Actors for this ActivityStreamingElement
java.lang.String	getApplicationId() Return the application id
java.lang.String	getCreatedBy() Returns the activity's created by
java.util.Date	getCreatedOn() Returns the activity's created on
ActivityCustAttr	getCustAttr(java.lang.String name) Return custom attribute with the specified name
java.util.Collection<ActivityCustAttr>	getCustAttrs() Return all custom attributes associated with this Activity Element
java.lang.String	getDescription() Return the display description of the activity
java.lang.String	getDetail() Return the activity's details
java.lang.String	getDetailURL() Return the detail url
java.lang.String	getMessage() Return the display message of this Activity
java.util.List<ActivityObject>	getObjects() Return all Objects for this ActivityStreamingElement
ActivityPermission	getPermission() Returns the permission for this activity
oracle.webcenter.framework.service.Scope	getScope() Return the scope of this activity
java.lang.String	getServiceId() Returns the ActivityStreamElement's serviceId.
void	setDetail(java.lang.String detail) Set the activity's details
void	setDetailURL(java.lang.String detailURL) Set detail URL of the activity
void	setState(ActivityElement.State state) Set the activity's state

Method Detail

getServiceId

java.lang.String getServiceId()

Returns the ActivityStreamElement's serviceId. The serviceId is the ID of application or service that generates the activity record.

Returns:

the ActivityStreamElement's serviceId

getActors

java.util.List<ActivityActor> getActors()

Return all Actors for this ActivityStreamingElement

Returns:

a collection of Actors

getObjects

java.util.List<ActivityObject> getObjects()

Return all Objects for this ActivityStreamingElement

Returns:

a collection of Objects

getActivityTime

java.util.Date getActivityTime()

Return the create date of this activity

Returns:

the time that the activity happened.

getMessage

java.lang.String getMessage()

Return the display message of this Activity

Returns:

the display message

getPermission

ActivityPermission getPermission()

Returns the permission for this activity

Returns:

the permission for this activity

getDescription

java.lang.String getDescription()

Return the display description of the activity

Returns:

the display description of the activity

getApplicationId

java.lang.String getApplicationId()

Return the application id

getScope

oracle.webcenter.framework.service.Scope getScope()

Return the scope of this activity

getActivityType

oracle.webcenter.framework.service.ActivityType getActivityType()
                                                                throws ActivityException

Return the activity type

Returns:

the activity type

Throws:

ActivityException - If any error occurs determining the activity type

getDetailURL

java.lang.String getDetailURL()

Return the detail url

Returns:

the detail url

setDetailURL

void setDetailURL(java.lang.String detailURL)

Set detail URL of the activity

Parameters:

detailURL - the detail url to be set

getCreatedOn

java.util.Date getCreatedOn()

Returns the activity's created on

Returns:

the activity's created on

getCreatedBy

java.lang.String getCreatedBy()

Returns the activity's created by

Returns:

the activity's created by

setDetail

void setDetail(java.lang.String detail)

Set the activity's details

getDetail

java.lang.String getDetail()

Return the activity's details

Returns:

the activity's detail

getActivityID

java.lang.String getActivityID()

Returns the activity's ID

Returns:

the activity's ID

addCustAttr

void addCustAttr(ActivityCustAttr custAttr)

Add custom attribute to this Activity Element

Parameters:

custAttr - the new custom attribute

getCustAttrs

java.util.Collection<ActivityCustAttr> getCustAttrs()

Return all custom attributes associated with this Activity Element

Returns:

a collection of Custom Attributes

getCustAttr

ActivityCustAttr getCustAttr(java.lang.String name)

Return custom attribute with the specified name

Parameters:

name - the name of custom attribute

Returns:

the custom attribute with the specified name

setState

void setState(ActivityElement.State state)

Set the activity's state

Parameters:

state - The activity state ActivityStreamConst

Skip navigation links