senselogic.sitevision.api.webresource.builder

Interface LinkTargetBuilder

All Superinterfaces:

Builder<LinkTarget>

@Requireable(value="LinkTargetBuilder")
public interface LinkTargetBuilder
extends Builder<LinkTarget>

Builder to create link target instances that can be used to create and update a Link page via LinkPageUtil.

LinkTargetBuilder has one mandatory attribute:

• target - The target. Must be non-null.

LinkTargetBuilder also has some optional attributes:

• description - The description. Default is null.
• open in new window - Whether or not the target should be opened in new window. Default is false.

Using the LinkTargetBuilder is pretty straightforward, if you remember that it is stateful. Conceptually you would typically use it like this:

1. Get the LinkTargetBuilder
2. Set the target
3. Possibly set a description
4. Possibly set open in new window
5. Do build

When you have built a LinkTarget instance, you can re-use the LinkTargetBuilder to build more instances. Something like:

1. Set a new target
2. Possibly set a description
3. Possibly set open in new window
4. Do build

Tip! The Builder interface documentation contains more information about Builders and how to work with them!

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

Since:

Sitevision 4.2

Author:

Magnus Lövgren

See Also:

LinkPageUtil

Method Summary

Modifier and Type	Method and Description
LinkTarget	build() Creates a LinkTarget instance using current state of this builder.
LinkTargetBuilder	setDescription(String aDescription) Sets the description.
LinkTargetBuilder	setExternalTarget(String aURL) Sets the target.
LinkTargetBuilder	setInternalTarget(Node aNode) Sets the target.
LinkTargetBuilder	setMailTarget(String aMailAddress) Sets the target.
LinkTargetBuilder	setOpenInNewWindow(boolean aOpenInNewWindow) Sets open in new window.
LinkTargetBuilder	setPhoneTarget(String aPhoneNumber) Sets the target.

Method Detail

setInternalTarget

LinkTargetBuilder setInternalTarget(Node aNode)
                             throws IllegalArgumentException

Sets the target.

Parameters:

aNode - the target, must be a linkable resource (i.e. a page/article/image/file or such) that isn't trashed.

Returns:

this builder

Throws:

IllegalArgumentException - if aNode is null or not a linkable resource.

setExternalTarget

LinkTargetBuilder setExternalTarget(String aURL)
                             throws IllegalArgumentException

Sets the target.

Parameters:

aURL - the link target URL

Returns:

this builder

Throws:

IllegalArgumentException - if aURL is null or whitespace only

setMailTarget

LinkTargetBuilder setMailTarget(String aMailAddress)
                         throws IllegalArgumentException

Sets the target.

Parameters:

aMailAddress - a mail address

Returns:

this builder

Throws:

IllegalArgumentException - if aMailAddress is null, whitespace only or an invalid mail address.

See Also:

MailUtil.isValidAddress(String)

setPhoneTarget

LinkTargetBuilder setPhoneTarget(String aPhoneNumber)
                          throws IllegalArgumentException

Sets the target.

Parameters:

aPhoneNumber - a phone number

Returns:

this builder

Throws:

IllegalArgumentException - if aPhoneNumber is null, whitespace only or an invalid phone number.

setDescription

LinkTargetBuilder setDescription(String aDescription)

Sets the description.

Parameters:

aDescription - the description

Returns:

this builder

setOpenInNewWindow

LinkTargetBuilder setOpenInNewWindow(boolean aOpenInNewWindow)

Sets open in new window.

Parameters:

aOpenInNewWindow - whether or not the target should be opened in new window

Returns:

this builder

build

LinkTarget build()
          throws IllegalStateException

Creates a LinkTarget instance using current state of this builder.

Note! The 'open in new window' state is ignored when creating a LinkTarget with a mail or telephone target (these target types can never be opened in a new window).

Specified by:

build in interface Builder<LinkTarget>

Returns:

a link target

Throws:

IllegalStateException - if there are no link target.