atg.epub.pws.taglib
Class GetAssetTag
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.GetAssetTag
- All Implemented Interfaces:
- java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag
public class GetAssetTag
- extends atg.epub.pws.taglib.PWSResourceFileTagSupport
Tag for obtaining an asset given a URI string or a working version given a URI
and a workspace name.
- See Also:
VersionManagerURI
,
GetAssetTag.Results
,
CreateVersionManagerURITag
,
Serialized Form
Nested Class Summary |
class |
GetAssetTag.Results
Results class for returning output for this tag |
static class |
GetAssetTag.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 |
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 |
CLASS_VERSION
public static java.lang.String CLASS_VERSION
- Class version string
GetAssetTag
public GetAssetTag()
- Empty Constructor
seturi
public void seturi(java.lang.String pURI)
- Sets the asset uri string or version manager URI string to return an asset for
- Parameters:
pURI
- a version manager URI string- See Also:
VersionManagerURI
geturi
public java.lang.String geturi()
- Returns:
- the version manager URI string to return an asset for
setWorkspaceName
public void setWorkspaceName(java.lang.String pWorkspaceName)
- Sets the optional workspaceName of the workspace to get the working version for
- Parameters:
pWorkspaceName
- the name of the workspace to get the working version for
getWorkspaceName
public java.lang.String getWorkspaceName()
- Returns:
- the workspace name of the asset's working version
setUseWorkspaceInSession
public void setUseWorkspaceInSession(boolean pBool)
- Instructs the tag to use the workspace in the session as the context. If workspaceName is
set, then this property is ignored.
getUseWorkspaceInSession
public boolean getUseWorkspaceInSession()
- Returns:
- the value of the flag useWorkspaceInSession
setAllowFileRepositoryItems
public void setAllowFileRepositoryItems(boolean pBool)
- Instructs the tag to set the repositoryItem property in the results object,
even when the virtualFile property is also set.
getAllowFileRepositoryItems
public boolean getAllowFileRepositoryItems()
- Returns:
- the value of the flag allowFileRepositoryItems
doStartTag
public int doStartTag()
throws javax.servlet.jsp.JspException
- Returns a Results object which contains the asset of the given URI. The
working version of the asset in the given workspace is also returned if
the workspaceName was supplied.
- 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 an empty or invalid URI is supplied- See Also:
GetAssetTag.Results
,
CreateVersionManagerURITag
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()