Interface EdgeDocumentFactory
- All Known Implementing Classes:
DefaultEdgeDocumentFactory
public interface EdgeDocumentFactory
Responsible for creating an Atlassian document that represents an edge.
-
Method Summary
Modifier and TypeMethodDescriptionbuildDocument
(String edgeId, com.atlassian.sal.api.user.UserKey userKey, ContentEntityObject target, Date date, String edgeTypeKey) Build the AtlassianDocument which will be stored as an edge index document
-
Method Details
-
buildDocument
AtlassianDocument buildDocument(String edgeId, com.atlassian.sal.api.user.UserKey userKey, ContentEntityObject target, Date date, String edgeTypeKey) Build the AtlassianDocument which will be stored as an edge index document- Parameters:
edgeId
- the edge IDuserKey
- the user keytarget
- the target object (usually a page, blog post or comment)date
- the date when this edge index is creatededgeTypeKey
- the edge type- Returns:
- the
AtlassianDocument
representing the edge index document
-