atg.epub.pws.taglib
Class CreateVersionManagerURITag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      atg.web.tagsupport.PageVariableTagSupport
          atg.web.tagsupport.CountTagSupport
              atg.epub.pws.taglib.PWSResourceFileTagSupport
                  atg.epub.pws.taglib.CreateVersionManagerURITag

All Implemented Interfaces:

java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class CreateVersionManagerURITag
extends atg.epub.pws.taglib.PWSResourceFileTagSupport

Tag for generating a version manager uri string for repository or file assets

See Also:

VersionManagerURI, Serialized Form

Nested Class Summary

static class

CreateVersionManagerURITag.TEI TagExtraInfo class to handle var/id processing.

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Fields inherited from class atg.web.tagsupport.CountTagSupport

mCount, mIndex, mTotalCountVar

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

id, pageContext

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

CreateVersionManagerURITag()
Empty Constructor

Method Summary

int	doStartTag() Tag which creates a version manager URI string with the given inputs.
java.lang.String	getComponentName() Sets the componentName portion of the URI.
java.lang.String	getItemDescriptorName()
java.lang.String	getItemId()
java.lang.Object	getObject()
RepositoryItem	getRepositoryItem()
java.lang.String	getVersionManagerName()
VirtualFile	getVirtualFile()
java.lang.String	getVirtualFilePath()
void	release()
void	setComponentName(java.lang.String string)
void	setItemDescriptorName(java.lang.String string) Sets the itemDescriptor portion of the URI.
void	setItemId(java.lang.String string) Sets the itemId portion of the URI.
void	setObject(java.lang.Object o) Sets the object to create the URI for, no other properties need to be supplied if this property is set
void	setRepositoryItem(RepositoryItem item) Sets the repository item to create the URI for, no other properties need to be supplied if this property is set
void	setVersionManagerName(java.lang.String string) Sets the version manager name portion of the URI.
void	setVirtualFile(VirtualFile file) Sets the virtual file to create the URI for, no other properties need to be supplied if this property is set
void	setVirtualFilePath(java.lang.String string) Sets the virtual file path portion of the URI.

Methods inherited from class atg.epub.pws.taglib.PWSResourceFileTagSupport

getResource, getResource

Methods inherited from class atg.web.tagsupport.CountTagSupport

getCount, getCountAsInt, getIndex, getIndexAsInt, getTotalCountVar, setCount, setIndex, setTotalCount, setTotalCount, setTotalCountVar

Methods inherited from class atg.web.tagsupport.PageVariableTagSupport

getDynamoRequest, getId, getVar, isBlank, setId, setPageVariable, setScope, setVar

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

doAfterBody, doEndTag, findAncestorWithClass, getParent, getValue, getValues, removeValue, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

CreateVersionManagerURITag

public CreateVersionManagerURITag()

Empty Constructor

Method Detail

setVersionManagerName

public void setVersionManagerName(java.lang.String string)

Sets the version manager name portion of the URI. Default is set to PublishingVersionManager and should not need to be changed.

Parameters:

string - the version manager name portion of the URI.

getVersionManagerName

public java.lang.String getVersionManagerName()

Returns:

the version manager name portion of the URI. Default is PublishingVersionManager

getComponentName

public java.lang.String getComponentName()

Sets the componentName portion of the URI. The itemDescriptor and itemId or virtualFilePath properties must also be set if this property is supplied.

Parameters:

string - the componentName portion of the URI

setComponentName

public void setComponentName(java.lang.String string)

setItemDescriptorName

public void setItemDescriptorName(java.lang.String string)

Sets the itemDescriptor portion of the URI. The componentName and itemId properties must also be set if this property is supplied.

Parameters:

string - the itemDescriptor portion of the URI

getItemDescriptorName

public java.lang.String getItemDescriptorName()

Returns:

the itemDescriptor portion of the URI

setItemId

public void setItemId(java.lang.String string)

Sets the itemId portion of the URI. The componentName and itemDescriptor properties must also be set if this property is supplied.

Parameters:

string - the itemId portion of the URI

getItemId

public java.lang.String getItemId()

Returns:

the itemId portion of the URI

setVirtualFilePath

public void setVirtualFilePath(java.lang.String string)

Sets the virtual file path portion of the URI. The componentName property must also be set if this property is supplied.

Parameters:

string - the virtual file path portion of the URI

getVirtualFilePath

public java.lang.String getVirtualFilePath()

Returns:

the virtual file path portion of the URI

setRepositoryItem

public void setRepositoryItem(RepositoryItem item)

Sets the repository item to create the URI for, no other properties need to be supplied if this property is set

Parameters:

the - repository item to create the URI for

getRepositoryItem

public RepositoryItem getRepositoryItem()

Returns:

the repository item to create the URI for

setVirtualFile

public void setVirtualFile(VirtualFile file)

Sets the virtual file to create the URI for, no other properties need to be supplied if this property is set

Parameters:

the - virtual file to create the URI for

getVirtualFile

public VirtualFile getVirtualFile()

Returns:

the virtual file to create the URI for

setObject

public void setObject(java.lang.Object o)

Sets the object to create the URI for, no other properties need to be supplied if this property is set

Parameters:

the - object to create the URI for

getObject

public java.lang.Object getObject()

Returns:

the object to create the URI for

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException

Tag which creates a version manager URI string with the given inputs. The inputs can be one of the following combinations: 1) repositoryItem (for a repository or file asset, tag will determine type) 2) componentName, itemDescriptor, itemId (for a repository asset) 3) componentName, virtualFilePath (for a file asset) This tag will set the URI into the page variable if one is supplied, otherwise it will output the string to the output stream of the page.

Specified by:

doStartTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doStartTag in class javax.servlet.jsp.tagext.TagSupport

Throws:

javax.servlet.jsp.JspException - if the set of inputs is invalid or incomplete or if a repository error occurs

See Also:

VersionManagerURI, GetAssetTag

release

public void release()

Specified by:

release in interface javax.servlet.jsp.tagext.Tag

Overrides:

release in class atg.web.tagsupport.CountTagSupport

See Also:

Tag.release()