Package org.silverpeas.components.quickinfo.model

Interface QuickInfoService

All Superinterfaces:

org.silverpeas.core.ApplicationService

All Known Implementing Classes:

DefaultQuickInfoService

public interface QuickInfoService
extends org.silverpeas.core.ApplicationService

Method Summary

Modifier and Type	Method	Description
void	acknowledgeNews(org.silverpeas.core.ResourceReference newsRef, String userId)
void	copyNews(News newsToCopy, org.silverpeas.core.admin.component.model.PasteDetail pasteDetail)	Creating new news from an existing one.
News	create(News news)
static QuickInfoService	get()
List<News>	getAllNews(String componentId)
NewsByStatus	getAllNewsByStatus(String componentId, String userId)
Optional<News>	getContributionById(org.silverpeas.core.contribution.model.ContributionIdentifier contributionId)
News	getNews(org.silverpeas.core.ResourceReference newsRef)	Gets the specified news in the QuickInfo instance it belongs to.
News	getNewsByForeignId(String id)
List<News>	getNewsForTicker(String userId)
List<News>	getPlatformNews(String userId)
List<News>	getUnreadBlockingNews(String userId)
List<News>	getVisibleNews(String componentId)
void	performReminder(org.silverpeas.core.reminder.Reminder reminder)	Performs processes about news linked to given reminder. If news is not concerned, nothing is performed.
void	publish(org.silverpeas.core.ResourceReference newsRef, String userId)	Publishes the specified news of a QuickInfo instance.
void	removeNews(org.silverpeas.core.ResourceReference newsRef)	Removes the specified news from the QuickInfo instance it belongs to.
void	submitNewsOnHomepage(org.silverpeas.core.ResourceReference newsRef, String userId)	Submits the specified news of a QuickInfo instance to the news of the main page.
void	update(News news, List<org.silverpeas.core.pdc.pdc.model.PdcPosition> positions, Collection<org.silverpeas.core.io.upload.UploadedFile> uploadedFiles, boolean forcePublishing)

Methods inherited from interface org.silverpeas.core.ApplicationService

getComponentMessages, getComponentSettings, isRelatedTo

Method Detail

get

static QuickInfoService get()

getContributionById

Optional<News> getContributionById(org.silverpeas.core.contribution.model.ContributionIdentifier contributionId)

Specified by:

getContributionById in interface org.silverpeas.core.ApplicationService

create

News create(News news)

copyNews

void copyNews(News newsToCopy,
              org.silverpeas.core.admin.component.model.PasteDetail pasteDetail)

Creating new news from an existing one.

Parameters:

newsToCopy - news to copy.

pasteDetail - the details about the copy (user identifier and component destination).

publish

void publish(org.silverpeas.core.ResourceReference newsRef,
             String userId)

Publishes the specified news of a QuickInfo instance.

Parameters:

newsRef - the reference of the news (its identifier and its QuickInfo instance).

userId - the unique identifier of the user publishing the news.

Throws:

org.silverpeas.kernel.exception.NotFoundException - if the instance has no such news.

update

void update(News news,
            List<org.silverpeas.core.pdc.pdc.model.PdcPosition> positions,
            Collection<org.silverpeas.core.io.upload.UploadedFile> uploadedFiles,
            boolean forcePublishing)

removeNews

void removeNews(org.silverpeas.core.ResourceReference newsRef)

Removes the specified news from the QuickInfo instance it belongs to.

Parameters:

newsRef - the reference of the news (its identifier and its QuickInfo instance).

Throws:

org.silverpeas.kernel.exception.NotFoundException - if the instance has no such news.

getAllNews

List<News> getAllNews(String componentId)

getAllNewsByStatus

NewsByStatus getAllNewsByStatus(String componentId,
                                String userId)

getVisibleNews

List<News> getVisibleNews(String componentId)

getPlatformNews

List<News> getPlatformNews(String userId)

getNewsForTicker

List<News> getNewsForTicker(String userId)

getUnreadBlockingNews

List<News> getUnreadBlockingNews(String userId)

acknowledgeNews

void acknowledgeNews(org.silverpeas.core.ResourceReference newsRef,
                     String userId)

getNews

News getNews(org.silverpeas.core.ResourceReference newsRef)

Gets the specified news in the QuickInfo instance it belongs to.

Parameters:

newsRef - the reference of the news (its identifier and its QuickInfo instance).

Returns:

the news or null if the instance has no such news.

getNewsByForeignId

News getNewsByForeignId(String id)

submitNewsOnHomepage

void submitNewsOnHomepage(org.silverpeas.core.ResourceReference newsRef,
                          String userId)

Submits the specified news of a QuickInfo instance to the news of the main page.

Parameters:

newsRef - the reference of the news (its identifier and its QuickInfo instance).

userId - the unique identifier of the user submitting the news.

Throws:

org.silverpeas.kernel.exception.NotFoundException - if the instance has no such news.

performReminder

void performReminder(org.silverpeas.core.reminder.Reminder reminder)

Performs processes about news linked to given reminder.
If news is not concerned, nothing is performed.

Parameters:

reminder - a Reminder instance.