senselogic.sitevision.api.webresource

Interface LinkPageUtil

All Superinterfaces:

VelocityAccess.LinkPageUtilConstants

@Requireable(value="LinkPageUtil")
public interface LinkPageUtil
extends VelocityAccess.LinkPageUtilConstants

Link page utility interface that handles nodes in the page tree with primary node type sv:link.

Note! This interface is used to create and update link pages. You would typically use StructureUtil to move a link page and TrashcanUtil to delete a link page.

Important note! Methods in this interface operates in the VersionUtil.OFFLINE_VERSION. Hence, if you create a link page, updates the name of a link page or such, the page must be published (see PublishingUtil) to have any effect in the VersionUtil.ONLINE_VERSION

An instance of the Sitevision class implementing this interface can be obtained via WebResourceFactory.getLinkPageUtil(). See WebResourceFactory for how to obtain an instance of the WebResourceFactory interface.

Since:

Sitevision 4.2

Author:

Magnus Lövgren

See Also:

LinkTargetBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_CREATED_BY Name of the property specifying the creator of a link page.
static String	PROPERTY_CREATION_DATE Name of the property specifying the creation date of a link page.
static String	PROPERTY_LAST_MODIFIED_BY Name of the property specifying the last modifier of a link page.
static String	PROPERTY_LAST_MODIFIED_DATE Name of the property specifying the last modified date of a link page.
static String	PROPERTY_LAST_PUBLISH_DATE Name of the property specifying the last published date of a link page.
static String	PROPERTY_LAST_PUBLISHED_BY Name of the property specifying the last publisher of a link page.
static String	PROPERTY_LAST_UNPUBLISH_DATE Name of the property specifying the last unpublished date of a link page.
static String	PROPERTY_LAST_UNPUBLISHED_BY Name of the property specifying the last user to unpublish a link page.
static String	PROPERTY_PUBLISH_DATE Name of the property specifying the published date of a link page.
static String	PROPERTY_PUBLISHED_BY Name of the property specifying the publisher of a link page.
static String	PROPERTY_VISIBLE_IN_MENUS Name of the property specifying if a link page is visible in menus.

Method Summary

Modifier and Type	Method and Description
Node	createLinkPage(Node aParent, String aName, LinkTarget aLinkTarget) Creates a link page as sub node of a specified parent.
Node	createLinkPage(Node aParent, String aName, LinkTarget aLinkTarget, Map<String,Object> aProperties) Creates a link page with properties as sub node of a specified parent.
void	renameLinkPage(Node aLinkPage, String aName) Updates the name of a link page.
void	updateLinkPage(Node aLinkPage, Map<String,Object> aProperties) Updates the properties of a link page.
void	updateLinkPageTarget(Node aLinkPage, LinkTarget aLinkTarget) Updates the target of a link page.

Methods inherited from interface senselogic.sitevision.api.render.velocity.VelocityAccess.LinkPageUtilConstants

getPROPERTY_CREATED_BY, getPROPERTY_CREATION_DATE, getPROPERTY_LAST_MODIFIED_BY, getPROPERTY_LAST_MODIFIED_DATE, getPROPERTY_LAST_PUBLISH_DATE, getPROPERTY_LAST_PUBLISHED_BY, getPROPERTY_LAST_UNPUBLISH_DATE, getPROPERTY_LAST_UNPUBLISHED_BY, getPROPERTY_PUBLISH_DATE, getPROPERTY_PUBLISHED_BY, getPROPERTY_VISIBLE_IN_MENUS

Field Detail

PROPERTY_VISIBLE_IN_MENUS

static final String PROPERTY_VISIBLE_IN_MENUS

Name of the property specifying if a link page is visible in menus. It corresponds to the sv:link property visibleInMenus.

The property value must be of type Boolean.

See Also:

Constant Field Values

PROPERTY_CREATION_DATE

static final String PROPERTY_CREATION_DATE

Name of the property specifying the creation date of a link page. It corresponds to the sv:link property creationDate.

The property value must be of type Date or a String on format yyyy-MM-dd HH:mm:ss, where HH:mm:ss is optional (defaults to 00:00:00).

See Also:

Constant Field Values

PROPERTY_CREATED_BY

static final String PROPERTY_CREATED_BY

Name of the property specifying the creator of a link page. It corresponds to the sv:link property createdBy.

The property value must be a Node with primary node type sv:user or sv:systemUser.

See Also:

Constant Field Values

PROPERTY_LAST_MODIFIED_DATE

static final String PROPERTY_LAST_MODIFIED_DATE

Name of the property specifying the last modified date of a link page. It corresponds to the sv:link property lastModifiedDate.

