com.fatwire.assetapi.data

Interface LegacyLinkInfo<E extends LegacyLinkInfo>

All Superinterfaces:

LinkInfo<E>

public interface LegacyLinkInfo<E extends LegacyLinkInfo>
extends LinkInfo<E>

Method Summary

Modifier and Type	Method and Description
E	addSession(boolean addSession) Specifies whether to include session IDs in the URL when a browser is set to reject cookies.
E	forAuthority(String authority) Attribute that allows the user to specify a fully-qualified URL, when used in conjunction with scheme.
E	forContainerType(String containerType) Deprecated. This might not be useful at all in this case since portlet is rarely needed now
E	forFragment(String fragment) Optional attribute to specify a fragment on the URL.
E	forRendermode(String rendermode) Specify the render mode
E	forSatelliteContext(String satellite) Specify the Satellite Context that is going to be used; if not specified, it will generate a link for ContentServer
E	forScheme(String scheme) Attribute that allows the scheme to be set in the URL.
E	forTid(String tid) The id of the template in which this tag is located.
E	forTtype(String type) This attribute identifies whether the code that contains this tag is a Template or a CSElement.
String	getAssembler()
String	getAuthority()
String	getContainerType()
DependencyTypeEnum	getDep()
String	getFragment()
String	getRendermode()
String	getSatelliteContext()
String	getScheme()
boolean	getSession()
String	getTid()
String	getTType()
String	getWrapper()
E	logDep(DependencyTypeEnum depType) Specify the dependency type that is going to be logged
E	useAssembler(String assembler) Specify the Short form name for uri assembler class.
E	useWrapper(String wrapper) If the target uses an uncached wrapper page, supply this argument with the name of that SiteCatalog page

Methods inherited from interface com.fatwire.assetapi.data.LinkInfo

forAsset, forDevice, forSite, forType, forType, getAssetId, getDevice, getParameters, getSite, getSubtype, getTemplate, getType, getWebroot, parameters, useTemplate, useWebroot

Method Detail

addSession

E addSession(boolean addSession)

Specifies whether to include session IDs in the URL when a browser is set to reject cookies. true means to encode session IDs in the URL. If this parameter is not specified, it is set to true by default.

Parameters:

addSession - the boolean value of addSession or not

Returns:

a LegacyLinkInfo

useAssembler

E useAssembler(String assembler)

Specify the Short form name for uri assembler class. Specifying an assembler overrides the default assembler used by Sites to construct URLs. Omitting this value will cause URLs generated by this tag to use the assembler registered with the highest priority in the request property file.

Parameters:

assembler - the Short form name for uri assembler

Returns:

a LegacyLinkInfo

logDep

E logDep(DependencyTypeEnum depType)

Specify the dependency type that is going to be logged

Parameters:

depType - the dependency type

Returns:

a LegacyLinkInfo

forSatelliteContext

E forSatelliteContext(String satellite)

Specify the Satellite Context that is going to be used; if not specified, it will generate a link for ContentServer

Parameters:

satellite - the Satellite Context

Returns:

a LegacyLinkInfo

forTtype

E forTtype(String type)

This attribute identifies whether the code that contains this tag is a Template or a CSElement. The default value is Template, and CSElement is the other legal value.

Parameters:

type - the type of the templatename value

Returns:

a LegacyLinkInfo

forTid

E forTid(String tid)

The id of the template in which this tag is located. If this tag is located in a CSElement, then the value of this attribute should be the id of the CSElement, and ttype should be set to CSElement.

Parameters:

tid - the id

Returns:

a LegacyLinkInfo

forRendermode

E forRendermode(String rendermode)

Specify the render mode

Parameters:

rendermode - the rendermode

Returns:

a LegacyLinkInfo

forFragment

E forFragment(String fragment)

Optional attribute to specify a fragment on the URL. Fragments, sometimes known as anchors, allow browsers to advance to a specific location in a single web page. ex. http://www.myhost.com/foo.html#thirdParagraph.

Parameters:

fragment - the value of the fragement

Returns:

a LegacyLinkInfo

forContainerType

E forContainerType(String containerType)

Deprecated. This might not be useful at all in this case since portlet is rarely needed now

Override attribute that specifies whether the URL will be generated for a servlet container or a portlet container. By default, the current container will be used. For practical purposes, leaving this blank or setting it to servlet should be sufficient. Legal values are servlet and portlet.

Parameters:

containerType - the container type

Returns:

a LegacyLinkInfo

forScheme

E forScheme(String scheme)

Attribute that allows the scheme to be set in the URL. The scheme in the case of most URLs refers to the protocol and is usually set to either http or https. If this is left blank (and authority is left blank) then the URL will be relative to the current scheme and authority.

Parameters:

scheme - the scheme value

Returns:

a LegacyLinkInfo

forAuthority

E forAuthority(String authority)

Attribute that allows the user to specify a fully-qualified URL, when used in conjunction with scheme. URLs are of the form scheme://authority/path?query#fragment. For most purposes, authority corresponds to host:port for the given application. Specifying scheme and authority allows for fully-qualified URLs to be created, which is useful for sites with multiple domains and in other cases.

Parameters:

authority - the full qualified url

Returns:

a LegacyLinkInfo

useWrapper

E useWrapper(String wrapper)

If the target uses an uncached wrapper page, supply this argument with the name of that SiteCatalog page

Parameters:

wrapper - the wrapper page name

Returns:

a LegacyLinkInfo

getWrapper

String getWrapper()

getAssembler

String getAssembler()

getSession

boolean getSession()

getDep

DependencyTypeEnum getDep()

getSatelliteContext

String getSatelliteContext()

getTType

String getTType()

getTid

String getTid()

getRendermode

String getRendermode()

getFragment

String getFragment()

getContainerType

String getContainerType()

getScheme

String getScheme()

getAuthority

String getAuthority()