org.cyclos.impl.utils

Interface LinkGeneratorHandler

public interface LinkGeneratorHandler

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTR_ENTITY_ID Script attribute: the link related entity id
static java.lang.String	ATTR_LOCATION Script attribute: the link related location
static java.lang.String	ATTR_URL_FILE_PART Script attribute: the link related url file part
static java.lang.String	ATTR_USER Script attribute: the link related user

Method Summary

Modifier and Type	Method and Description
java.lang.String	generateLinkFor(Location location, BasicUser user) Generate a dynamic ("tagged") link for a given Location without using any id parameter, also the link will be created taking the user's network.
java.lang.String	generateLinkFor(Location location, java.lang.Long entityId, BasicUser user) Generate a link for a given Location and entity adding required parameters in the URL e.g: entity.getId(), also the link will be created taking the user's network.
java.lang.String	generateLinkFor(java.lang.String urlFilePart, BasicUser user) This method generate a static ("final") URL taking into account the user's network (root url and root path). E.g.: it could be used to generate external links to be added in an email's body.

Field Detail

ATTR_USER

static final java.lang.String ATTR_USER

Script attribute: the link related user

See Also:

Constant Field Values

ATTR_LOCATION

static final java.lang.String ATTR_LOCATION

Script attribute: the link related location

See Also:

Constant Field Values

ATTR_ENTITY_ID

static final java.lang.String ATTR_ENTITY_ID

Script attribute: the link related entity id

See Also:

Constant Field Values

ATTR_URL_FILE_PART

static final java.lang.String ATTR_URL_FILE_PART

Script attribute: the link related url file part

See Also:

Constant Field Values

Method Detail

generateLinkFor

java.lang.String generateLinkFor(Location location,
                                 BasicUser user)

Generate a dynamic ("tagged") link for a given Location without using any id parameter, also the link will be created taking the user's network. This kind of url will be resolved to a static (without any tags) before send the data to the user.

generateLinkFor

java.lang.String generateLinkFor(Location location,
                                 java.lang.Long entityId,
                                 BasicUser user)

Generate a link for a given Location and entity adding required parameters in the URL e.g: entity.getId(), also the link will be created taking the user's network.

generateLinkFor

java.lang.String generateLinkFor(java.lang.String urlFilePart,
                                 BasicUser user)

This method generate a static ("final") URL taking into account the user's network (root url and root path).
E.g.: it could be used to generate external links to be added in an email's body.