Skip navigation links

oracle.stellent.wcm.server.request.url
Class UrlRequest

java.lang.Object
oracle.stellent.wcm.server.request.SiteRequest
oracle.stellent.wcm.server.request.url.UrlRequest

public class UrlRequest

extends SiteRequest

URL command draws URLs to other resources within the site hierarchy

Nested Class Summary

static class	UrlRequest.DCContext
static class	UrlRequest.UrlRoot The various roots of URL that is returned to the client
static class	UrlRequest.UrlType The type of urls

Nested classes/interfaces inherited from class oracle.stellent.wcm.server.request.SiteRequest

SiteRequest.ContextType, SiteRequest.Mode

Field Summary

static java.lang.String

DC_PAGE_NUM_POSTFIX

Fields inherited from class oracle.stellent.wcm.server.request.SiteRequest

FLAG_PREVIEW_ID, FLAG_PREVIEW_MODE, FLAG_SHOW_PLACEHOLDER_PROPERTIES, FLAG_START_REQUEST_THREAD, PARAM_ALLOW_DESIGN_MODE, PARAM_DESIGN_MODE, PARAM_FORCE_CONTRIBUTOR

Constructor Summary

UrlRequest(SiteLocation siteLocation)

UrlRequest(SiteLocation siteLocation, UrlRequest.UrlType type, java.lang.String url)
Create a URL request

Method Summary

UrlRequest.DCContext	getDcContext()
java.lang.String	getPlaceholder()
java.lang.String	getTargetSiteID()
UrlRequest.UrlType	getType()
java.lang.String	getUrl()
java.util.Map<UrlRequest.UrlRoot,java.lang.String>	getUrlPatterns()
boolean	isManagerPreview()
void	setDcContext(UrlRequest.DCContext dcContext)
void	setManagerPreview(boolean isPreview)
void	setPlaceholder(java.lang.String name) The name of the current placeholder (for UrlRequest.UrlType.DCPage links)
void	setTargetSiteID(java.lang.String siteID)
void	setType(UrlRequest.UrlType type)
void	setUrl(java.lang.String url)
void	setUrlPatterns(java.util.Map<UrlRequest.UrlRoot,java.lang.String> urlPatterns)

Methods inherited from class oracle.stellent.wcm.server.request.SiteRequest

clearTransientObjects, copyRequest, getFlag, getFlagNames, getIdcContext, getLocation, getMode, getRetrievalMode, getRevision, getSiteParameters, getTransientObject, isConsumptionMode, isContributionOrDesignerMode, isContributorMode, isDesignerMode, setFlag, setIdcContext, setLocation, setMode, setRetrievalMode, setRevision, setTransientObject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DC_PAGE_NUM_POSTFIX

public static final java.lang.String DC_PAGE_NUM_POSTFIX

See Also:

Constant Field Values

Constructor Detail

UrlRequest

public UrlRequest(SiteLocation siteLocation)

UrlRequest

public UrlRequest(SiteLocation siteLocation,
                  UrlRequest.UrlType type,
                  java.lang.String url)

Create a URL request

Parameters:

siteLocation - the site location

type - the url type

url - the url

Method Detail

setType

public void setType(UrlRequest.UrlType type)

Parameters:

type - the type of URL

getType

public UrlRequest.UrlType getType()

setUrl

public void setUrl(java.lang.String url)

Parameters:

url - the url value relative to the type

getUrl

public java.lang.String getUrl()

setManagerPreview

public void setManagerPreview(boolean isPreview)

isManagerPreview

public boolean isManagerPreview()

setTargetSiteID

public void setTargetSiteID(java.lang.String siteID)

Parameters:

siteID - the siteID of the site where the URL should link

getTargetSiteID

public java.lang.String getTargetSiteID()

setPlaceholder

public void setPlaceholder(java.lang.String name)

The name of the current placeholder (for UrlRequest.UrlType.DCPage links)

Parameters:

name - the current placeholder name

getPlaceholder

public java.lang.String getPlaceholder()

setUrlPatterns

public void setUrlPatterns(java.util.Map<UrlRequest.UrlRoot,java.lang.String> urlPatterns)

Overrides:

setUrlPatterns in class SiteRequest

Parameters:

urlPatterns - the url pattern to use for the various link types

getUrlPatterns

public java.util.Map<UrlRequest.UrlRoot,java.lang.String> getUrlPatterns()

Overrides:

getUrlPatterns in class SiteRequest

getDcContext

public UrlRequest.DCContext getDcContext()

setDcContext

public void setDcContext(UrlRequest.DCContext dcContext)

Skip navigation links