com.ibm.workplace.wcm.api
Interface LibraryJSPComponent
- All Superinterfaces:
- Document, Editable, EditableLibraryComponent, LibraryComponent, WorkflowedDocument
public interface LibraryJSPComponent
- extends EditableLibraryComponent
Represents an JSP component that exists in the Component Library.
A LibraryJSPComponent is a LibraryComponent and
must be stored as a separate entity in the repository.
A JSP component contains a JSP path and error message. This interface provides
methods to retrieve and set the JSP path and error message.
note: since v6.0.0, a LibraryComponent is
referred to as a "Component" in the Authoring UI.
- See Also:
- LibraryComponent
Method Summary |
java.lang.String |
getErrorMessage()
Returns the error message contained in this component as a String. |
java.lang.String |
getJspPath()
Returns the JSP path contained in this component as a String. |
void |
setErrorMessage(java.lang.String errorMessage)
Sets the error message contained in this JSPComponent. |
void |
setJspPath(java.lang.String jspPath)
Sets the JSP path to be contained in this JSPComponent. |
Methods inherited from interface com.ibm.workplace.wcm.api.Document |
getAuthors, getContributorAccessMembers, getCreationDate, getDeleteAccessMembers, getDescription, getEditAccessMembers, getEditorAccessMembers, getHistoryLog, getId, getInheritedContributorAccessMembers, getInheritedEditorAccessMembers, getInheritedManagerAccessMembers, getInheritedUserAccessMembers, getLiveAccessMembers, getManagerAccessMembers, getModifiedDate, getName, getOwnerLibrary, getOwners, getReadAccessMembers, getSourceWorkspace, getTitle, getUserAccessMembers, hasDeleteAccess, hasDeleteAccess, hasEditAccess, hasEditAccess, hasLiveAccess, hasLiveAccess, hasReadAccess, hasReadAccess, isContributorAccessInherited, isEditorAccessInherited, isManagerAccessInherited, isUserAccessInherited, isWorkflowed |
Methods inherited from interface com.ibm.workplace.wcm.api.Editable |
addAuthors, addContributorAccessMembers, addDeleteAccessMembers, addEditAccessMembers, addEditorAccessMembers, addHistoryLogEntry, addLiveAccessMembers, addManagerAccessMembers, addOwners, addReadAccessMembers, addUserAccessMembers, isChanged, removeAuthors, removeContributorAccessMembers, removeDeleteAccessMembers, removeEditAccessMembers, removeEditorAccessMembers, removeLiveAccessMembers, removeManagerAccessMembers, removeOwners, removeReadAccessMembers, removeUserAccessMembers, setContributorAccessInheritance, setDescription, setEditorAccessInheritance, setManagerAccessInheritance, setName, setTitle, setUserAccessInheritance |
Methods inherited from interface com.ibm.workplace.wcm.api.Document |
getAuthors, getContributorAccessMembers, getCreationDate, getDeleteAccessMembers, getDescription, getEditAccessMembers, getEditorAccessMembers, getHistoryLog, getId, getInheritedContributorAccessMembers, getInheritedEditorAccessMembers, getInheritedManagerAccessMembers, getInheritedUserAccessMembers, getLiveAccessMembers, getManagerAccessMembers, getModifiedDate, getName, getOwnerLibrary, getOwners, getReadAccessMembers, getSourceWorkspace, getTitle, getUserAccessMembers, hasDeleteAccess, hasDeleteAccess, hasEditAccess, hasEditAccess, hasLiveAccess, hasLiveAccess, hasReadAccess, hasReadAccess, isContributorAccessInherited, isEditorAccessInherited, isManagerAccessInherited, isUserAccessInherited, isWorkflowed |
Methods inherited from interface com.ibm.workplace.wcm.api.WorkflowedDocument |
addAdditionalViewers, addApprovers, cancelDraftDocument, createDraftDocument, decline, getAdditionalViewers, getCurrentApprovers, getEffectiveDate, getExpiryDate, getGeneralDateOne, getGeneralDateTwo, getWorkflowId, getWorkflowStageId, hasApproverAccess, hasApproverAccess, hasDraft, isDraft, isExpired, isPublished, nextWorkflowStage, nextWorkflowStage, removeAdditionalViewers, removeApprovers, restartWorkflow, setEffectiveDate, setExpiryDate, setGeneralDateOne, setGeneralDateTwo, setWorkflowId, setWorkflowId |
getJspPath
java.lang.String getJspPath()
- Returns the JSP path contained in this component as a String.
- Returns:
- the path to the JSP
setJspPath
void setJspPath(java.lang.String jspPath)
- Sets the JSP path to be contained in this JSPComponent.
- Parameters:
- jspPath - the JSP path
getErrorMessage
java.lang.String getErrorMessage()
- Returns the error message contained in this component as a String.
- Returns:
- the error message
setErrorMessage
void setErrorMessage(java.lang.String errorMessage)
- Sets the error message contained in this JSPComponent.
- Parameters:
- errorMessage - the JSP path