The property value must be of type Date or a String on format yyyy-MM-dd HH:mm:ss, where HH:mm:ss is optional (defaults to 00:00:00).

See Also:

Constant Field Values

PROPERTY_LAST_MODIFIED_BY

static final String PROPERTY_LAST_MODIFIED_BY

Name of the property specifying the last modifier of a link page. It corresponds to the sv:link property lastModifiedBy.

The property value must be a Node with primary node type sv:user or sv:systemUser.

See Also:

Constant Field Values

PROPERTY_LAST_PUBLISH_DATE

static final String PROPERTY_LAST_PUBLISH_DATE

Name of the property specifying the last published date of a link page. It corresponds to the sv:link property lastPublishDate.

The property value must be of type Date or a String on format yyyy-MM-dd HH:mm:ss, where HH:mm:ss is optional (defaults to 00:00:00).

See Also:

Constant Field Values

PROPERTY_LAST_PUBLISHED_BY

static final String PROPERTY_LAST_PUBLISHED_BY

Name of the property specifying the last publisher of a link page. It corresponds to the sv:link property lastPublishedBy.

The property value must be a Node with primary node type sv:user or sv:systemUser.

See Also:

Constant Field Values

PROPERTY_PUBLISH_DATE

static final String PROPERTY_PUBLISH_DATE

Name of the property specifying the published date of a link page. It corresponds to the sv:link property publishDate.

The property value must be of type Date or a String on format yyyy-MM-dd HH:mm:ss, where HH:mm:ss is optional (defaults to 00:00:00).

See Also:

Constant Field Values

PROPERTY_PUBLISHED_BY

static final String PROPERTY_PUBLISHED_BY

Name of the property specifying the publisher of a link page. It corresponds to the sv:link property publishedBy.

The property value must be a Node with primary node type sv:user or sv:systemUser.

See Also:

Constant Field Values

PROPERTY_LAST_UNPUBLISHED_BY

static final String PROPERTY_LAST_UNPUBLISHED_BY

Name of the property specifying the last user to unpublish a link page. It corresponds to the sv:link property lastUnpublishedBy.

The property value must be a Node with primary node type sv:user or sv:systemUser.

Since:

Sitevision 2024.01.2

See Also:

Constant Field Values

PROPERTY_LAST_UNPUBLISH_DATE

static final String PROPERTY_LAST_UNPUBLISH_DATE

Name of the property specifying the last unpublished date of a link page. It corresponds to the sv:link property lastUnpublishDate.

The property value must be of type Date or a String on format yyyy-MM-dd HH:mm:ss, where HH:mm:ss is optional (defaults to 00:00:00).

Since:

Sitevision 2024.01.2

See Also:

Constant Field Values

Method Detail

createLinkPage

Node createLinkPage(Node aParent,
                    String aName,
                    LinkTarget aLinkTarget)
             throws ConstraintViolationException,
                    RepositoryException

Creates a link page as sub node of a specified parent.

The parent may be:

• sv:article
• sv:collaborationGroupPage
• sv:folder
• sv:page
• sv:sitePage

If other parent is specified a ConstraintViolationException is thrown.

Any non-whitespace name can be given a link page, it should however not contain the character '/'.

If no parent, no name or no link target is specified a NullPointerException is thrown.

The current user must be authorized to create links and to do write operations on the parent node or a ConstraintViolationException will be thrown.

Note that a new link page inherits metadata and permissions from its parent.

Parameters:

aParent - the parent node of the link page. May not be null

aName - the name of the link page. May not be null or whitespace only

aLinkTarget - the target of the link page. May not be null

Returns:

a sv:link node corresponding to the newly created link page

Throws:

ConstraintViolationException - if an invalid parent is specified or if the current user is not authorized to create a link page

RepositoryException - if something else goes wrong

createLinkPage

Node createLinkPage(Node aParent,
                    String aName,
                    LinkTarget aLinkTarget,
                    Map<String,Object> aProperties)
             throws ConstraintViolationException,
                    RepositoryException

Creates a link page with properties as sub node of a specified parent.

The parent may be:

• sv:article
• sv:collaborationGroupPage
• sv:folder
• sv:page
• sv:sitePage

If other parent is specified a ConstraintViolationException is thrown.

Any non-whitespace name can be given a link page, it should however not contain the character '/'.

If no parent, no name or no link target is specified a NullPointerException is thrown.

The current user must be authorized to create links and to do write operations on the parent node or a ConstraintViolationException will be thrown.

It is possible to provide these properties for the link page:

