public interface BlogService
BlogIntegrationService
, a separate service, is
concerned with the integration of Alfresco blog content with external Blog-hosting sites.
Please note that this service is a work in progress and currently exists primarily to support the blogs REST API.Modifier and Type | Interface and Description |
---|---|
static class |
BlogService.RangedDateProperty
A simple data object for expressing a date range search parameter.
|
Modifier and Type | Method and Description |
---|---|
BlogPostInfo |
createBlogPost(org.alfresco.service.cmr.repository.NodeRef blogContainerNode,
String blogTitle,
String blogContent,
boolean isDraft)
Creates a new blog post within the specified container node.
|
BlogPostInfo |
createBlogPost(String siteShortName,
String blogTitle,
String blogContent,
boolean isDraft)
Creates a new blog post in the specified site
|
void |
deleteBlogPost(BlogPostInfo post)
Deletes an existing
BlogPostInfo from the repository. |
org.alfresco.query.PagingResults<BlogPostInfo> |
findBlogPosts(org.alfresco.service.cmr.repository.NodeRef blogContainerNode,
BlogService.RangedDateProperty dateRange,
String tag,
org.alfresco.query.PagingRequest pagingReq)
Finds blog posts by the specified user tagged with the given tag string.
|
org.alfresco.query.PagingResults<BlogPostInfo> |
findBlogPosts(String siteShortName,
BlogService.RangedDateProperty dateRange,
String tag,
org.alfresco.query.PagingRequest pagingReq)
Finds blog posts by the specified user tagged with the given tag string.
|
BlogPostInfo |
getBlogPost(org.alfresco.service.cmr.repository.NodeRef parentNodeRef,
String postName)
Retrieves an existing
BlogPostInfo from the repository,
which is attached to the specified Node. |
BlogPostInfo |
getBlogPost(String siteShortName,
String postName)
Retrieves an existing
BlogPostInfo from the repository,
which is within a site |
org.alfresco.query.PagingResults<BlogPostInfo> |
getDrafts(org.alfresco.service.cmr.repository.NodeRef blogContainerNode,
String username,
org.alfresco.query.PagingRequest pagingReq)
Gets the draft blog posts created by the specified user.
|
org.alfresco.query.PagingResults<BlogPostInfo> |
getDrafts(String siteShortName,
String username,
org.alfresco.query.PagingRequest pagingReq)
Gets the draft blog posts created by the specified user.
|
BlogPostInfo |
getForNodeRef(org.alfresco.service.cmr.repository.NodeRef nodeRef)
For a given NodeRef corresponding to a
BlogPostInfo ,
returns the object wrapping the Node. |
org.alfresco.query.PagingResults<BlogPostInfo> |
getMyDraftsAndAllPublished(org.alfresco.service.cmr.repository.NodeRef blogContainerNode,
Date fromDate,
Date toDate,
org.alfresco.query.PagingRequest pagingReq)
Deprecated.
This method is a domain-specific query used by the Blog REST API and is not considered suitable for general use.
|
org.alfresco.query.PagingResults<BlogPostInfo> |
getPublished(org.alfresco.service.cmr.repository.NodeRef blogContainerNode,
Date fromDate,
Date toDate,
String byUser,
org.alfresco.query.PagingRequest pagingReq)
Gets the (internally, Alfresco-) published blog posts.
|
org.alfresco.query.PagingResults<BlogPostInfo> |
getPublished(String siteShortName,
Date fromDate,
Date toDate,
String byUser,
org.alfresco.query.PagingRequest pagingReq)
Gets the (internally, Alfresco-) published blog posts.
|
org.alfresco.query.PagingResults<BlogPostInfo> |
getPublishedExternally(org.alfresco.service.cmr.repository.NodeRef blogContainerNode,
org.alfresco.query.PagingRequest pagingReq)
Gets blog posts published externally (i.e.
|
org.alfresco.query.PagingResults<BlogPostInfo> |
getPublishedExternally(String siteShortName,
org.alfresco.query.PagingRequest pagingReq)
Gets blog posts published externally (i.e.
|
boolean |
isDraftBlogPost(org.alfresco.service.cmr.repository.NodeRef blogPostNode)
Deprecated.
Add this to the BlogPostInfo shortly
|
BlogPostInfo |
updateBlogPost(BlogPostInfo post)
Updates an existing
BlogPostInfo in the repository. |
BlogPostInfo createBlogPost(String siteShortName, String blogTitle, String blogContent, boolean isDraft)
siteShortName
- the name of the site to add the post to.blogTitle
- the title of the blog post.blogContent
- text/html content of the blog post.isDraft
- true if the blog post is a draft post, else false.BlogPostInfo
of the newly created blog post.to retrieve the blogContainerNode
BlogPostInfo createBlogPost(org.alfresco.service.cmr.repository.NodeRef blogContainerNode, String blogTitle, String blogContent, boolean isDraft)
blogContainerNode
- the container node for blog posts (under the site).blogTitle
- the title of the blog post.blogContent
- text/html content of the blog post.isDraft
- true if the blog post is a draft post, else false.BlogPostInfo
of the newly created blog post.to retrieve the blogContainerNode
BlogPostInfo updateBlogPost(BlogPostInfo post)
BlogPostInfo
in the repository.BlogPostInfo
void deleteBlogPost(BlogPostInfo post)
BlogPostInfo
from the repository.@NotAuditable BlogPostInfo getForNodeRef(org.alfresco.service.cmr.repository.NodeRef nodeRef)
BlogPostInfo
,
returns the object wrapping the Node.
For anything else, the response is null.BlogPostInfo getBlogPost(String siteShortName, String postName)
BlogPostInfo
from the repository,
which is within a siteBlogPostInfo getBlogPost(org.alfresco.service.cmr.repository.NodeRef parentNodeRef, String postName)
BlogPostInfo
from the repository,
which is attached to the specified Node.
The parent Node should normally be a Site Containerorg.alfresco.query.PagingResults<BlogPostInfo> getDrafts(String siteShortName, String username, org.alfresco.query.PagingRequest pagingReq)
siteShortName
- the name of the site to add the post to.username
- to limit results to blogs with this cm:creator. null means all users.pagingReq
- an object defining the paging parameters for the result set.PagingResults
object containing some or all of the results (subject to paging).to retrieve the blogContainerNode
org.alfresco.query.PagingResults<BlogPostInfo> getDrafts(org.alfresco.service.cmr.repository.NodeRef blogContainerNode, String username, org.alfresco.query.PagingRequest pagingReq)
blogContainerNode
- the container node for blog posts (under the site).username
- to limit results to blogs with this cm:creator. null means all users.pagingReq
- an object defining the paging parameters for the result set.PagingResults
object containing some or all of the results (subject to paging).to retrieve the blogContainerNode
org.alfresco.query.PagingResults<BlogPostInfo> getPublished(String siteShortName, Date fromDate, Date toDate, String byUser, org.alfresco.query.PagingRequest pagingReq)
siteShortName
- the name of the site to add the post to.fromDate
- an inclusive date limit for the results (more recent than).toDate
- an inclusive date limit for the results (before).byUser
- if not null limits results to posts by the specified user.
if null results will be by all users.pagingReq
- an object defining the paging parameters for the result set.PagingResults
object containing some or all of the results (subject to paging).to retrieve the blogContainerNode
org.alfresco.query.PagingResults<BlogPostInfo> getPublished(org.alfresco.service.cmr.repository.NodeRef blogContainerNode, Date fromDate, Date toDate, String byUser, org.alfresco.query.PagingRequest pagingReq)
blogContainerNode
- the container node for blog posts (under the site).fromDate
- an inclusive date limit for the results (more recent than).toDate
- an inclusive date limit for the results (before).byUser
- if not null limits results to posts by the specified user.
if null results will be by all users.pagingReq
- an object defining the paging parameters for the result set.PagingResults
object containing some or all of the results (subject to paging).to retrieve the blogContainerNode
org.alfresco.query.PagingResults<BlogPostInfo> getPublishedExternally(String siteShortName, org.alfresco.query.PagingRequest pagingReq)
siteShortName
- the name of the site to add the post to.pagingReq
- an object defining the paging parameters for the result set.PagingResults
object containing some or all of the results (subject to paging).to retrieve the blogContainerNode
org.alfresco.query.PagingResults<BlogPostInfo> getPublishedExternally(org.alfresco.service.cmr.repository.NodeRef blogContainerNode, org.alfresco.query.PagingRequest pagingReq)
blogContainerNode
- the container node for blog posts (under the site).pagingReq
- an object defining the paging parameters for the result set.PagingResults
object containing some or all of the results (subject to paging).to retrieve the blogContainerNode
org.alfresco.query.PagingResults<BlogPostInfo> getMyDraftsAndAllPublished(org.alfresco.service.cmr.repository.NodeRef blogContainerNode, Date fromDate, Date toDate, org.alfresco.query.PagingRequest pagingReq)
blogContainerNode
- the container node for blog posts (under the site).fromDate
- an inclusive date limit for the results (more recent than).toDate
- an inclusive date limit for the results (before).pagingReq
- an object defining the paging parameters for the result set.PagingResults
object containing some or all of the results (subject to paging).to retrieve the blogContainerNode
org.alfresco.query.PagingResults<BlogPostInfo> findBlogPosts(String siteShortName, BlogService.RangedDateProperty dateRange, String tag, org.alfresco.query.PagingRequest pagingReq)
DataTypeDefinition.DATE
or DataTypeDefinition.DATETIME
property. Examples include ContentModel.PROP_CREATED
or
ContentModel.PROP_PUBLISHED
.siteShortName
- the name of the site to add the post to.dateRange
- a BlogService.RangedDateProperty
parameter object. Can be null.tag
- tag string.pagingReq
- an object defining the paging parameters for the result set.PagingResults
object containing some or all of the results (subject to paging).to retrieve the blogContainerNode
org.alfresco.query.PagingResults<BlogPostInfo> findBlogPosts(org.alfresco.service.cmr.repository.NodeRef blogContainerNode, BlogService.RangedDateProperty dateRange, String tag, org.alfresco.query.PagingRequest pagingReq)
DataTypeDefinition.DATE
or DataTypeDefinition.DATETIME
property. Examples include ContentModel.PROP_CREATED
or
ContentModel.PROP_PUBLISHED
.blogContainerNode
- the container node for blog posts (under the site).dateRange
- a BlogService.RangedDateProperty
parameter object. Can be null.tag
- tag string.pagingReq
- an object defining the paging parameters for the result set.PagingResults
object containing some or all of the results (subject to paging).to retrieve the blogContainerNode
boolean isDraftBlogPost(org.alfresco.service.cmr.repository.NodeRef blogPostNode)
blogPostNode
- a NodeRef representing a blog-post.Copyright © 2005–2017 Alfresco Software. All rights reserved.