Package org.exoplatform.news.service

Interface NewsTargetingService

All Known Implementing Classes:

NewsTargetingServiceImpl

public interface NewsTargetingService

Field Summary

Fields

Modifier and Type	Field	Description
static org.exoplatform.social.metadata.model.MetadataType	METADATA_TYPE

Method Summary

Modifier and Type	Method	Description
org.exoplatform.social.metadata.model.Metadata	createNewsTarget(NewsTargetingEntity newsTargetingEntity, org.exoplatform.services.security.Identity currentIdentity)	Create news target
void	deleteNewsTargets(String newsId)	Delete the List of News targets linked to a given News id
void	deleteNewsTargets(String newsId, String currentUserId)	Delete the List of News targets linked to a given News id
void	deleteTargetByName(String targetName, org.exoplatform.services.security.Identity currentIdentity)	Delete the News target by a given News target name
List<org.exoplatform.social.metadata.model.MetadataItem>	getNewsTargetItemsByTargetName(String targetName, long offset, long limit)	Gets the List of News target items by a given target name.
List<NewsTargetingEntity>	getReferencedTargets(org.exoplatform.services.security.Identity currentIdentity)	Gets the List of referenced targets from News list portlets
List<NewsTargetingEntity>	getTargets()	Gets the List of all News targets which can be referenced from News list portlets
List<String>	getTargetsByNewsId(String newsId)	Gets the List of News targets linked to a given News id
void	saveNewsTarget(String newsId, boolean displayed, List<String> targets, String currentUser)	Save a List of News targets of a given News id by the current user
org.exoplatform.social.metadata.model.Metadata	updateNewsTargets(String originalTargetName, NewsTargetingEntity newsTargetingEntity, org.exoplatform.services.security.Identity currentIdentity)	Update news target

Field Detail

METADATA_TYPE

static final org.exoplatform.social.metadata.model.MetadataType METADATA_TYPE

Method Detail

getTargets

List<NewsTargetingEntity> getTargets()

Gets the List of all News targets which can be referenced from News list portlets

Returns:

List of all News targets

deleteTargetByName

void deleteTargetByName(String targetName,
                        org.exoplatform.services.security.Identity currentIdentity)
                 throws IllegalAccessException

Delete the News target by a given News target name

Parameters:

targetName - News target name to be deleted

currentIdentity - Identity technical identifier

Throws:

IllegalAccessException

getTargetsByNewsId

List<String> getTargetsByNewsId(String newsId)

Gets the List of News targets linked to a given News id

Parameters:

newsId - News identifier of News targets to be retrieved

Returns:

List of News targets by News id

getNewsTargetItemsByTargetName

List<org.exoplatform.social.metadata.model.MetadataItem> getNewsTargetItemsByTargetName(String targetName,
                                                                                        long offset,
                                                                                        long limit)

Gets the List of News target items by a given target name.

Parameters:

targetName - target name of metadata to be retrieved

offset - limit

limit - offset

Returns:

List of News target items by a target name

getReferencedTargets

List<NewsTargetingEntity> getReferencedTargets(org.exoplatform.services.security.Identity currentIdentity)
                                        throws IllegalAccessException

Gets the List of referenced targets from News list portlets

Parameters:

currentIdentity - attempting to get referenced News targets

Returns:

List of referenced targets

Throws:

IllegalAccessException - when user doesn't have access to get referenced News targets

saveNewsTarget

void saveNewsTarget(String newsId,
                    boolean displayed,
                    List<String> targets,
                    String currentUser)
             throws IllegalAccessException

Save a List of News targets of a given News id by the current user

Parameters:

newsId - News identifier of News targets to be saved

displayed - News is news displayed in news list portlet

targets - List of News targets to be saved

currentUser - current user attempting to save News targets

Throws:

IllegalAccessException - when user doesn't have access to save News targets of a given News id

deleteNewsTargets

void deleteNewsTargets(String newsId,
                       String currentUserId)
                throws IllegalAccessException

Delete the List of News targets linked to a given News id

Parameters:

newsId - News identifier of News targets to be deleted

currentUserId - attempting to delete News target

Throws:

IllegalAccessException - when user doesn't have access to delete News targets of a given News id

deleteNewsTargets

void deleteNewsTargets(String newsId)

Delete the List of News targets linked to a given News id

Parameters:

newsId - News identifier of News to delete targets

createNewsTarget

org.exoplatform.social.metadata.model.Metadata createNewsTarget(NewsTargetingEntity newsTargetingEntity,
                                                                org.exoplatform.services.security.Identity currentIdentity)
                                                         throws IllegalArgumentException,
                                                                IllegalAccessException

Create news target

Parameters:

newsTargetingEntity - News TargetingEntity

currentIdentity - current Identity attempting to create News target

Returns:

created News target Metadata

Throws:

IllegalArgumentException - when user creates a News target that already exists

IllegalAccessException - when user doesn't have access to create News target

updateNewsTargets

org.exoplatform.social.metadata.model.Metadata updateNewsTargets(String originalTargetName,
                                                                 NewsTargetingEntity newsTargetingEntity,
                                                                 org.exoplatform.services.security.Identity currentIdentity)
                                                          throws IllegalAccessException,
                                                                 IllegalStateException,
                                                                 IllegalArgumentException

Update news target

Parameters:

originalTargetName - identifier of the News target

newsTargetingEntity - News TargetingEntity to be updated

currentIdentity - current Identity attempting to update News target

Returns:

updated News target Metadata

Throws:

IllegalAccessException - when user doesn't have access to update News target

IllegalStateException - when user tries to update a not existing News target

IllegalArgumentException - when user tries to update a not changed News target