• PROPERTY_VISIBLE_IN_MENUS
• PROPERTY_CREATION_DATE
• PROPERTY_CREATED_BY
• PROPERTY_LAST_MODIFIED_DATE
• PROPERTY_LAST_MODIFIED_BY
• PROPERTY_LAST_PUBLISH_DATE
• PROPERTY_LAST_PUBLISHED_BY
• PROPERTY_PUBLISH_DATE
• PROPERTY_PUBLISHED_BY
• PROPERTY_LAST_UNPUBLISHED_BY
• PROPERTY_LAST_UNPUBLISH_DATE

If an invalid value is provided for a property, an IllegalArgumentException is thrown

Default values:

• PROPERTY_VISIBLE_IN_MENUS - true
• PROPERTY_CREATION_DATE - current time stamp
• PROPERTY_CREATED_BY - current user
• PROPERTY_LAST_MODIFIED_DATE - current time stamp
• PROPERTY_LAST_MODIFIED_BY - current user
• PROPERTY_LAST_PUBLISH_DATE - null (will not have a value)
• PROPERTY_LAST_PUBLISHED_BY - null (will not have a value)
• PROPERTY_PUBLISH_DATE - null (will not have a value)
• PROPERTY_PUBLISHED_BY - null (will not have a value)
• PROPERTY_LAST_UNPUBLISHED_BY - null (will not have a value)
• PROPERTY_LAST_UNPUBLISH_DATE - null (will not have a value)

Note that a new link page inherits metadata and permissions from its parent.

Parameters:

aParent - the parent node of the link page. May not be null

aName - the name of the link page. May not be null or whitespace only

aLinkTarget - the target of the link page. May not be null

aProperties - the link page properties. May be null or empty

Returns:

a sv:link node corresponding to the newly created link page

Throws:

ConstraintViolationException - if an invalid parent is specified or if the current user is not authorized to create the link page

RepositoryException - if something else goes wrong

renameLinkPage

void renameLinkPage(Node aLinkPage,
                    String aName)
             throws ConstraintViolationException,
                    RepositoryException

Updates the name of a link page.

Any non-whitespace name can be given a link page, it should however not contain the character '/'.

If no link page or no name is specified a NullPointerException is thrown.

The current user must be authorized to do write operations on the link page or a ConstraintViolationException will be thrown.

Parameters:

aLinkPage - the link page. May not be null

aName - the name of the link page. May not be null or whitespace only

Throws:

ConstraintViolationException - if an invalid link page is specified or if the current user is not authorized to update the link page

RepositoryException - if something else goes wrong

updateLinkPageTarget

void updateLinkPageTarget(Node aLinkPage,
                          LinkTarget aLinkTarget)
                   throws ConstraintViolationException,
                          RepositoryException

Updates the target of a link page.

If no link page or no link target is specified a NullPointerException is thrown.

The current user must be authorized to do write operations on the link page or a ConstraintViolationException will be thrown.

Parameters:

aLinkPage - the link page. May not be null

aLinkTarget - the target of the link page. May not be null

Throws:

ConstraintViolationException - if an invalid link page is specified or if the current user is not authorized to update the link page

RepositoryException - if something else goes wrong

updateLinkPage

void updateLinkPage(Node aLinkPage,
                    Map<String,Object> aProperties)
             throws ConstraintViolationException,
                    RepositoryException

Updates the properties of a link page.

If no link page is specified a NullPointerException is thrown.

The current user must be authorized to do write operations on the link page or a ConstraintViolationException will be thrown.

Properties:

• PROPERTY_VISIBLE_IN_MENUS
• PROPERTY_CREATION_DATE
• PROPERTY_CREATED_BY
• PROPERTY_LAST_MODIFIED_DATE
• PROPERTY_LAST_MODIFIED_BY
• PROPERTY_LAST_PUBLISH_DATE
• PROPERTY_LAST_PUBLISHED_BY
• PROPERTY_PUBLISH_DATE
• PROPERTY_PUBLISHED_BY

If an invalid value is provided for a property, an IllegalArgumentException is thrown

Default values:

• PROPERTY_VISIBLE_IN_MENUS - true
• PROPERTY_CREATION_DATE - current time stamp
• PROPERTY_CREATED_BY - current user
• PROPERTY_LAST_MODIFIED_DATE - current time stamp
• PROPERTY_LAST_MODIFIED_BY - current user
• PROPERTY_LAST_PUBLISH_DATE - null (will not have a value)
• PROPERTY_LAST_PUBLISHED_BY - null (will not have a value)
• PROPERTY_PUBLISH_DATE - null (will not have a value)
• PROPERTY_PUBLISHED_BY - null (will not have a value)

Parameters:

aLinkPage - the link page. May not be null

aProperties - the link page properties. Should not be null or empty

Throws:

ConstraintViolationException - if an invalid link page is specified or if the current user is not authorized to update the link page

RepositoryException - if something else goes wrong