Package com.polarion.alm.tracker.activity

Interface IActivityStreamService

public interface IActivityStreamService

Since:

3.6.0

Author:

Miroslav Ruza

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INDEX_CUSTOM_FIELD_PREFIX
static final String	INDEX_FIELD_ACTIVITY_ID
static final String	INDEX_FIELD_CONTEXT_ID
static final String	INDEX_FIELD_DOCUMENT_ID
static final String	INDEX_FIELD_FIELDS	Activity index field that contains ids of all non-empty index fields.
static final String	INDEX_FIELD_INFO
static final String	INDEX_FIELD_INFO_STORED
static final String	INDEX_FIELD_LOCATION
static final String	INDEX_FIELD_LOCATION_TREE
static final String	INDEX_FIELD_PROJECT
static final String	INDEX_FIELD_RESOURCE_LOCATIONS_STORED
static final String	INDEX_FIELD_RESOURCE_LOCATIONS_TREE
static final String	INDEX_FIELD_SOURCE_ID
static final String	INDEX_FIELD_TIMESTAMP
static final String	INDEX_FIELD_TIMESTAMP_CLEANING
static final String	INDEX_FIELD_TIMESTAMP_SORTING
static final String	INDEX_FIELD_TIMESTAMP_STORED
static final String	INDEX_FIELD_TYPE
static final String	INDEX_FIELD_USER
static final String	INDEX_FIELD_USER_STORED

Method Summary

Modifier and Type	Method	Description
void	addComment(String globalId, Text commentText)
boolean	canComment(String globalId)
boolean	canCurrentUserAddComment(String globalId)
void	cleanUp()
Activity	getActivity(String globalId)
IActivitySource	getActivitySource(String sourceId)
List<IActivitySource>	getActivitySources()
UserAndProjectResolver	getUserAndProjectResolver()
List<Activity>	listActivities(IContextId contextId, String query, int count)
List<Activity>	listProjectActivities(String projectId, String query, int count)
void	publishActivities(List<Activity> activities)
void	publishActivity(Activity activity)
void	registerSource(IActivitySource source)
void	updateActivity(String globalId)	Used by source to inform this service that the activity was updated, so it needs to be re-indexed.

Field Details

INDEX_FIELD_FIELDS

static final String INDEX_FIELD_FIELDS

Activity index field that contains ids of all non-empty index fields. Custom values are prefixed with "_". Example queries: HAS_VALUE:type, HAS_VALUE:_myCustomValue

See Also:

• Constant Field Values

INDEX_FIELD_DOCUMENT_ID

static final String INDEX_FIELD_DOCUMENT_ID

See Also:

• Constant Field Values

INDEX_FIELD_SOURCE_ID

static final String INDEX_FIELD_SOURCE_ID

See Also:

• Constant Field Values

INDEX_FIELD_ACTIVITY_ID

static final String INDEX_FIELD_ACTIVITY_ID

See Also:

• Constant Field Values

INDEX_FIELD_CONTEXT_ID

static final String INDEX_FIELD_CONTEXT_ID

See Also:

• Constant Field Values

INDEX_FIELD_LOCATION

static final String INDEX_FIELD_LOCATION

See Also:

• Constant Field Values

INDEX_FIELD_LOCATION_TREE

static final String INDEX_FIELD_LOCATION_TREE

See Also:

• Constant Field Values

INDEX_FIELD_PROJECT

static final String INDEX_FIELD_PROJECT

See Also:

• Constant Field Values

INDEX_FIELD_TYPE

static final String INDEX_FIELD_TYPE

See Also:

• Constant Field Values

INDEX_FIELD_INFO

static final String INDEX_FIELD_INFO

See Also:

• Constant Field Values

INDEX_FIELD_INFO_STORED

static final String INDEX_FIELD_INFO_STORED

See Also:

• Constant Field Values

INDEX_FIELD_TIMESTAMP

static final String INDEX_FIELD_TIMESTAMP

See Also:

• Constant Field Values

INDEX_FIELD_TIMESTAMP_CLEANING

static final String INDEX_FIELD_TIMESTAMP_CLEANING

See Also:

• Constant Field Values

INDEX_FIELD_TIMESTAMP_SORTING

static final String INDEX_FIELD_TIMESTAMP_SORTING

See Also:

• Constant Field Values

INDEX_FIELD_TIMESTAMP_STORED

static final String INDEX_FIELD_TIMESTAMP_STORED

See Also:

• Constant Field Values

INDEX_FIELD_USER

static final String INDEX_FIELD_USER

See Also:

• Constant Field Values

INDEX_FIELD_USER_STORED

static final String INDEX_FIELD_USER_STORED

See Also:

• Constant Field Values

INDEX_FIELD_RESOURCE_LOCATIONS_TREE

static final String INDEX_FIELD_RESOURCE_LOCATIONS_TREE

See Also:

• Constant Field Values

INDEX_FIELD_RESOURCE_LOCATIONS_STORED

static final String INDEX_FIELD_RESOURCE_LOCATIONS_STORED

See Also:

• Constant Field Values

INDEX_CUSTOM_FIELD_PREFIX

static final String INDEX_CUSTOM_FIELD_PREFIX

See Also:

• Constant Field Values

Method Details

registerSource

void registerSource(IActivitySource source)

listActivities

List<Activity> listActivities(IContextId contextId,
 String query,
 int count)

Parameters:

contextId - - can be null - null means all contexts. Can be also project context.

query - - can be null

count -

listProjectActivities

List<Activity> listProjectActivities(String projectId,
 String query,
 int count)

Parameters:

projectId - - can not be null

query - - can be null

count -

getActivity

Activity getActivity(String globalId)

publishActivity

void publishActivity(Activity activity)

publishActivities

void publishActivities(List<Activity> activities)

updateActivity

void updateActivity(String globalId)

Used by source to inform this service that the activity was updated, so it needs to be re-indexed.

Parameters:

globalId -

canCurrentUserAddComment

boolean canCurrentUserAddComment(String globalId)

canComment

boolean canComment(String globalId)

addComment

void addComment(String globalId,
 Text commentText)

getUserAndProjectResolver

UserAndProjectResolver getUserAndProjectResolver()

cleanUp

void cleanUp()

getActivitySource

IActivitySource getActivitySource(String sourceId)

getActivitySources

List<IActivitySource> getActivitySources()