|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CustomItemBean
Represents a custom element within the WCM Authoring UI
Can be accessed within the JSP (which is set as the custom JSP of an element) via
the following code:
(CustomItemBean) request.getAttribute("CustomItemBean");
Method Summary | |
---|---|
java.lang.String |
getAuthoringTemplateId()
Returns the ID of the authoring template of the document associated with this CustomItemBean |
java.lang.String |
getDocumentPath()
Returns the path to the document associated with this CustomItemBean |
DocumentType |
getDocumentType()
Returns the DocumentType of the document associated with this CustomItemBean |
java.lang.String |
getElementName()
Returns the name of the element associated with this CustomItemBean |
java.lang.String |
getElementTitle()
Returns the title of the element associated with this CustomItemBean |
java.lang.String |
getEncoding()
Returns the current encoding used |
java.lang.String |
getFieldName()
Returns the internal name of the element associated with the CustomItemBean |
java.lang.Object |
getFieldValue()
Returns the value of the element associated with the CustomItemBean |
java.lang.String |
getId()
Returns the ID of the document associated with this CustomItemBean |
java.lang.String |
getProjectId()
Returns the ID of the Project associated with the Document opened in the authoring interface |
java.lang.String |
getSubmitFunctionName()
Returns the name of the Javascript Submit function used to set the value of the element associated with the CustomItemBean |
java.lang.String |
getVersionName()
When the Document opened in the authoring interface is a version, this method returns the name of the version |
boolean |
isDraft()
Returns true if the current document has a workflow status of 'draft' |
boolean |
isExpired()
Returns true if the current document has a workflow status of 'expired' |
boolean |
isFormReadOnly()
Returns true if the form being viewed in the authoring interface is currently in read mode |
boolean |
isNew()
Returns true if the Document opened in the authoring interface has never been saved. |
boolean |
isPublished()
Returns true if the current document has a workflow status of 'published' |
boolean |
isVersion()
Returns true if the Document opened in the authoring interface is a version. |
void |
setFieldValue(java.lang.Object p_fieldValue)
Sets the value of the element associated with the CustomItemBean |
void |
setSubmitFunctionName(java.lang.String p_fname)
Specifies the name of the Javascript Submit function used to set the value of the element associated with the CustomItemBean |
Method Detail |
---|
java.lang.String getFieldName()
This name will be unique to the WCM Authoring UI portlet on the page
java.lang.Object getFieldValue()
NULL
if
the element currently has no valuevoid setFieldValue(java.lang.Object p_fieldValue)
p_fieldValue
- the element value to setjava.lang.String getEncoding()
void setSubmitFunctionName(java.lang.String p_fname)
p_fname
- the name of the submit functionjava.lang.String getSubmitFunctionName()
java.lang.String getDocumentPath()
boolean isDraft()
true
if the current document is draft, false
otherwiseboolean isPublished()
true
if the current document is published, false
otherwiseboolean isExpired()
true
if the current document is expired, false
otherwisejava.lang.String getId()
java.lang.String getElementName()
java.lang.String getElementTitle()
DocumentType getDocumentType()
DocumentType
of the document associated with this CustomItemBean
DocumentType
of the document associated with this CustomItemBeanjava.lang.String getAuthoringTemplateId()
boolean isFormReadOnly()
true
if the form being viewed in the authoring interface is currently in read mode, false
otherwiseboolean isNew()
Document
opened in the authoring interface has never been saved.
true
if the Document
has never been saved.boolean isVersion()
Document
opened in the authoring interface is a version.
true
if the Document
is a version.java.lang.String getVersionName()
Document
opened in the authoring interface is a version, this method returns the name of the version
NULL
if the current Document
is not a versionjava.lang.String getProjectId()
Project
associated with the Document
opened in the authoring interface
Project
associated with the Document
opened in the authoring interface OR
NULL
if the Document
does not belong to a project
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |