com.jivesoftware.community.webservices
Interface ReferenceService

public interface ReferenceService

Manager used to create references between different kind of jive objects.

References are use to create a relationship between one kind of jive object to another. For instance a blog may reference a specific thread.

Since:

2.0

Method Summary

void	addReference(WSJiveObject referer, WSJiveObject reference) Creates a reference between the refering object and the references.
void	deleteAllReferences(int refererObjectType, long refererObjectID) Removes all references from the specified referer.
void	deleteAllReferers(int referenceObjectType, long referenceObjectID) Causes this object to not be referred by any other objects.
void	deleteReference(int refererObjectType, long refererObjectID, int referenceObjectType, long referenceObjectID) Delete the reference between a referer and the refered content.
java.util.List<WSJiveObject>	getReferences(int refererObjectType, long refererObjectID) Get all objects that the specfied jiveObject referers too.
java.util.List<WSJiveObject>	getReferers(int referenceObjectType, long referenceObjectID) Get a list of all the objects that refer to this specified object.

Method Detail

addReference

void addReference(WSJiveObject referer,
                  WSJiveObject reference)

Creates a reference between the refering object and the references.

Parameters:

referer - The object that will refer to references.

reference -

getReferences

java.util.List<WSJiveObject> getReferences(int refererObjectType,
                                           long refererObjectID)

Get all objects that the specfied jiveObject referers too.

Parameters:

refererObjectType - The referer's object type.

refererObjectID - The id of the referer.

Returns:

a list of objects that are refered by jiveObject.

getReferers

java.util.List<WSJiveObject> getReferers(int referenceObjectType,
                                         long referenceObjectID)

Get a list of all the objects that refer to this specified object.

Parameters:

referenceObjectType - The object Type of the reference.

referenceObjectID - The object id of the reference.

Returns:

A list of all object that reference this object.

deleteReference

void deleteReference(int refererObjectType,
                     long refererObjectID,
                     int referenceObjectType,
                     long referenceObjectID)

Delete the reference between a referer and the refered content.

Parameters:

refererObjectType - The referer's object type.

refererObjectID - The id of the referer.

referenceObjectType - The object Type of the reference.

referenceObjectID - The object id of the reference.

deleteAllReferences

void deleteAllReferences(int refererObjectType,
                         long refererObjectID)

Removes all references from the specified referer.

Parameters:

refererObjectType - The referer's object type.

refererObjectID - The id of the referer.

deleteAllReferers

void deleteAllReferers(int referenceObjectType,
                       long referenceObjectID)

Causes this object to not be referred by any other objects.

Parameters:

referenceObjectType - The object Type of the reference.

referenceObjectID - The object id of the reference.