Package lumis.portal.activitystream

Interface ActivityDocument.IActivity

Enclosing class:

ActivityDocument

@StableMinor(version="17.0",
             sinceVersion="8.2")
public static interface ActivityDocument.IActivity

Contains data in an ActivityDocument that corresponds to an Activity.

Since:

8.2.0

Version:

$Revision$ $Date$

Method Summary

Modifier and Type	Method	Description
ActivityDocument.IActivityDocumentPriority	addPriority()	Adds a priority mapping to this document.
void	addScopes(java.lang.String... scopes)	Adds the values to the ActivityDocumentType.ActivityFields.SCOPES in this document.
void	addScopes(java.util.Collection<java.lang.String> scopes)	Adds the values to the ActivityDocumentType.ActivityFields.SCOPES in this document.
java.lang.String	getAction()	Returns the value of ActivityDocumentType.ActivityFields.ACTION stored in this document.
ActivityDocument.IActivityActor	getActor()	Returns the value of ActivityDocumentType.ActivityFields.ACTOR stored in this document.
long	getCreatedDateTimeMillis()	Returns the value of ActivityDocumentType.ActivityFields.CREATED_DATE_TIME_MILLIS stored in this document.
java.lang.String	getCustomData()	Returns the value of ActivityDocumentType.ActivityFields.CUSTOM_DATA stored in this document.
java.lang.String	getId()	Returns the value of ActivityDocumentType.ActivityFields.ID stored in this document.
ActivityDocument.IActivityObject	getObject()	Returns the value of ActivityDocumentType.ActivityFields.OBJECT stored in this document.
java.lang.String	getOriginServiceInstanceId()	Returns the value of ActivityDocumentType.ActivityFields.ORIGIN_SERVICE_INSTANCE_ID stored in this document.
java.util.Collection<ActivityDocument.IActivityDocumentPriority>	getPriorities()	Returns the priority mappings in this document.
java.util.List<java.lang.String>	getScopes()	Returns the list of ActivityDocumentType.ActivityFields.SCOPES stored in this document.
ActivityDocument.IActivityObject	getTarget()	Returns the value of ActivityDocumentType.ActivityFields.TARGET stored in this document.
void	setAction(java.lang.String action)	Sets the value for ActivityDocumentType.ActivityFields.ACTION in this document.
void	setCreatedDateTimeMillis(long createdDateTimeMillis)	Sets the value for ActivityDocumentType.ActivityFields.CREATED_DATE_TIME_MILLIS in this document.
void	setCustomData(java.lang.String customData)	Sets the value for ActivityDocumentType.ActivityFields.CUSTOM_DATA in this document.
void	setId(java.lang.String id)	Sets the value for ActivityDocumentType.ActivityFields.ID in this document.
java.lang.String	setOriginServiceInstanceId(java.lang.String createdDateTimeMillis)	Sets the value for ActivityDocumentType.ActivityFields.ORIGIN_SERVICE_INSTANCE_ID in this document.

Method Detail

getId

java.lang.String getId()

Returns the value of ActivityDocumentType.ActivityFields.ID stored in this document.

Returns:

the value of ActivityDocumentType.ActivityFields.ID.

Since:

8.2.0

See Also:

Activity.getId()

setId

void setId(java.lang.String id)

Sets the value for ActivityDocumentType.ActivityFields.ID in this document.

Parameters:

id - the value to set.

Since:

8.2.0

getOriginServiceInstanceId

java.lang.String getOriginServiceInstanceId()

Returns the value of ActivityDocumentType.ActivityFields.ORIGIN_SERVICE_INSTANCE_ID stored in this document.

Returns:

the value of ActivityDocumentType.ActivityFields.ORIGIN_SERVICE_INSTANCE_ID.

Since:

8.2.0

See Also:

Activity.getOriginServiceInstanceId()

setOriginServiceInstanceId

java.lang.String setOriginServiceInstanceId(java.lang.String createdDateTimeMillis)

