nl.gx.webmanager.services.contentapi
Interface LinkManagementService

public interface LinkManagementService

This service provides functionality to create links.

Method Summary

RelatedExternalLink	createRelatedExternalLink(ElementHolder elementHolder, java.lang.String url) Deprecated. replaced by createRelatedLink(ElementHolder, java.lang.Class)
RelatedLink	createRelatedLink(ElementHolder elementHolder, java.lang.Class<? extends RelatedLink> relatedLinkType) Creates an empty link for an ElementHolder.
void	deleteRelatedLink(ElementHolder elementHolder, RelatedLink relatedLink) Deletes a link for an ElementHolder.
RelatedLink	getRelatedLinkByCode(ElementHolder elementHolder, java.lang.String code) Returns the related link based on the link code.
void	updateRelatedExternalLink(ElementHolder elementHolder, java.lang.String code, java.lang.String url) Deprecated. replaced by createRelatedLink(ElementHolder, java.lang.Class) and then updating the Link object itself

Method Detail

createRelatedExternalLink

@Deprecated
RelatedExternalLink createRelatedExternalLink(ElementHolder elementHolder,
                                                         java.lang.String url)
                                              throws NoAuthorizationException

Deprecated. replaced by createRelatedLink(ElementHolder, java.lang.Class)

Creates an external link with a given url for an ElementHolder.

Parameters:

elementHolder - the element holder to which to assign the related link

url - the external url

Returns:

a new related external link

Throws:

NoAuthorizationException - exception if the user does not have permission to create links

createRelatedLink

RelatedLink createRelatedLink(ElementHolder elementHolder,
                              java.lang.Class<? extends RelatedLink> relatedLinkType)
                              throws NoAuthorizationException

Creates an empty link for an ElementHolder.

Parameters:

elementHolder - the element holder to which to assign the related link

relatedLinkType - the interface of the related link type to create

Returns:

a new related link

Throws:

NoAuthorizationException - exception if the user does not have permission to create links

Since:

9.12.0

getRelatedLinkByCode

RelatedLink getRelatedLinkByCode(ElementHolder elementHolder,
                                 java.lang.String code)

Returns the related link based on the link code.

Parameters:

elementHolder - the element holder which contains the related link

code - the link code

Returns:

the related link

updateRelatedExternalLink

@Deprecated
void updateRelatedExternalLink(ElementHolder elementHolder,
                                          java.lang.String code,
                                          java.lang.String url)

Deprecated. replaced by createRelatedLink(ElementHolder, java.lang.Class) and then updating the Link object itself

Updates the related external link based on the element holder and the link code.

Parameters:

elementHolder - the element holder

code - the link code

url - the new url

deleteRelatedLink

void deleteRelatedLink(ElementHolder elementHolder,
                       RelatedLink relatedLink)
                       throws NoAuthorizationException

Deletes a link for an ElementHolder.

Parameters:

elementHolder - the element holder to which to assign the related link

relatedLink - the related link type to delete

Throws:

NoAuthorizationException - exception if the user does not have permission to delete links

Since:

9.12.0