Jive API (3.0.13) Core Javadocs

Uses of Class
com.jivesoftware.community.EntityDescriptor

Packages that use EntityDescriptor
com.jivesoftware.community Core interfaces and classes for Jive SBS. 
com.jivesoftware.community.event Provides mechanisms to be notified of actions in the system such as new messages being created. 
com.jivesoftware.community.impl.activity   
com.jivesoftware.community.search Search support classes for Jive SBS. 
 

Uses of EntityDescriptor in com.jivesoftware.community
 

Subclasses of EntityDescriptor in com.jivesoftware.community
 class ContainerAwareEntityDescriptor
          An entity descriptor that holds information about the container the entity belongs to (if any) at the time of creation.
 

Methods in com.jivesoftware.community that return EntityDescriptor
 EntityDescriptor ActivityEventHandlingStrategy.getActivityActor(BaseJiveEvent event)
          Returns an entity descriptor for the actor in the activity (eg. a user).
 EntityDescriptor ActivityEventHandlingStrategy.getActivityTargetContainer(BaseJiveEvent event)
          Returns an entity descriptor for the container of the object that the activity in the event payload targets.
 EntityDescriptor ActivityEventHandlingStrategy.getActivityTargetObject(BaseJiveEvent event)
          Returns an entity descriptor for the object that the activity in the event payload targets.
 EntityDescriptor SearchQueryResult.getEntityDescriptor()
          This method returns a EntityDescriptor that points to the object this query result pertains to.
 EntityDescriptor SearchQueryCriteria.getFilteredObject()
          Returns the container that query results are restricted to.
 EntityDescriptor RecentContentEventHandlingStrategy.getOldContainerDescriptor(BaseJiveEvent event)
          Returns an entity descriptor for the event payload's "old" container.
 EntityDescriptor CommentableTypeInfoProvider.getParentObject(CommentContentResource commentTarget)
          Get an entity descriptor indicating the comment target's parent's object type and object id.
 EntityDescriptor RecentContentEventHandlingStrategy.getTargetContainerDescriptor(BaseJiveEvent event)
          Returns an entity descriptor for the event payload's container.
 

Methods in com.jivesoftware.community that return types with arguments of type EntityDescriptor
 Map<EntityDescriptor,Long> StatusLevelCalculator.getAllPointLevels(User user)
          Returns the status level points for a user for all communities the user has points in
 List<EntityDescriptor> SearchQueryCriteria.getFilteredContainers()
          Returns the containers that query results are restricted to.
 List<EntityDescriptor> RecentContentInfoProvider.getRecentContentContainersForUser(User user)
          Returns the containers most recently chosen by the user for the creation of recent content for the type which owns this provider.
 

Methods in com.jivesoftware.community with parameters of type EntityDescriptor
 void ActivityManager.addActivity(EntityDescriptor object, EntityDescriptor parent, EntityDescriptor user, Activity.Type activityType)
          Adds a new activity to the ActivityManager
 JiveIterator<Announcement> AnnouncementManager.getAnnouncements(EntityDescriptor jiveContainer)
          Returns all currently viewable announcements in a container.
 QueryContainer RecentContentInfoProvider.getContentContainerInfoQuery(List<Long> objectIDs, EntityDescriptor container)
          Given a list of object ids, and the container housing them, this method returns a SQL query exposing the following colums:

objectID, containerType, containerID.

 JiveIterator<TagSet> TagSetManager.getTagSets(EntityDescriptor container)
          Returns all TagSets which are defined for the specified JiveContainer.
 boolean CommentableTypeInfoProvider.isCommentAttachedToCommentTarget(EntityDescriptor commentTarget, EntityDescriptor comment)
          Returns true if the comment is attached to the comment target.
 void DraftManager.moveDraftToContainer(EntityDescriptor destination, Draft draft)
          Moves the draft to the a different container.
 void TagManager.removeCommunityTags(EntityDescriptor user, EntityDescriptor object)
          Removes all community tags the given user has associated with the given JiveObject.
 void SearchQueryCriteria.setFilterOnContainers(EntityDescriptor... containers)
          Restricts the query results to content objects created inside a specific containers.
 void SearchQueryCriteria.setFilterOnObject(EntityDescriptor jiveObject)
          Restricts the query results to specific jiveobject.
 