Sets the value for ActivityDocumentType.ActivityFields.ORIGIN_SERVICE_INSTANCE_ID in this document.

Parameters:

createdDateTimeMillis - the value to set.

Since:

8.2.0

See Also:

Activity.setOriginServiceInstanceId(String)

getCreatedDateTimeMillis

long getCreatedDateTimeMillis()

Returns the value of ActivityDocumentType.ActivityFields.CREATED_DATE_TIME_MILLIS stored in this document.

Returns:

the value of ActivityDocumentType.ActivityFields.CREATED_DATE_TIME_MILLIS.

Since:

8.2.0

See Also:

Activity.getCreatedDateTimeMillis()

setCreatedDateTimeMillis

void setCreatedDateTimeMillis(long createdDateTimeMillis)

Sets the value for ActivityDocumentType.ActivityFields.CREATED_DATE_TIME_MILLIS in this document.

Parameters:

createdDateTimeMillis - the value to set.

Since:

8.2.0

See Also:

Activity.setCreatedDateTimeMillis(long)

getCustomData

java.lang.String getCustomData()

Returns the value of ActivityDocumentType.ActivityFields.CUSTOM_DATA stored in this document.

Returns:

the value of ActivityDocumentType.ActivityFields.CUSTOM_DATA.

Since:

8.2.0

See Also:

Activity.getCustomData()

setCustomData

void setCustomData(java.lang.String customData)

Sets the value for ActivityDocumentType.ActivityFields.CUSTOM_DATA in this document.

Parameters:

customData - the value to set.

Since:

8.2.0

See Also:

Activity.setCustomData(String)

getActor

ActivityDocument.IActivityActor getActor()

Returns the value of ActivityDocumentType.ActivityFields.ACTOR stored in this document.

Returns:

the value of ActivityDocumentType.ActivityFields.ACTOR.

Since:

8.2.0

See Also:

Activity.getActor()

getAction

java.lang.String getAction()

Returns the value of ActivityDocumentType.ActivityFields.ACTION stored in this document.

Returns:

the value of ActivityDocumentType.ActivityFields.ACTION.

Since:

8.2.0

See Also:

Activity.getAction()

setAction

void setAction(java.lang.String action)

Sets the value for ActivityDocumentType.ActivityFields.ACTION in this document.

Parameters:

action - the value to set.

Since:

8.2.0

See Also:

Activity.setAction(ActivityAction)

getObject

ActivityDocument.IActivityObject getObject()

Returns the value of ActivityDocumentType.ActivityFields.OBJECT stored in this document.

Returns:

the value of ActivityDocumentType.ActivityFields.OBJECT.

Since:

8.2.0

See Also:

Activity.getObject()

getTarget

ActivityDocument.IActivityObject getTarget()

Returns the value of ActivityDocumentType.ActivityFields.TARGET stored in this document.

Returns:

the value of ActivityDocumentType.ActivityFields.TARGET.

Since:

8.2.0

getScopes

java.util.List<java.lang.String> getScopes()

Returns the list of ActivityDocumentType.ActivityFields.SCOPES stored in this document.

Returns:

the value of ActivityDocumentType.ActivityFields.SCOPES.

Since:

8.2.0

See Also:

Activity.getScopes()

addScopes

void addScopes(java.lang.String... scopes)

Adds the values to the ActivityDocumentType.ActivityFields.SCOPES in this document.

Parameters:

scopes - the values to set.

Since:

8.2.0

addScopes

void addScopes(java.util.Collection<java.lang.String> scopes)

Adds the values to the ActivityDocumentType.ActivityFields.SCOPES in this document.

Parameters:

scopes - the values to set.

Since:

8.2.0

getPriorities

java.util.Collection<ActivityDocument.IActivityDocumentPriority> getPriorities()

Returns the priority mappings in this document.

Returns:

the priority mappings.

Since:

8.2.0

addPriority

ActivityDocument.IActivityDocumentPriority addPriority()

Adds a priority mapping to this document.

Returns:

the priority mapping.

Since:

8.2.0