Class FindActivitiesRequest

  • All Implemented Interfaces:
    Serializable

    public class FindActivitiesRequest
    extends PagedRequest
    The search criteria for activities.

    Only parameters that are specified in this request and have not null values are used for filtering. All other parameters are ignored.

    The returned activities satisfy all constraints that are specified in this search criteria.

    By default a result containing 1000 activities is returned.

    See Also:
    Serialized Form
    • Constructor Detail

      • FindActivitiesRequest

        public FindActivitiesRequest()
    • Method Detail

      • getTaskId

        public UUID getTaskId()
        The ID of the task which contains the basic find activities request.
      • getContextId

        public UUID getContextId()
        The ID of the context which the activities should be searched for.
      • getInvolvedPeopleIds

        public Set<UUID> getInvolvedPeopleIds()
        The list of IDs of the people that should be involved in searched activities.
      • getInvolvedRoleIds

        public Set<UUID> getInvolvedRoleIds()
        The list of IDs of the roles that should be involved in searched activities.
      • getPerformedByUserId

        public UUID getPerformedByUserId()
        The ID of the user who performed searched activities.
      • getPerformedByRoleIds

        public Set<UUID> getPerformedByRoleIds()
        The list of IDs of the roles assigned to users who performed searched activities.
      • getActivityType

        public ActivityType getActivityType()
        The type of the activity.
      • getCallId

        public String getCallId()
        The ID of the call.
      • getCategories

        public Set<ActivityFilterCategory> getCategories()
        The set of the categories of activities that should be searched. One of [ATTRIBUTE, ATTACHMENT, RELATION, COMMENT, STATUS, WORKFLOW, RESPONSIBILITY, USER, USER_GROUP, ROLE, TAGS, OTHERS].
      • getResourceTypes

        public Set<ResourceType> getResourceTypes()
        The set of the resource types that searched activities refer to, i.e. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance].
      • getStartDate

        public Long getStartDate()
        The start date of the searched activities. It is the timestamp (in UTC time standard).
      • getEndDate

        public Long getEndDate()
        The end date of the searched activities. It is the timestamp (in UTC time standard).
      • isCallCountEnabled

        public boolean isCallCountEnabled()
        Flag to indicate if the number of calls standing behind the activity should be returned or not. Note that by default that count will be not calculated as it brings an important performance penalty.
      • setTaskId

        public void setTaskId​(UUID taskId)
        The ID of the task which contains the basic find activities request.
      • setContextId

        public void setContextId​(UUID contextId)
        The ID of the context which the activities should be searched for.
      • setInvolvedPeopleIds

        public void setInvolvedPeopleIds​(Set<UUID> involvedPeopleIds)
        The list of IDs of the people that should be involved in searched activities.
      • setInvolvedRoleIds

        public void setInvolvedRoleIds​(Set<UUID> involvedRoleIds)
        The list of IDs of the roles that should be involved in searched activities.
      • setPerformedByUserId

        public void setPerformedByUserId​(UUID performedByUserId)
        The ID of the user who performed searched activities.
      • setPerformedByRoleIds

        public void setPerformedByRoleIds​(Set<UUID> performedByRoleIds)
        The list of IDs of the roles assigned to users who performed searched activities.
      • setActivityType

        public void setActivityType​(ActivityType activityType)
        The type of the activity.
      • setCallId

        public void setCallId​(String callId)
        The ID of the call.
      • setCategories

        public void setCategories​(Set<ActivityFilterCategory> categories)
        The set of the categories of activities that should be searched. One of [ATTRIBUTE, ATTACHMENT, RELATION, COMMENT, STATUS, WORKFLOW, RESPONSIBILITY, USER, USER_GROUP, ROLE, TAGS, OTHERS].
      • setResourceTypes

        public void setResourceTypes​(Set<ResourceType> resourceTypes)
        The set of the resource types that searched activities refer to, i.e. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance].
      • setStartDate

        public void setStartDate​(Long startDate)
        The start date of the searched activities. It is the timestamp (in UTC time standard).
      • setEndDate

        public void setEndDate​(Long endDate)
        The end date of the searched activities. It is the timestamp (in UTC time standard).
      • setCallCountEnabled

        public void setCallCountEnabled​(boolean callCountEnabled)
        Flag to indicate if the number of calls standing behind the activity should be returned or not. Note that by default that count will be not calculated as it brings an important performance penalty.
      • canEqual

        protected boolean canEqual​(Object other)
        Overrides:
        canEqual in class PagedRequest