com.ibm.workplace.wcm.api
Interface LibraryJSPComponent
- All Superinterfaces:
- Document, Editable, EditableItem, EditableLibraryComponent, Hierarchical, Item, LibraryComponent, Localized, WCMApiObject, 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.Editable |
addAuthors, addCategoryIds, addContributorAccessMembers, addDeleteAccessMembers, addEditAccessMembers, addEditorAccessMembers, addHistoryLogEntry, addLiveAccessMembers, addManagerAccessMembers, addMembersForAccess, addOwners, addReadAccessMembers, addUserAccessMembers, isChanged, removeAuthors, removeCategoryIds, removeContributorAccessMembers, removeDeleteAccessMembers, removeEditAccessMembers, removeEditorAccessMembers, removeLiveAccessMembers, removeManagerAccessMembers, removeMembersForAccess, removeOwners, removeReadAccessMembers, removeUserAccessMembers, setContributorAccessInheritance, setDescriptionTextProviderKey, setDescriptionTextProviderName, setEditorAccessInheritance, setInheritance, setKeywords, setManagerAccessInheritance, setPropagation, setTitleTextProviderKey, setTitleTextProviderName, setUserAccessInheritance |
Methods inherited from interface com.ibm.workplace.wcm.api.Document |
getAuthors, getCategoryIds, getContributorAccessMembers, getCreator, getDeleteAccessMembers, getDescription, getDescriptionTextProviderKey, getDescriptionTextProviderName, getEditAccessMembers, getEditorAccessMembers, getHistoryLog, getId, getInheritedContributorAccessMembers, getInheritedEditorAccessMembers, getInheritedManagerAccessMembers, getInheritedUserAccessMembers, getKeywords, getLastModifier, getLiveAccessMembers, getManagerAccessMembers, getMembersForAccess, getMembersForInheritedAccess, getOwnerLibrary, getOwners, getProject, getReadAccessMembers, getSourceWorkspace, getTitle, getTitleTextProviderKey, getTitleTextProviderName, getUserAccessMembers, getVersionCatalog, getVersionStrategy, hasDeleteAccess, hasDeleteAccess, hasEditAccess, hasEditAccess, hasLiveAccess, hasLiveAccess, hasProfile, hasProject, hasReadAccess, hasReadAccess, isContributorAccessInherited, isEditorAccessInherited, isInherited, isManagerAccessInherited, isNew, isPropagated, isUserAccessInherited, isWorkflowed |
Methods inherited from interface com.ibm.workplace.wcm.api.WorkflowedDocument |
addAdditionalViewers, addApprovers, approve, cancelDraftDocument, clearApprovers, createDraftDocument, decline, decline, getAdditionalViewers, getCurrentApprovers, getDateEnteredStage, getEffectiveDate, getExpiryDate, getGeneralDateOne, getGeneralDateTwo, getPendingWorkflowStatus, getPublishedDate, getPublishedId, getWorkflowId, getWorkflowStageId, getWorkflowStatus, hasApproverAccess, hasApproverAccess, hasDraft, isDraft, isDraftOfPublishedDocument, isExpired, isPublished, isWorkflowMovingBackward, nextWorkflowStage, nextWorkflowStage, nextWorkflowStage, previousWorkflowStage, previousWorkflowStage, 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