Clearspace API (1.10.16) Core Javadocs

com.jivesoftware.community
Interface LinkManager

All Superinterfaces:
JiveManager

public interface LinkManager
extends JiveManager

Manages links between objects in the system. The various types of links that are possible are defined by the Link.LinkType enum.

See Also:
Link, JiveContentObject

Method Summary
 JiveIterator<JiveContentObject> getLinkingObjects(JiveObject targetContentObject)
          Returns a list of unique JiveContentObjects which link to the supplied target JiveContentObject.
 java.util.List<com.jivesoftware.community.renderer.filter.wiki.link.Link> getLinks(JiveObject sourceJiveObject)
          Retrieve all the links in a particular jive object (With the exception of internal anchor links).
 void updateLinks(JiveObject sourceJiveObject, java.util.List<com.jivesoftware.community.renderer.filter.wiki.link.Link> links)
          Updates all stored link for the provided source object.
 
Methods inherited from interface com.jivesoftware.community.JiveManager
destroy, initialize
 

Method Detail

updateLinks

void updateLinks(JiveObject sourceJiveObject,
                 java.util.List<com.jivesoftware.community.renderer.filter.wiki.link.Link> links)
Updates all stored link for the provided source object.

Parameters:
sourceJiveObject - the object to update links for
links - the list of links for the source object

getLinks

java.util.List<com.jivesoftware.community.renderer.filter.wiki.link.Link> getLinks(JiveObject sourceJiveObject)
Retrieve all the links in a particular jive object (With the exception of internal anchor links). The links returned by this method may not be unique.

Parameters:
sourceJiveObject - the object to retrieve all the links for
Returns:
all the links in the source object

getLinkingObjects

JiveIterator<JiveContentObject> getLinkingObjects(JiveObject targetContentObject)
Returns a list of unique JiveContentObjects which link to the supplied target JiveContentObject.

Parameters:
targetContentObject - the object to return linking objects for
Returns:
a list of JiveContentObjects for objects linking to the particular object

Clearspace Project Page

Copyright © 1999-2007 Jive Software.