Package io.meeds.social.cms.service

Interface ContentLinkService

public interface ContentLinkService

Method Summary

Modifier and Type	Method	Description
boolean	canEdit(ContentObjectIdentifier contentObject, String username)
boolean	canView(ContentObjectIdentifier link, String username)
void	deleteLinks(ContentObjectIdentifier contentObject)	Delete the List of Links attached to the designated Object
List<ContentLinkExtension>	getExtensions()
ContentLink	getLink(ContentLinkIdentifier link)
ContentLink	getLink(ContentLinkIdentifier link, String username)
List<ContentLinkIdentifier>	getLinkIdentifiers(ContentObject contentObject)
List<ContentLink>	getLinks(ContentObject contentObject, Locale locale, String username)
void	saveLinks(ContentObject contentObject, List<? extends ContentObjectIdentifier> links)	Saves the List of Links attached to the designated Object
void	saveLinks(ContentObject contentObject, List<? extends ContentObjectIdentifier> links, String username)	Saves the List of Links attached to the designated Object
List<ContentLinkSearchResult>	searchLinks(String objectType, String keyword, String username, Locale locale, int offset, int limit)

Method Details

saveLinks

void saveLinks(ContentObject contentObject,
 List<? extends ContentObjectIdentifier> links,
 String username)
        throws IllegalAccessException

Saves the List of Links attached to the designated Object

Parameters:

contentObject - ContentObject

links - List of ContentObjectIdentifier to attach

Throws:

IllegalAccessException - when user doesn't have edit permission on Content Object

saveLinks

void saveLinks(ContentObject contentObject,
 List<? extends ContentObjectIdentifier> links)

Saves the List of Links attached to the designated Object

Parameters:

contentObject - ContentObject

links - List of ContentObjectIdentifier to attach

deleteLinks

void deleteLinks(ContentObjectIdentifier contentObject)

Delete the List of Links attached to the designated Object

Parameters:

contentObject - ContentObjectIdentifier

getLinks

List<ContentLink> getLinks(ContentObject contentObject,
 Locale locale,
 String username)
                    throws IllegalAccessException

Parameters:

contentObject - ContentObject

locale - user Locale

username - User login identifier

Returns:

the List of Links attached to the designated Object

Throws:

IllegalAccessException - when user doesn't have view permission on Content Object

searchLinks

List<ContentLinkSearchResult> searchLinks(String objectType,
 String keyword,
 String username,
 Locale locale,
 int offset,
 int limit)

Parameters:

objectType - object type (notes, activity, space ...)

keyword - Searched keyword

username - user name

locale - Locale user Locale

offset - Search results offset

limit - Search results limit

Returns:

List of ContentLinkSearchResult

getLinkIdentifiers

List<ContentLinkIdentifier> getLinkIdentifiers(ContentObject contentObject)

Parameters:

contentObject - ContentObject

Returns:

the List of Links attached to the designated Object

getLink

ContentLink getLink(ContentLinkIdentifier link,
 String username)
             throws IllegalAccessException,
org.exoplatform.commons.exception.ObjectNotFoundException

Parameters:

link - ContentLinkIdentifier with object type, id and locale

username - User willing to access to the linked content

Returns:

ContentLink with associated title and uri

Throws:

IllegalAccessException - when user doesn't have edit permission on Content Object

org.exoplatform.commons.exception.ObjectNotFoundException - when ContentLink not found

getLink

ContentLink getLink(ContentLinkIdentifier link)

Parameters:

link - ContentLinkIdentifier with object type, id and locale

Returns:

ContentLink with associated title and uri

canView

boolean canView(ContentObjectIdentifier link,
 String username)

Parameters:

link - ContentObjectIdentifier with object type and id

username - User willing to access to the linked content

Returns:

true if the user can view the object title

canEdit

boolean canEdit(ContentObjectIdentifier contentObject,
 String username)

Parameters:

contentObject - ContentObjectIdentifier with object type/id

username - User willing to access to the linked content

Returns:

true if the user can edit the object title

getExtensions

List<ContentLinkExtension> getExtensions()

Returns:

List of managed ContentLinkExtension