public interface ActivityStreamingService
Modifier and Type | Method and Description |
---|---|
boolean |
canModerateActivities(oracle.webcenter.framework.service.Scope scope)
Decides if the current user can moderate activities in the passed scope.
|
boolean |
canViewActivities(oracle.webcenter.framework.service.Scope scope)
Decides if the current user can view activities in the passed scope.
|
ActivityElement |
createActivityElement(java.lang.String applicationID,
oracle.webcenter.framework.service.Scope scope,
java.lang.String serviceID,
oracle.webcenter.framework.service.ActivityType activityType,
java.util.List<? extends ActivityActor> actors,
java.util.List<? extends ActivityObject> objects,
ActivityPermission permission,
java.util.Date activityTime)
Create a new ActivityStreamingElement
|
ActivityElement |
createActivityElement(java.lang.String applicationID,
java.lang.String scopeGUID,
java.lang.String serviceID,
java.lang.String activityTypeID,
java.util.List<? extends ActivityActor> actors,
java.util.List<? extends ActivityObject> objects,
ActivityPermission permission,
java.util.Date activityTime) |
ActivityActor |
createActor(java.lang.String userGUID)
Create a new Actor
|
ActivityActor |
createActor(java.lang.String id,
boolean isGroup) |
ActivityActor |
createActorByName(java.lang.String userName) |
ActivityCustAttr |
createCustAttr(java.lang.String name,
java.lang.String value,
java.lang.String url)
Create Custom Attribute
|
DisplayOptions |
createDisplayOptions()
Create DisplayOptions
|
EvalQueryOptions |
createEvalQueryOptions(QueryOptions queryOptions)
Create EvalQueryOptions.
|
FilterOptions |
createFilterOptions()
Create FilterOptions
|
ActivityElement |
createGenericActivityElement(java.lang.String applicationID,
oracle.webcenter.framework.service.ActivityType activityType,
java.util.List<? extends ActivityActor> actors,
java.util.List<? extends ActivityObject> objects,
ActivityPermission permission,
java.util.Date activityTime)
Create a generic Activity Element.
|
ActivityObject |
createObject(java.lang.String objectID,
oracle.webcenter.framework.service.ServiceObjectType objectType,
java.lang.String displayName)
Create a new Object
|
ActivityObject |
createObject(java.lang.String objectID,
java.lang.String objectTypeID,
java.lang.String displayName) |
<T> QueryItem<T> |
createQueryItem(T value,
java.util.List<ActivityPermission> permissions)
Create QueryItem.
|
QueryOptions |
createQueryOptions(java.lang.String profileUserGUID)
Create QueryOptions
|
ServiceActivityType |
createServiceActivityType(java.lang.String serviceId,
oracle.webcenter.framework.service.ActivityType type)
Create ServiceActivityType
|
SummaryDisplayOptions |
createSummaryDisplayOptions()
Create SummaryDisplayOptions
|
void |
deleteActivities(ActivityObject activityObject)
Mark all activites for the given object as delete
|
ActivityDisplayElement |
findActivity(QueryOptions queryOptions,
java.lang.String activityId)
Find and return the
ActivityDisplayElement . |
oracle.webcenter.framework.service.ActivityType |
findActivityType(java.lang.String serviceId,
java.lang.String typeName)
Return the definition for the specified activity type for
the specified service.
|
oracle.webcenter.framework.service.ServiceObjectType |
findObjectType(java.lang.String serviceId,
java.lang.String typeName)
Return the definition for the specified object type for
the specified service.
|
oracle.webcenter.framework.service.Scope |
getActivityScope(ActivityObject object)
Returns the Scope of the Activity associated with the passed activity object.
|
java.util.List<java.lang.String> |
getActivityServiceIdPreferences(java.lang.String _strTaskflowInstanceID)
Return all service's IDs that have are configured to be displayed in the current context.
|
java.util.List<java.lang.String> |
getActivityServiceIds()
Return all service's IDs that have published activities to Activity Stream
|
ActorDetailsManager |
getActorDetailsManager()
Return activity stream data manager from the factory
|
oracle.webcenter.activitystreaming.ArchiveManager |
getArchiveManager()
Return a archive manager instance for archiving/restoring acvitiy stream data
|
FollowManager |
getFollowManager()
Returns a follow manager instance for performing follow/unfollow on
certain item and other follow-related actions
|
ObjectDetailsManager |
getObjectDetailsManager()
Returns an object details manager instance for retrieving detail
information about objects in WebCenter.
|
SecurityHandler |
getSecurityHandler()
Returns a security handler instance for checking objects security
|
oracle.webcenter.activitystreaming.SettingsManager |
getSettingsManager()
Return a settings manager instance for configure the activity stream admin settings
|
boolean |
isConfigured()
Return whether activity stream service is configured
|
void |
publish(ActivityElement activity)
Publish an activity
|
void |
publish(java.util.List<ActivityElement> activities)
Publish list of activities
|
void |
publishAnalyticsEvent(ActivityElement activity)
Generates an analytics event for the given activity and publishes that
event for collection by an analytics server.
|
java.util.List<ActivityDisplayElement> |
retrieve(java.lang.String applicationID,
QueryOptions queryOptions,
FilterOptions filterOptions,
DisplayOptions displayOptions)
Return activities that satisifes the passed in options
|
java.util.List<ActivityDisplayElement> |
retrieveSummaries(java.lang.String applicationID,
QueryOptions queryOptions,
FilterOptions filterOptions,
SummaryDisplayOptions displayOptions) |
void |
teardown()
Does cleanup for this service
this is normally called from the app shutdown context listener.
|
void |
touchActivity(java.lang.String activityId,
java.sql.Timestamp time)
Update an activity's timestamp to reflect recent activity
|
void publish(ActivityElement activity) throws ActivityException
activity
- the activity to be publishedActivityException
void publish(java.util.List<ActivityElement> activities) throws ActivityException
activities
- the activities to be publishedActivityException
java.util.List<ActivityDisplayElement> retrieve(java.lang.String applicationID, QueryOptions queryOptions, FilterOptions filterOptions, DisplayOptions displayOptions) throws ActivityException
applicationID
- queryOptions
- filterOptions
- displayOptions
- ActivityDisplayElement
.ActivityException
java.util.List<ActivityDisplayElement> retrieveSummaries(java.lang.String applicationID, QueryOptions queryOptions, FilterOptions filterOptions, SummaryDisplayOptions displayOptions) throws ActivityException
ActivityException
ActivityActor createActor(java.lang.String userGUID) throws ActivityException
userGUID
- the user GUIDActivityException
ActivityActor createActor(java.lang.String id, boolean isGroup) throws ActivityException
ActivityException
ActivityActor createActorByName(java.lang.String userName) throws ActivityException
ActivityException
ActivityObject createObject(java.lang.String objectID, oracle.webcenter.framework.service.ServiceObjectType objectType, java.lang.String displayName) throws ActivityException
objectID
- the ID of the objectobjectType
- the type of the objectActivityException
ActivityObject createObject(java.lang.String objectID, java.lang.String objectTypeID, java.lang.String displayName) throws ActivityException
ActivityException
ActivityElement createActivityElement(java.lang.String applicationID, oracle.webcenter.framework.service.Scope scope, java.lang.String serviceID, oracle.webcenter.framework.service.ActivityType activityType, java.util.List<? extends ActivityActor> actors, java.util.List<? extends ActivityObject> objects, ActivityPermission permission, java.util.Date activityTime) throws ActivityException
applicationID
- application ID of the activityscope
- the Scope of the activityserviceID
- the service ID of the activityactivityType
- type of the activityactors
- list of actors involved in the activity (there must be
at least one actor in the activity)objects
- list of objects involved in the activity (optional)permission
- the permission of the activityactivityTime
- time when the activity happensActivityException
ActivityElement createActivityElement(java.lang.String applicationID, java.lang.String scopeGUID, java.lang.String serviceID, java.lang.String activityTypeID, java.util.List<? extends ActivityActor> actors, java.util.List<? extends ActivityObject> objects, ActivityPermission permission, java.util.Date activityTime) throws ActivityException
ActivityException
ActivityCustAttr createCustAttr(java.lang.String name, java.lang.String value, java.lang.String url) throws ActivityException
name
- the name of the attributevalue
- the value of the attributeurl
- the url of the attributeActivityException
- if name or value is nulloracle.webcenter.framework.service.ActivityType findActivityType(java.lang.String serviceId, java.lang.String typeName) throws ActivityException
serviceId
- Service ID for which to look up object typetypeName
- Name of the activity type to look fornull
if none could be found.ActivityException
- If any problem occurs looking up the
activity type definition.oracle.webcenter.framework.service.ServiceObjectType findObjectType(java.lang.String serviceId, java.lang.String typeName) throws ActivityException
serviceId
- Service ID for which to look up object typetypeName
- Name of the object type to look fornull
if none could be found.ActivityException
- If any problem occurs looking up the
object type definition.java.util.List<java.lang.String> getActivityServiceIds()
java.util.List<java.lang.String> getActivityServiceIdPreferences(java.lang.String _strTaskflowInstanceID)
_strTaskflowInstanceID
- The ID of the current task flow. Optional.ActivityElement createGenericActivityElement(java.lang.String applicationID, oracle.webcenter.framework.service.ActivityType activityType, java.util.List<? extends ActivityActor> actors, java.util.List<? extends ActivityObject> objects, ActivityPermission permission, java.util.Date activityTime) throws ActivityException
applicationID
- activityType
- actors
- objects
- permission
- activityTime
- ActivityElement
ActivityException
<T> QueryItem<T> createQueryItem(T value, java.util.List<ActivityPermission> permissions) throws ActivityException
T
- any arbitrary typevalue
- the value of the QueryItempermissions
- a list of permissionQueryItem
.ActivityException
EvalQueryOptions createEvalQueryOptions(QueryOptions queryOptions) throws ActivityException
queryOptions
- EvalQueryOptions
.ActivityException
QueryOptions createQueryOptions(java.lang.String profileUserGUID) throws ActivityException
profileUserGUID
- the profile user whose activities to be displayedActivityException
FilterOptions createFilterOptions() throws ActivityException
ActivityException
ServiceActivityType createServiceActivityType(java.lang.String serviceId, oracle.webcenter.framework.service.ActivityType type) throws ActivityException
ActivityException
DisplayOptions createDisplayOptions() throws ActivityException
DisplayOptions
ActivityException
SummaryDisplayOptions createSummaryDisplayOptions() throws ActivityException
SummaryDisplayOptions
ActivityException
void publishAnalyticsEvent(ActivityElement activity) throws ActivityException
activity
- Activity Stream activity to generate analytics event forActivityException
- If any problem occurs generating an analytics
event for the given activity or while publishing that eventvoid teardown()
ActorDetailsManager getActorDetailsManager()
ObjectDetailsManager getObjectDetailsManager()
FollowManager getFollowManager()
SecurityHandler getSecurityHandler()
boolean isConfigured()
oracle.webcenter.activitystreaming.ArchiveManager getArchiveManager()
oracle.webcenter.activitystreaming.SettingsManager getSettingsManager()
void deleteActivities(ActivityObject activityObject) throws ActivityException
activityObject
- the activity object whose activites to be marked
as deletedActivityException
- If any problem occurs while remove activites.void touchActivity(java.lang.String activityId, java.sql.Timestamp time) throws ActivityException
activityId
- the id of the activity to updateActivityException
- If any problem occursActivityDisplayElement findActivity(QueryOptions queryOptions, java.lang.String activityId) throws ActivityException
ActivityDisplayElement
.activityId
- the id of the activity being retrieved.ActivityDisplayElement
.ActivityException
- If any problem occurs.oracle.webcenter.framework.service.Scope getActivityScope(ActivityObject object)
object
- the Activity objectboolean canViewActivities(oracle.webcenter.framework.service.Scope scope)
scope
- the passed Scopeboolean canModerateActivities(oracle.webcenter.framework.service.Scope scope)
scope
- the passed Scope