Uses of EntityDescriptor in com.jivesoftware.community.event
 

Methods in com.jivesoftware.community.event that return EntityDescriptor
 EntityDescriptor AttachmentEvent.getAttachmentContentResource()
           
 EntityDescriptor CommentEvent.getCommentContentResource()
           
 EntityDescriptor CommentEvent.getContainer()
           
 EntityDescriptor PollEvent.getContainer()
           
 EntityDescriptor ProjectEvent.getContainer()
           
 EntityDescriptor CommunityEvent.getDestination()
           
 EntityDescriptor CommunityEvent.getDestinationParent()
           
 EntityDescriptor DocumentEvent.getJiveContainer()
           
 EntityDescriptor MessageEvent.getJiveContainer()
           
 EntityDescriptor PollEvent.getJiveContainer()
           
 EntityDescriptor TaskEvent.getJiveContainer()
           
 EntityDescriptor ThreadEvent.getJiveContainer()
           
 EntityDescriptor TrackbackEvent.getJiveContentObject()
           
 EntityDescriptor ImageEvent.getJiveObject()
           
 EntityDescriptor MessageEvent.getOldContainer()
           
 EntityDescriptor ThreadEvent.getOldContainer()
           
 EntityDescriptor MessageEvent.getOldThread()
           
 EntityDescriptor TagEvent.getOwner()
           
 EntityDescriptor TaskEvent.getOwner()
           
 EntityDescriptor BlogEvent.getParent()
           
 EntityDescriptor CommunityEvent.getParent()
           
 EntityDescriptor TagEvent.getParent()
           
 EntityDescriptor AttachmentEvent.getPayload()
           
 EntityDescriptor PollEvent.getUser()
           
 EntityDescriptor TaskEvent.getUser()
           
 

Constructors in com.jivesoftware.community.event with parameters of type EntityDescriptor
DocumentEvent(DocumentEvent.Type type, EntityDescriptor d, JiveContainer c)
           
MessageEvent(MessageEvent.Type eventType, EntityDescriptor message, JiveContainer container, Map<String,? extends Object> params)
          Creates a new message event.
SearchIndexEvent(SearchIndexEvent.Type eventType, EntityDescriptor jiveObject)
           
SearchIndexEvent(SearchIndexEvent.Type eventType, EntityDescriptor jiveObject, Map<String,? extends Object> params)
           
TagEvent(TagEvent.Type eventType, ContentTag tag, Map<String,Object> params, JiveObject parent, EntityDescriptor owner)
          Creates a new tag event.
 

Uses of EntityDescriptor in com.jivesoftware.community.impl.activity
 

Methods in com.jivesoftware.community.impl.activity that return EntityDescriptor
 EntityDescriptor DefaultContentActivityEventHandlingStrategy.getActivityActor(BaseJiveEvent event)
          Only ContentEvent events are supported.
 EntityDescriptor DefaultContentActivityEventHandlingStrategy.getActivityTargetContainer(BaseJiveEvent event)
          Only ContentEvent events are supported.
 EntityDescriptor DefaultContentActivityEventHandlingStrategy.getActivityTargetObject(BaseJiveEvent event)
          Only ContentEvent events are supported.
 

Uses of EntityDescriptor in com.jivesoftware.community.search
 

Methods in com.jivesoftware.community.search that return types with arguments of type EntityDescriptor
 List<EntityDescriptor> BaseIndexInfoProvider.getIDs(long minID, long maxID, Date minDate, Date maxDate)
           
 List<EntityDescriptor> IndexInfoProvider.getIDs(long minID, long maxID, Date minDate, Date maxDate)
          Returns a list of IDs where minID <= ID <= maxID and create/publish date was after min date
 


Jive Product Page

Copyright © 1999-2007 Jive Software.