A C D E F G H I L N O P R S T U W

A

AuthoringTemplate - interface com.ibm.workplace.wcm.api.AuthoringTemplate.
Represents an authoring template.
AuthoringTemplate - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for AuthoringTemplate
AuthorizationException - exception com.ibm.workplace.wcm.api.exceptions.AuthorizationException.
The AuthorizationException is thrown if the API user attempts to access a content that they do not have the appropriate access to.
AuthorizationException() - Constructor for class com.ibm.workplace.wcm.api.exceptions.AuthorizationException
Constructor.
AuthorizationException(String) - Constructor for class com.ibm.workplace.wcm.api.exceptions.AuthorizationException
Constructs a new exception with the given message.
AuthorizationException(Throwable) - Constructor for class com.ibm.workplace.wcm.api.exceptions.AuthorizationException
Constructor to only be used by sub classes
AuthorizationException(String, Throwable) - Constructor for class com.ibm.workplace.wcm.api.exceptions.AuthorizationException
Constructor that requires detail plus a cause exception
addAdditionalViewers(String[]) - Method in interface com.ibm.workplace.wcm.api.Content
Adds names to the list of additional live viewers for this Content document.
addAuthors(String[]) - Method in interface com.ibm.workplace.wcm.api.Editable
Adds each author specified in the string array argument to the authors of this Editable object.
addAuthors(String[]) - Method in interface com.ibm.workplace.wcm.api.EditableLibraryComponent
Adds each name specified in the string array argument to the authors of this EditableLibraryComponent object.
addCategoryIds(DocumentId[]) - Method in interface com.ibm.workplace.wcm.api.Content
Add categories to this content.
addContent(DocumentId) - Method in interface com.ibm.workplace.wcm.api.SiteArea
Adds the Content with the specified DocumentId as the last child of this SiteArea.
addDeleteAccessMembers(String[]) - Method in interface com.ibm.workplace.wcm.api.Editable
Adds each name specified in the string array argument to the members who have Delete access to this Editable object.
addDeleteAccessMembers(String[]) - Method in interface com.ibm.workplace.wcm.api.EditableLibraryComponent
Adds each name specified in the string array argument to the members that have Delete access to this EditableLibraryComponent object.
addEditAccessMembers(String[]) - Method in interface com.ibm.workplace.wcm.api.Editable
Adds each name specified in the string array argument to the members who have Edit access to this Editable object.
addEditAccessMembers(String[]) - Method in interface com.ibm.workplace.wcm.api.EditableLibraryComponent
Adds each name specified in the string array argument to the members that have Edit access to this EditableLibraryComponent object.
addImage(String, File) - Method in class com.ibm.workplace.wcm.api.EmbeddedImageMap
Add an image URL and the binary for an image to the image map.
addLiveAccessMembers(String[]) - Method in interface com.ibm.workplace.wcm.api.Editable
Adds each name specified in the string array argument to the members who have Live access to this Editable object.
addLiveAccessMembers(String[]) - Method in interface com.ibm.workplace.wcm.api.EditableLibraryComponent
Adds each name specified in the string array argument to the members that have Live access to this EditableLibraryComponent object.
addOwners(String[]) - Method in interface com.ibm.workplace.wcm.api.Editable
Adds each owner specified in the string array argument to the owners of this Editable object.
addOwners(String[]) - Method in interface com.ibm.workplace.wcm.api.EditableLibraryComponent
Adds each name specified in the string array argument to the owners of this EditableLibraryComponent object.
addReadAccessMembers(String[]) - Method in interface com.ibm.workplace.wcm.api.Editable
Adds each name specified in the string array argument to the members who have Read access to this Editable object.
addReadAccessMembers(String[]) - Method in interface com.ibm.workplace.wcm.api.EditableLibraryComponent
Adds each name specified in the string array argument to the members that have Read access to this EditableLibraryComponent object.
addSiteArea(DocumentId) - Method in interface com.ibm.workplace.wcm.api.SiteFrameworkContainer
Adds the SiteArea with a DocumentId specified by p_siteAreaId as the last child of this Site or SiteArea.
addTemplateMapping(DocumentId, DocumentId) - Method in interface com.ibm.workplace.wcm.api.SiteFrameworkContainer
Adds a mapping for the specified AuthoringTemplate and PresentationTemplate.

C

COPYRIGHT - Static variable in interface com.ibm.workplace.wcm.api.AuthoringTemplate
Copyright statement
COPYRIGHT - Static variable in interface com.ibm.workplace.wcm.api.Category
Copyright statement
COPYRIGHT - Static variable in interface com.ibm.workplace.wcm.api.Content
Copyright statement
COPYRIGHT - Static variable in interface com.ibm.workplace.wcm.api.ContentComponent
Copyright statement
COPYRIGHT - Static variable in interface com.ibm.workplace.wcm.api.ContentComponentContainer
Copyright statement
COPYRIGHT - Static variable in interface com.ibm.workplace.wcm.api.ContentComponentIterator
Copyright statement
COPYRIGHT - Static variable in interface com.ibm.workplace.wcm.api.Document
Copyright statement
COPYRIGHT - Static variable in interface com.ibm.workplace.wcm.api.DocumentId
Copyright statement
COPYRIGHT - Static variable in interface com.ibm.workplace.wcm.api.DocumentIdIterator
Copyright statement
COPYRIGHT - Static variable in interface com.ibm.workplace.wcm.api.DocumentType
Copyright statement
COPYRIGHT - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
Copyright statement
COPYRIGHT - Static variable in interface com.ibm.workplace.wcm.api.Editable
Copyright statement
COPYRIGHT - Static variable in interface com.ibm.workplace.wcm.api.EditableLibraryComponent
Copyright statement
COPYRIGHT - Static variable in class com.ibm.workplace.wcm.api.EmbeddedImageMap
Copyright statement
COPYRIGHT - Static variable in interface com.ibm.workplace.wcm.api.FileComponent
Copyright statement
COPYRIGHT - Static variable in interface com.ibm.workplace.wcm.api.HTMLComponent
Copyright statement
COPYRIGHT - Static variable in interface com.ibm.workplace.wcm.api.ImageComponent
Copyright statement
COPYRIGHT - Static variable in interface com.ibm.workplace.wcm.api.LibraryComponent
Copyright statement
COPYRIGHT - Static variable in interface com.ibm.workplace.wcm.api.LibraryFileComponent
Copyright statement
COPYRIGHT - Static variable in interface com.ibm.workplace.wcm.api.LibraryHTMLComponent
Copyright statement
COPYRIGHT - Static variable in interface com.ibm.workplace.wcm.api.LibraryImageComponent
Copyright statement
COPYRIGHT - Static variable in interface com.ibm.workplace.wcm.api.PresentationTemplate
Copyright statement
COPYRIGHT - Static variable in interface com.ibm.workplace.wcm.api.ReferenceComponent
Copyright statement
COPYRIGHT - Static variable in interface com.ibm.workplace.wcm.api.RenderingContext
Copyright statement
COPYRIGHT - Static variable in interface com.ibm.workplace.wcm.api.Repository
Copyright statement
COPYRIGHT - Static variable in interface com.ibm.workplace.wcm.api.RichTextComponent
Copyright statement
COPYRIGHT - Static variable in interface com.ibm.workplace.wcm.api.Site
Copyright statement
COPYRIGHT - Static variable in interface com.ibm.workplace.wcm.api.SiteArea
Copyright statement
COPYRIGHT - Static variable in interface com.ibm.workplace.wcm.api.SiteFrameworkContainer
Copyright statement
COPYRIGHT - Static variable in interface com.ibm.workplace.wcm.api.Taxonomy
Copyright statement
COPYRIGHT - Static variable in interface com.ibm.workplace.wcm.api.TextComponent
Copyright statement
COPYRIGHT - Static variable in interface com.ibm.workplace.wcm.api.UserProfile
Copyright statement
COPYRIGHT - Static variable in class com.ibm.workplace.wcm.api.WCM_API
Copyright statement
COPYRIGHT - Static variable in interface com.ibm.workplace.wcm.api.Workflow
Copyright statement
COPYRIGHT - Static variable in interface com.ibm.workplace.wcm.api.WorkflowStage
Copyright statement
COPYRIGHT - Static variable in interface com.ibm.workplace.wcm.api.Workspace
Copyright statement
COPYRIGHT - Static variable in class com.ibm.workplace.wcm.api.exceptions.AuthorizationException
Copyright statement
COPYRIGHT - Static variable in class com.ibm.workplace.wcm.api.exceptions.ComponentNotFoundException
Copyright statement
COPYRIGHT - Static variable in class com.ibm.workplace.wcm.api.exceptions.DocumentCreationException
Copyright statement
COPYRIGHT - Static variable in class com.ibm.workplace.wcm.api.exceptions.DocumentDeleteException
Copyright statement
COPYRIGHT - Static variable in class com.ibm.workplace.wcm.api.exceptions.DocumentIdCreationException
Copyright statement
COPYRIGHT - Static variable in class com.ibm.workplace.wcm.api.exceptions.DocumentNotFoundException
Copyright statement
COPYRIGHT - Static variable in class com.ibm.workplace.wcm.api.exceptions.DocumentRetrievalException
Copyright statement
COPYRIGHT - Static variable in class com.ibm.workplace.wcm.api.exceptions.DocumentSaveException
Copyright statement
COPYRIGHT - Static variable in class com.ibm.workplace.wcm.api.exceptions.DuplicateChildException
Copyright statement
COPYRIGHT - Static variable in class com.ibm.workplace.wcm.api.exceptions.DuplicateMappingException
Copyright statement
COPYRIGHT - Static variable in class com.ibm.workplace.wcm.api.exceptions.IllegalDocumentTypeException
Copyright statement
COPYRIGHT - Static variable in class com.ibm.workplace.wcm.api.exceptions.IllegalTypeChangeException
Copyright statement
COPYRIGHT - Static variable in class com.ibm.workplace.wcm.api.exceptions.NoMoreWorkflowStagesException
Copyright statement
COPYRIGHT - Static variable in class com.ibm.workplace.wcm.api.exceptions.OperationFailedException
Copyright statement
COPYRIGHT - Static variable in class com.ibm.workplace.wcm.api.exceptions.PropertyRetrievalException
Copyright statement
COPYRIGHT - Static variable in class com.ibm.workplace.wcm.api.exceptions.ServiceNotAvailableException
Copyright statement
COPYRIGHT - Static variable in class com.ibm.workplace.wcm.api.exceptions.WCMException
Copyright statement
Category - interface com.ibm.workplace.wcm.api.Category.
Represents a Category in the repository.
Category - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for Category
ComponentNotFoundException - exception com.ibm.workplace.wcm.api.exceptions.ComponentNotFoundException.
A ComponentNotFoundException is thrown if the API user attempts to access a component that does not exist.
ComponentNotFoundException() - Constructor for class com.ibm.workplace.wcm.api.exceptions.ComponentNotFoundException
Constructor.
ComponentNotFoundException(String) - Constructor for class com.ibm.workplace.wcm.api.exceptions.ComponentNotFoundException
Constructs a new exception with the given message.
ComponentNotFoundException(Throwable) - Constructor for class com.ibm.workplace.wcm.api.exceptions.ComponentNotFoundException
Constructor to only be used by sub classes
ComponentNotFoundException(String, Throwable) - Constructor for class com.ibm.workplace.wcm.api.exceptions.ComponentNotFoundException
Constructor that requires detail plus a cause exception
Content - interface com.ibm.workplace.wcm.api.Content.
A Content object represents a Content item in the WCM repository.
Content - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for Content
ContentComponent - interface com.ibm.workplace.wcm.api.ContentComponent.
The root interface in the Content Component hierarchy.
ContentComponentContainer - interface com.ibm.workplace.wcm.api.ContentComponentContainer.
The root inteface for the content component container hierarchy.
ContentComponentIterator - interface com.ibm.workplace.wcm.api.ContentComponentIterator.
ContentComponentIterator, as the name suggests, iterates over ContentComponent objects in a ContentComponentContainer.
com.ibm.workplace.wcm.api - package com.ibm.workplace.wcm.api
This package defines the Lotus Workplace Web Content Management API.
com.ibm.workplace.wcm.api.exceptions - package com.ibm.workplace.wcm.api.exceptions
This package defines the exceptions used in the Lotus Workplace Web Content Management API.
componentIterator() - Method in interface com.ibm.workplace.wcm.api.ContentComponentContainer
Returns an iterator of all ContentComponent objects in this ContentComponentContainer.
containsKey(String) - Method in class com.ibm.workplace.wcm.api.EmbeddedImageMap
Determines if the embedded image map contains the specified key.
contentSearch(DocumentId, DocumentId[], DocumentId[], String[]) - Method in interface com.ibm.workplace.wcm.api.Workspace
Returns an iterator of IDs of objects that match the given search criteria.
contentSearch(DocumentId, DocumentId[], DocumentId[], String[], boolean) - Method in interface com.ibm.workplace.wcm.api.Workspace
Returns an iterator of IDs of objects that match the given search criteria.
createContent(DocumentId) - Method in interface com.ibm.workplace.wcm.api.Workspace
Creates a new Content object, based on an AuthoringTemplate.
createDocumentId(String) - Method in interface com.ibm.workplace.wcm.api.Workspace
Creates a new DocumentId object from a String representation of the ID.
createDraft() - Method in interface com.ibm.workplace.wcm.api.Content
Create draft copy of this content object.
createFileComponent() - Method in interface com.ibm.workplace.wcm.api.Workspace
Creates a new LibraryFileComponent.
createHTMLComponent() - Method in interface com.ibm.workplace.wcm.api.Workspace
Creates a new LibraryHTMLComponent.
createImageComponent() - Method in interface com.ibm.workplace.wcm.api.Workspace
Creates a new LibraryImageComponent.
createRenderingContext(ServletRequest, ServletResponse, Map) - Method in interface com.ibm.workplace.wcm.api.Workspace
Creates a new rendering context.
createRenderingContext(ServletRequest, ServletResponse, Map, String, String) - Method in interface com.ibm.workplace.wcm.api.Workspace
Creates a new rendering context.
createRenderingContext(PortletRequest, PortletResponse, Map) - Method in interface com.ibm.workplace.wcm.api.Workspace
Creates a new rendering context.
createRenderingContext(PortletRequest, PortletResponse, Map, String, String) - Method in interface com.ibm.workplace.wcm.api.Workspace
Creates a new rendering context.
createSite() - Method in interface com.ibm.workplace.wcm.api.Workspace
Creates a new Site.
createSiteArea() - Method in interface com.ibm.workplace.wcm.api.Workspace
Creates a new SiteArea.

D

Document - interface com.ibm.workplace.wcm.api.Document.
An interface defining an object that exists as an entity in the repository.
DocumentCreationException - exception com.ibm.workplace.wcm.api.exceptions.DocumentCreationException.
This exception is thrown if an error occurs while attempting to create a Document in the repository.
DocumentCreationException() - Constructor for class com.ibm.workplace.wcm.api.exceptions.DocumentCreationException
Constructor.
DocumentCreationException(String) - Constructor for class com.ibm.workplace.wcm.api.exceptions.DocumentCreationException
Constructs a new exception with the given message.
DocumentCreationException(Throwable) - Constructor for class com.ibm.workplace.wcm.api.exceptions.DocumentCreationException
Constructor to only be used by sub classes
DocumentCreationException(String, Throwable) - Constructor for class com.ibm.workplace.wcm.api.exceptions.DocumentCreationException
Constructor that requires detail plus a cause exception
DocumentDeleteException - exception com.ibm.workplace.wcm.api.exceptions.DocumentDeleteException.
This exception is thrown if an error occurs while trying to delete a Document from the repository.
DocumentDeleteException() - Constructor for class com.ibm.workplace.wcm.api.exceptions.DocumentDeleteException
Constructor.
DocumentDeleteException(String) - Constructor for class com.ibm.workplace.wcm.api.exceptions.DocumentDeleteException
Constructs a new exception with the given message.
DocumentDeleteException(Throwable) - Constructor for class com.ibm.workplace.wcm.api.exceptions.DocumentDeleteException
Constructor to only be used by sub classes
DocumentDeleteException(String, Throwable) - Constructor for class com.ibm.workplace.wcm.api.exceptions.DocumentDeleteException
Constructor that requires detail plus a cause exception
DocumentId - interface com.ibm.workplace.wcm.api.DocumentId.
Represents the ID of a Document in the repository.
DocumentIdCreationException - exception com.ibm.workplace.wcm.api.exceptions.DocumentIdCreationException.
This exception is thrown if a DocumentId could not be created.
DocumentIdCreationException() - Constructor for class com.ibm.workplace.wcm.api.exceptions.DocumentIdCreationException
Constructor.
DocumentIdCreationException(String) - Constructor for class com.ibm.workplace.wcm.api.exceptions.DocumentIdCreationException
Constructs a new exception with the given message.
DocumentIdCreationException(Throwable) - Constructor for class com.ibm.workplace.wcm.api.exceptions.DocumentIdCreationException
Constructor to only be used by sub classes
DocumentIdCreationException(String, Throwable) - Constructor for class com.ibm.workplace.wcm.api.exceptions.DocumentIdCreationException
Constructor that requires detail plus a cause exception
DocumentIdIterator - interface com.ibm.workplace.wcm.api.DocumentIdIterator.
DocumentIdIterator iterates over DocumentId objects.
DocumentNotFoundException - exception com.ibm.workplace.wcm.api.exceptions.DocumentNotFoundException.
A DocumentNotFoundException is thrown if the Document being accessed could not be found in the repository.
DocumentNotFoundException() - Constructor for class com.ibm.workplace.wcm.api.exceptions.DocumentNotFoundException
Constructor.
DocumentNotFoundException(String) - Constructor for class com.ibm.workplace.wcm.api.exceptions.DocumentNotFoundException
Constructs a new exception with the given message.
DocumentNotFoundException(Throwable) - Constructor for class com.ibm.workplace.wcm.api.exceptions.DocumentNotFoundException
Constructor to only be used by sub classes
DocumentNotFoundException(String, Throwable) - Constructor for class com.ibm.workplace.wcm.api.exceptions.DocumentNotFoundException
Constructor that requires detail plus a cause exception
DocumentRetrievalException - exception com.ibm.workplace.wcm.api.exceptions.DocumentRetrievalException.
This exception is thrown if an error occurs while attempting to retrieve a Document from the repository.
DocumentRetrievalException() - Constructor for class com.ibm.workplace.wcm.api.exceptions.DocumentRetrievalException
Constructor.
DocumentRetrievalException(String) - Constructor for class com.ibm.workplace.wcm.api.exceptions.DocumentRetrievalException
Constructs a new exception with the given message.
DocumentRetrievalException(Throwable) - Constructor for class com.ibm.workplace.wcm.api.exceptions.DocumentRetrievalException
Constructor to only be used by sub classes
DocumentRetrievalException(String, Throwable) - Constructor for class com.ibm.workplace.wcm.api.exceptions.DocumentRetrievalException
Constructor that requires detail plus a cause exception
DocumentSaveException - exception com.ibm.workplace.wcm.api.exceptions.DocumentSaveException.
This exception is thrown if an error occurs while saving a Document to the repository.
DocumentSaveException() - Constructor for class com.ibm.workplace.wcm.api.exceptions.DocumentSaveException
Constructor.
DocumentSaveException(String) - Constructor for class com.ibm.workplace.wcm.api.exceptions.DocumentSaveException
Constructs a new exception with the given message.
DocumentSaveException(Throwable) - Constructor for class com.ibm.workplace.wcm.api.exceptions.DocumentSaveException
Constructor to only be used by sub classes
DocumentSaveException(String, Throwable) - Constructor for class com.ibm.workplace.wcm.api.exceptions.DocumentSaveException
Constructor that requires detail plus a cause exception
DocumentType - interface com.ibm.workplace.wcm.api.DocumentType.
This interface is used to define the types of documents that are available to the API.
DocumentTypes - interface com.ibm.workplace.wcm.api.DocumentTypes.
This interface holds constants that define each of the DocumentTypes that are known to the API.
DuplicateChildException - exception com.ibm.workplace.wcm.api.exceptions.DuplicateChildException.
A DuplicateChildException is thrown if attempting to add a child Document to a parent that already considers the Document to be its child.
DuplicateChildException() - Constructor for class com.ibm.workplace.wcm.api.exceptions.DuplicateChildException
Constructor.
DuplicateChildException(String) - Constructor for class com.ibm.workplace.wcm.api.exceptions.DuplicateChildException
Constructs a new exception with the given message.
DuplicateChildException(Throwable) - Constructor for class com.ibm.workplace.wcm.api.exceptions.DuplicateChildException
Constructor to only be used by sub classes
DuplicateChildException(String, Throwable) - Constructor for class com.ibm.workplace.wcm.api.exceptions.DuplicateChildException
Constructor that requires detail plus a cause exception
DuplicateMappingException - exception com.ibm.workplace.wcm.api.exceptions.DuplicateMappingException.
This exception is thrown if the AuthoringTemplate to PresentationTemplate mapping already exists for the Document.
DuplicateMappingException() - Constructor for class com.ibm.workplace.wcm.api.exceptions.DuplicateMappingException
Constructor.
DuplicateMappingException(String) - Constructor for class com.ibm.workplace.wcm.api.exceptions.DuplicateMappingException
Constructs a new exception with the given message.
DuplicateMappingException(Throwable) - Constructor for class com.ibm.workplace.wcm.api.exceptions.DuplicateMappingException
Constructor to only be used by sub classes
DuplicateMappingException(String, Throwable) - Constructor for class com.ibm.workplace.wcm.api.exceptions.DuplicateMappingException
Constructor that requires detail plus a cause exception
decline() - Method in interface com.ibm.workplace.wcm.api.Content
Declines this document.
delete(DocumentId) - Method in interface com.ibm.workplace.wcm.api.Workspace
Deletes an editable document from the WCM repository.

E

ERR_APTRIX - Static variable in class com.ibm.workplace.wcm.api.exceptions.WCMException
The default error code
Editable - interface com.ibm.workplace.wcm.api.Editable.
Defines the behaviour for editable objects within the API.
EditableLibraryComponent - interface com.ibm.workplace.wcm.api.EditableLibraryComponent.
The EditableLibraryComponent interface represents components that can be stored in the repository that are both Editable through this API and a Library Component.
EmbeddedImageMap - class com.ibm.workplace.wcm.api.EmbeddedImageMap.
Map for managing the embedded images for uploading into WCM.
EmbeddedImageMap() - Constructor for class com.ibm.workplace.wcm.api.EmbeddedImageMap
Default constructor
endWorkspace() - Method in interface com.ibm.workplace.wcm.api.Repository
Close the current Workspace when finished with it.
exists(DocumentId) - Method in interface com.ibm.workplace.wcm.api.Workspace
Tests the existence of an object in the repository.

F

FileComponent - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for a FileComponent.
FileComponent - interface com.ibm.workplace.wcm.api.FileComponent.
Represents a File component.
findByName(DocumentType, String) - Method in interface com.ibm.workplace.wcm.api.Workspace
Returns an iterator of IDs of all objects of the given type with the specified name.
findByType(DocumentType) - Method in interface com.ibm.workplace.wcm.api.Workspace
Returns an iterator of IDs of all objects of the given type.
findComponentByName(String) - Method in interface com.ibm.workplace.wcm.api.Workspace
Returns an iterator of IDs of all library components with the specified name.
findContentByAuthoringTemplate(DocumentId) - Method in interface com.ibm.workplace.wcm.api.Workspace
Returns an iterator of IDs of Content which has been created using the specified authoring template.
findContentByCategory(DocumentId) - Method in interface com.ibm.workplace.wcm.api.Workspace
Returns an iterator of IDs of all Content that has the given Category in its profile.
findContentByPath(String) - Method in interface com.ibm.workplace.wcm.api.Workspace
Returns an iterator of IDs of Content with the given path.
findContentByWorkflowStage(DocumentId) - Method in interface com.ibm.workplace.wcm.api.Workspace
Returns an iterator of IDs of Content in a specified WorkflowStage.
findContentModifiedBetween(Date, Date) - Method in interface com.ibm.workplace.wcm.api.Workspace
Returns an iterator of IDs of all Content that have been modified between the specified start and end dates.
findContentModifiedSince(Date) - Method in interface com.ibm.workplace.wcm.api.Workspace
Returns an iterator of IDs of all Content that have been modified since the specified date.
fromString(String) - Method in interface com.ibm.workplace.wcm.api.Workspace
Returns the DocumentType for the specified API interface/class name.

G

generateURL(RenderingContext, ContentComponent) - Method in interface com.ibm.workplace.wcm.api.Workspace
Generate the URL to the given component, in the context of the path in the RenderingContext.
generateURL(RenderingContext, LibraryComponent) - Method in interface com.ibm.workplace.wcm.api.Workspace
Generate the URL to the given component, in the context of the path in the RenderingContext.
getAdditionalViewers() - Method in interface com.ibm.workplace.wcm.api.Content
Returns an array of names of aditional live viewers for this Content document.
getAllChildren() - Method in interface com.ibm.workplace.wcm.api.Category
Returns a depth first iterator over all child categories of this Category.
getAllChildren() - Method in interface com.ibm.workplace.wcm.api.SiteFrameworkContainer
Returns a depth first iterator over all children of this Site or SiteArea.
getAllChildren() - Method in interface com.ibm.workplace.wcm.api.Taxonomy
Returns a depth first iterator over all child categories of this Taxonomy.
getAltText() - Method in interface com.ibm.workplace.wcm.api.ImageComponent
Returns the alternate text for the image.
getAltText() - Method in interface com.ibm.workplace.wcm.api.LibraryImageComponent
Returns the alternate text for the image.
getAnonymousWorkspace() - Method in interface com.ibm.workplace.wcm.api.Repository
Returns a Workspace object representing a view of the repository for the Anonymous user.
getAuthoringTemplateID() - Method in interface com.ibm.workplace.wcm.api.Content
Returns the ID of the AuthoringTemplate that was used to create this Content document.
getAuthors() - Method in interface com.ibm.workplace.wcm.api.Document
Returns the names of authors of this Document object as a string array.
getBorder() - Method in interface com.ibm.workplace.wcm.api.ImageComponent
Returns the border attribute of the image.
getBorder() - Method in interface com.ibm.workplace.wcm.api.LibraryImageComponent
Returns the border attribute of the image.
getById(DocumentId) - Method in interface com.ibm.workplace.wcm.api.Workspace
Retrieves the object with the given ID from the repository.
getCategories() - Method in interface com.ibm.workplace.wcm.api.UserProfile
Returns the categories associates with this user.
getCategoryIds() - Method in interface com.ibm.workplace.wcm.api.Content
Return array of IDs for the categories associated with this content.
getCause() - Method in class com.ibm.workplace.wcm.api.exceptions.WCMException
Retrieves the cause exception for this exception
getChildren() - Method in interface com.ibm.workplace.wcm.api.Category
Returns an iterator of DocumentId objects of the immediate child categories of this Category object.
getChildren() - Method in interface com.ibm.workplace.wcm.api.SiteFrameworkContainer
Returns an iterator of DocumentId objects of the immediate children of this container.
getChildren() - Method in interface com.ibm.workplace.wcm.api.Taxonomy
Returns an iterator of DocumentId objects of the immediate child categories of this Taxonomy.
getComponent(String) - Method in interface com.ibm.workplace.wcm.api.ContentComponentContainer
Retrieves a ContentComponent with a name specified by the argument from this ContentComponentContainer.
getComponentByReference(String) - Method in interface com.ibm.workplace.wcm.api.ContentComponentContainer
Retrieves a ContentComponent with a name specified by the argument from this ContentComponentContainer.
getComponentRef() - Method in interface com.ibm.workplace.wcm.api.ReferenceComponent
Returns the Library Component that this component refers to.
getContainer() - Method in interface com.ibm.workplace.wcm.api.ContentComponent
Returns the ContentComponentContainer object that contains this ContentComponent.
getContent() - Method in interface com.ibm.workplace.wcm.api.RenderingContext
Returns the Content object that will be rendered by this RenderingContext.
getCount() - Method in interface com.ibm.workplace.wcm.api.ContentComponentIterator
Returns the number of elements in this Iterator.
getCount() - Method in interface com.ibm.workplace.wcm.api.DocumentIdIterator
Returns the number of elements in this Iterator.
getCurrentApprovers() - Method in interface com.ibm.workplace.wcm.api.Content
Returns the names of the approvers for this Content for the current workflow stage this document is in.
getDefaultContent() - Method in interface com.ibm.workplace.wcm.api.SiteFrameworkContainer
Returns the DocumentId of the default Content object.
getDeleteAccessMembers() - Method in interface com.ibm.workplace.wcm.api.Document
Returns a string array of members who have Delete access to this Document object.
getDescription() - Method in interface com.ibm.workplace.wcm.api.Document
Returns the description of this Document object.
getEditAccessMembers() - Method in interface com.ibm.workplace.wcm.api.Document
Returns a string array of members who have Edit access to this Document object.
getEffectiveDate() - Method in interface com.ibm.workplace.wcm.api.Content
Returns the effective date of this Content.
getErrorCode() - Method in class com.ibm.workplace.wcm.api.exceptions.WCMException
The error code for this exception.
getExpiryDate() - Method in interface com.ibm.workplace.wcm.api.Content
Returns the expiry date for this Content document.
getFile() - Method in interface com.ibm.workplace.wcm.api.FileComponent
Returns the contents of the file contained within this component as a byte array.
getFile() - Method in interface com.ibm.workplace.wcm.api.LibraryFileComponent
Returns the contents of the file contained within this component as a byte array.
getFileName() - Method in interface com.ibm.workplace.wcm.api.FileComponent
Returns the filename of the file contained within this component.
getFileName() - Method in interface com.ibm.workplace.wcm.api.LibraryFileComponent
Returns the filename of the file contained within this component.
getGeneralDateOne() - Method in interface com.ibm.workplace.wcm.api.Content
Return general date one for this Content document.
getGeneralDateTwo() - Method in interface com.ibm.workplace.wcm.api.Content
Return general date two for this Content document.
getHTML() - Method in interface com.ibm.workplace.wcm.api.HTMLComponent
Returns the HTML contained in this component as a String.
getHTML() - Method in interface com.ibm.workplace.wcm.api.LibraryHTMLComponent
Returns the HTML contained in this component as a String.
getHTMLNameTag() - Method in interface com.ibm.workplace.wcm.api.LibraryImageComponent
Returns the HTML tag name of the image.
getHeight() - Method in interface com.ibm.workplace.wcm.api.ImageComponent
Returns the height of the image.
getHeight() - Method in interface com.ibm.workplace.wcm.api.LibraryImageComponent
Returns the height of the image.
getId() - Method in interface com.ibm.workplace.wcm.api.Document
Returns the DocumentId of this Document object.
getImage(String) - Method in class com.ibm.workplace.wcm.api.EmbeddedImageMap
Gets the image's file object for the specified URL.
getImage() - Method in interface com.ibm.workplace.wcm.api.ImageComponent
Returns the contents of the image file contained within this component as a byte array.
getImage() - Method in interface com.ibm.workplace.wcm.api.LibraryImageComponent
Returns the contents of the image file contained within this component as a byte array.
getImageFileName() - Method in interface com.ibm.workplace.wcm.api.ImageComponent
Returns the filename of the image file contained within this component.
getImageFileName() - Method in interface com.ibm.workplace.wcm.api.LibraryImageComponent
Returns the filename of the image file contained within this component.
getKeywords() - Method in interface com.ibm.workplace.wcm.api.Content
Returns an array of keywords associated with this content.
getKeywords() - Method in interface com.ibm.workplace.wcm.api.UserProfile
Returns the keywords associated with this user.
getLiveAccessMembers() - Method in interface com.ibm.workplace.wcm.api.Document
Returns a string array of members who have Live access to this Document object.
getMemberNames() - Method in interface com.ibm.workplace.wcm.api.Workspace
Returns a list of names of all users and groups available to WCM.
getMemberNames(String) - Method in interface com.ibm.workplace.wcm.api.Workspace
Returns a list of names of all users and groups available to WCM.
getMessage() - Method in class com.ibm.workplace.wcm.api.exceptions.WCMException
Retrieves the message that accompanies this exception.
getName() - Method in interface com.ibm.workplace.wcm.api.ContentComponent
Returns the name of this ContentComponent object.
getName() - Method in interface com.ibm.workplace.wcm.api.Document
Returns the name of this Document object.
getName() - Method in interface com.ibm.workplace.wcm.api.DocumentId
Returns the name of the Document with this DocumentId.
getNameTag() - Method in interface com.ibm.workplace.wcm.api.ImageComponent
Returns the HTML tag name of the image.
getNumStages() - Method in interface com.ibm.workplace.wcm.api.Workflow
Returns the number of stages in this Workflow.
getOwners() - Method in interface com.ibm.workplace.wcm.api.Document
Returns the names of owners of this Document object as a string array.
getParent() - Method in interface com.ibm.workplace.wcm.api.Category
Returns the DocumentId of the parent of this Category object.
getParent() - Method in interface com.ibm.workplace.wcm.api.SiteArea
Returns the DocumentId of the parent of this SiteArea.
getParents() - Method in interface com.ibm.workplace.wcm.api.Content
Returns an iterator of the parent DocumentIds of this content.
getPath() - Method in interface com.ibm.workplace.wcm.api.RenderingContext
Returns the path to the object being rendered.
getPrefix() - Method in interface com.ibm.workplace.wcm.api.RenderingContext
Returns the prefix for all document URLs generated on rendering.
getPresTemplateOverride() - Method in interface com.ibm.workplace.wcm.api.RenderingContext
Returns the name of the PresentationTemplate to be used when rendering.
getReadAccessMembers() - Method in interface com.ibm.workplace.wcm.api.Document
Returns a string array of members who have Read access to this Document object.
getRepository() - Static method in class com.ibm.workplace.wcm.api.WCM_API
 
getRichText() - Method in interface com.ibm.workplace.wcm.api.RichTextComponent
Returns the rich text contained in this component as a String representation of the HTML.
getSite() - Method in interface com.ibm.workplace.wcm.api.RenderingContext
Returns the Site object that is in this RenderingContext.
getSiteAreas() - Method in interface com.ibm.workplace.wcm.api.RenderingContext
Returns an ordered array of SiteArea objects that are in the path to be rendered by this RenderingContext.
getStagesIterator() - Method in interface com.ibm.workplace.wcm.api.Workflow
Returns an iterator of DocumentId objects of the WorkflowStages in this Workflow.
getTemplateMapping(DocumentId) - Method in interface com.ibm.workplace.wcm.api.SiteFrameworkContainer
Returns the DocumentId of the PresentationTemplate mapped to the AuthoringTemplate with the given DocumentId.
getText() - Method in interface com.ibm.workplace.wcm.api.TextComponent
Returns the text contained in this component as a String.
getType() - Method in interface com.ibm.workplace.wcm.api.DocumentId
Returns the type of the Document with this DocumentId.
getURL() - Method in interface com.ibm.workplace.wcm.api.RenderingContext
Returns the URL to WCM and any request parameters.
getUserProfile() - Method in interface com.ibm.workplace.wcm.api.Workspace
Returns the UserProfile for the user of this Workspace.
getUsername() - Method in interface com.ibm.workplace.wcm.api.UserProfile
Returns the username of the user in this set of credentials.
getWcmServletPath() - Method in interface com.ibm.workplace.wcm.api.RenderingContext
Returns the servlet path to be used - either the servlet path that has been set, or the servlet path from the request.
getWcmWebAppPath() - Method in interface com.ibm.workplace.wcm.api.RenderingContext
Returns the web app path to be used - either the WCM web app path that has been set using setWcmWebAppPath(String), or the path from the request.
getWidth() - Method in interface com.ibm.workplace.wcm.api.ImageComponent
Returns the width of the image.
getWidth() - Method in interface com.ibm.workplace.wcm.api.LibraryImageComponent
Returns the width of the image.
getWorkflowId() - Method in interface com.ibm.workplace.wcm.api.Content
Return ID of the workflow associated with this content.
getWorkflowStageId() - Method in interface com.ibm.workplace.wcm.api.Content
Returns the ID of the current WorkflowStage that this Content document is in.
getWorkspace(String, String) - Method in interface com.ibm.workplace.wcm.api.Repository
Returns a Workspace object that represents a view of the repository for a user with the specified credentials.
getWorkspace(Principal) - Method in interface com.ibm.workplace.wcm.api.Repository
Returns a Workspace object representing a view of the repository for the specified Principal.

H

HTMLComponent - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for a HTMLComponent.
HTMLComponent - interface com.ibm.workplace.wcm.api.HTMLComponent.
Represents a HTML component.
hasComponent(String) - Method in interface com.ibm.workplace.wcm.api.ContentComponentContainer
Returns true if and only if the argument is not null and a ContentComponent with a name specified by the argument exists in this ContentComponentContainer.
hasContent(DocumentId) - Method in interface com.ibm.workplace.wcm.api.SiteArea
Returns true if this SiteArea object has a child Content with the given DocumentId.
hasDraft() - Method in interface com.ibm.workplace.wcm.api.Content
Returns true if this Content has a draft document.
hasNext() - Method in interface com.ibm.workplace.wcm.api.ContentComponentIterator
Returns true if the iteration has more elements.
hasNext() - Method in interface com.ibm.workplace.wcm.api.DocumentIdIterator
Returns true if the iteration has more elements.
hasSiteArea(DocumentId) - Method in interface com.ibm.workplace.wcm.api.SiteFrameworkContainer
Returns true if the container has a child SiteArea with the given DocumentId.
hasTemplateMapping(DocumentId) - Method in interface com.ibm.workplace.wcm.api.SiteFrameworkContainer
Returns true if the container has a mapping for the AuthoringTemplate with the given DocumentId.

I

IllegalDocumentTypeException - exception com.ibm.workplace.wcm.api.exceptions.IllegalDocumentTypeException.
An IllegalDocumentTypeException is thrown if an object is not of the expected type.
IllegalDocumentTypeException() - Constructor for class com.ibm.workplace.wcm.api.exceptions.IllegalDocumentTypeException
Constructor.
IllegalDocumentTypeException(String) - Constructor for class com.ibm.workplace.wcm.api.exceptions.IllegalDocumentTypeException
Constructs a new exception with the given message.
IllegalDocumentTypeException(Throwable) - Constructor for class com.ibm.workplace.wcm.api.exceptions.IllegalDocumentTypeException
Constructor to only be used by sub classes
IllegalDocumentTypeException(String, Throwable) - Constructor for class com.ibm.workplace.wcm.api.exceptions.IllegalDocumentTypeException
Constructor that requires detail plus a cause exception
IllegalTypeChangeException - exception com.ibm.workplace.wcm.api.exceptions.IllegalTypeChangeException.
This exception is thrown if the type of an object being set is not allowed.
IllegalTypeChangeException() - Constructor for class com.ibm.workplace.wcm.api.exceptions.IllegalTypeChangeException
Constructor.
IllegalTypeChangeException(String) - Constructor for class com.ibm.workplace.wcm.api.exceptions.IllegalTypeChangeException
Constructs a new exception with the given message.
IllegalTypeChangeException(Throwable) - Constructor for class com.ibm.workplace.wcm.api.exceptions.IllegalTypeChangeException
Constructor to only be used by sub classes
IllegalTypeChangeException(String, Throwable) - Constructor for class com.ibm.workplace.wcm.api.exceptions.IllegalTypeChangeException
Constructor that requires detail plus a cause exception
ImageComponent - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for a ImageComponent.
ImageComponent - interface com.ibm.workplace.wcm.api.ImageComponent.
Represents an Image component.
insertContent(DocumentId, DocumentId) - Method in interface com.ibm.workplace.wcm.api.SiteArea
Inserts the Content with a DocumentId specified by p_contentId as a child of this SiteArea after the Content with a DocumentId of p_priorChildId.
insertSiteArea(DocumentId, DocumentId) - Method in interface com.ibm.workplace.wcm.api.SiteFrameworkContainer
Inserts the SiteArea with a DocumentId specified by p_siteAreaId as a child of this Site or SiteArea after the SiteArea with a DocumentId of p_priorChildId.
isChanged() - Method in interface com.ibm.workplace.wcm.api.Editable
Returns the value of the changed flag.
isChanged() - Method in interface com.ibm.workplace.wcm.api.EditableLibraryComponent
Returns the value of the changed flag.
isDraft() - Method in interface com.ibm.workplace.wcm.api.Content
Return true if this content object is a draft.
isExpired() - Method in interface com.ibm.workplace.wcm.api.Content
Return true if this Content has expired.
isMemberOfGroup(String) - Method in interface com.ibm.workplace.wcm.api.Workspace
Indicates if the user of this Workspace is a member of the group with the specified name.
isOfType(DocumentType) - Method in interface com.ibm.workplace.wcm.api.DocumentId
Returns true if and only if the type of the Document represented by this DocumentId is the same as the DocumentType argument.
isPresentationOverride() - Method in interface com.ibm.workplace.wcm.api.RenderingContext
Returns true if a presentation template override has been specified; false otherwise.
isPublished() - Method in interface com.ibm.workplace.wcm.api.Content
Return true if this Content document is live published content.

L

LibraryComponent - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for Library Components.
LibraryComponent - interface com.ibm.workplace.wcm.api.LibraryComponent.
The root interface in the Library Component hierarchy.
LibraryFileComponent - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for a LibraryFileComponent.
LibraryFileComponent - interface com.ibm.workplace.wcm.api.LibraryFileComponent.
Represents a File component that exists in the Component Library.
LibraryHTMLComponent - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for a LibraryHTMLComponent.
LibraryHTMLComponent - interface com.ibm.workplace.wcm.api.LibraryHTMLComponent.
Represents a HTML component that exists in the Component Library.
LibraryImageComponent - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for a LibraryImageComponent.
LibraryImageComponent - interface com.ibm.workplace.wcm.api.LibraryImageComponent.
Represents an Image component that exists in the Component Library.

N

NoMoreWorkflowStagesException - exception com.ibm.workplace.wcm.api.exceptions.NoMoreWorkflowStagesException.
This exception is thrown when attempting to move a Document to the next workflow stage if there is no valid next workflow stage.
NoMoreWorkflowStagesException() - Constructor for class com.ibm.workplace.wcm.api.exceptions.NoMoreWorkflowStagesException
Constructor.
NoMoreWorkflowStagesException(String) - Constructor for class com.ibm.workplace.wcm.api.exceptions.NoMoreWorkflowStagesException
Constructs a new exception with the given message.
NoMoreWorkflowStagesException(Throwable) - Constructor for class com.ibm.workplace.wcm.api.exceptions.NoMoreWorkflowStagesException
Constructor to only be used by sub classes
NoMoreWorkflowStagesException(String, Throwable) - Constructor for class com.ibm.workplace.wcm.api.exceptions.NoMoreWorkflowStagesException
Constructor that requires detail plus a cause exception
next() - Method in interface com.ibm.workplace.wcm.api.ContentComponentIterator
Returns the next element in the interation.
next() - Method in interface com.ibm.workplace.wcm.api.DocumentIdIterator
Returns the next element in the interation.
nextWorkflowStage() - Method in interface com.ibm.workplace.wcm.api.Content
Move this Content object into the next stage in its workflow.

O

OperationFailedException - exception com.ibm.workplace.wcm.api.exceptions.OperationFailedException.
An OperationFailedException is thrown if an error occurred while trying to set a property on a Document.
OperationFailedException() - Constructor for class com.ibm.workplace.wcm.api.exceptions.OperationFailedException
Constructor.
OperationFailedException(String) - Constructor for class com.ibm.workplace.wcm.api.exceptions.OperationFailedException
Constructs a new exception with the given message.
OperationFailedException(Throwable) - Constructor for class com.ibm.workplace.wcm.api.exceptions.OperationFailedException
Constructor to only be used by sub classes
OperationFailedException(String, Throwable) - Constructor for class com.ibm.workplace.wcm.api.exceptions.OperationFailedException
Constructor that requires detail plus a cause exception

P

PresentationTemplate - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for a PresentationTemplate
PresentationTemplate - interface com.ibm.workplace.wcm.api.PresentationTemplate.
Represents a Presentation Template in the repository.
PropertyRetrievalException - exception com.ibm.workplace.wcm.api.exceptions.PropertyRetrievalException.
This exception is thrown if an error occurs while attempting to retrieve a property of a Document.
PropertyRetrievalException() - Constructor for class com.ibm.workplace.wcm.api.exceptions.PropertyRetrievalException
Constructor.
PropertyRetrievalException(String) - Constructor for class com.ibm.workplace.wcm.api.exceptions.PropertyRetrievalException
Constructs a new exception with the given message.
PropertyRetrievalException(Throwable) - Constructor for class com.ibm.workplace.wcm.api.exceptions.PropertyRetrievalException
Constructor to only be used by sub classes
PropertyRetrievalException(String, Throwable) - Constructor for class com.ibm.workplace.wcm.api.exceptions.PropertyRetrievalException
Constructor that requires detail plus a cause exception
printStackTrace() - Method in class com.ibm.workplace.wcm.api.exceptions.WCMException
Overridden to include cause
printStackTrace(PrintStream) - Method in class com.ibm.workplace.wcm.api.exceptions.WCMException
Overridden to include cause
printStackTrace(PrintWriter) - Method in class com.ibm.workplace.wcm.api.exceptions.WCMException
Overridden to include cause

R

ReferenceComponent - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for a ReferenceComponent.
ReferenceComponent - interface com.ibm.workplace.wcm.api.ReferenceComponent.
Represents a component that can contain a reference to one LibraryComponent.
RenderingContext - interface com.ibm.workplace.wcm.api.RenderingContext.
Represents a rendering context.
Repository - interface com.ibm.workplace.wcm.api.Repository.
The entry point into the WCM repository.
RichTextComponent - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for a RichTextComponent.
RichTextComponent - interface com.ibm.workplace.wcm.api.RichTextComponent.
Represents a Rich Text component.
remove() - Method in interface com.ibm.workplace.wcm.api.ContentComponentIterator
This method is not implemented.
remove() - Method in interface com.ibm.workplace.wcm.api.DocumentIdIterator
This method is not implemented.
removeAdditionalViewers(String[]) - Method in interface com.ibm.workplace.wcm.api.Content
Removes names from the list of additional live viewers for this Content.
removeAuthors(String[]) - Method in interface com.ibm.workplace.wcm.api.Editable
Removes each author specified in the string array argument from the authors of this Editable object.
removeAuthors(String[]) - Method in interface com.ibm.workplace.wcm.api.EditableLibraryComponent
Removes each author specified in the string array argument from the authors of this EditableLibraryComponent object.
removeCategoryIds(DocumentId[]) - Method in interface com.ibm.workplace.wcm.api.Content
Remove categories from this content.
removeContent(DocumentId) - Method in interface com.ibm.workplace.wcm.api.SiteArea
Removes a child Content with the given DocumentId from the this SiteArea.
removeDeleteAccessMembers(String[]) - Method in interface com.ibm.workplace.wcm.api.Editable
Removes each name specified in the string array argument from the members who have Delete access to this Editable object.
removeDeleteAccessMembers(String[]) - Method in interface com.ibm.workplace.wcm.api.EditableLibraryComponent
Removes each name specified in the string array argument from the members that have Delete access to this EditableLibraryComponent object.
removeEditAccessMembers(String[]) - Method in interface com.ibm.workplace.wcm.api.Editable
Removes each name specified in the string array argument from the members who have Edit access to this Editable object.
removeEditAccessMembers(String[]) - Method in interface com.ibm.workplace.wcm.api.EditableLibraryComponent
Removes each name specified in the string array argument from the members that have Edit access to this EditableLibraryComponent object.
removeLiveAccessMembers(String[]) - Method in interface com.ibm.workplace.wcm.api.Editable
Removes each name specified in the string array argument from the members who have Live access to this Editable object.
removeLiveAccessMembers(String[]) - Method in interface com.ibm.workplace.wcm.api.EditableLibraryComponent
Removes each name specified in the string array argument from the members that have Live access to this EditableLibraryComponent object.
removeOwners(String[]) - Method in interface com.ibm.workplace.wcm.api.Editable
Removes each owner specified in the string array argument from the owners of this Editable object.
removeOwners(String[]) - Method in interface com.ibm.workplace.wcm.api.EditableLibraryComponent
Removes each owner specified in the string array argument from the owners of this EditableLibraryComponent object.
removeReadAccessMembers(String[]) - Method in interface com.ibm.workplace.wcm.api.Editable
Removes each name specified in the string array argument from the members who have Read access to this Editable object.
removeReadAccessMembers(String[]) - Method in interface com.ibm.workplace.wcm.api.EditableLibraryComponent
Removes each name specified in the string array argument from the members that have Read access to this EditableLibraryComponent object.
removeSiteArea(DocumentId) - Method in interface com.ibm.workplace.wcm.api.SiteFrameworkContainer
Removes a child SiteArea with the given DocumentId from this Site or SiteArea.
removeTemplateMapping(DocumentId) - Method in interface com.ibm.workplace.wcm.api.SiteFrameworkContainer
Removes the mapping for the AuthoringTemplate with the given DocumentId
render(RenderingContext) - Method in interface com.ibm.workplace.wcm.api.Workspace
Renders the content, according to the RenderingContext that is passed in.
render(RenderingContext, ContentComponent) - Method in interface com.ibm.workplace.wcm.api.Workspace
Renders the given WCM content component using the specified rendering context.
render(RenderingContext, LibraryComponent) - Method in interface com.ibm.workplace.wcm.api.Workspace
Renders the specified WCM LibraryComponent using the specified RenderingContext.
restartWorkflow() - Method in interface com.ibm.workplace.wcm.api.Content
Restart the workflow on this Content object.

S

ServiceNotAvailableException - exception com.ibm.workplace.wcm.api.exceptions.ServiceNotAvailableException.
This exception is thrown if the WCM service is not available.
ServiceNotAvailableException() - Constructor for class com.ibm.workplace.wcm.api.exceptions.ServiceNotAvailableException
Constructor.
ServiceNotAvailableException(String) - Constructor for class com.ibm.workplace.wcm.api.exceptions.ServiceNotAvailableException
Constructs a new exception with the given message.
ServiceNotAvailableException(Throwable) - Constructor for class com.ibm.workplace.wcm.api.exceptions.ServiceNotAvailableException
Constructor to only be used by sub classes
ServiceNotAvailableException(String, Throwable) - Constructor for class com.ibm.workplace.wcm.api.exceptions.ServiceNotAvailableException
Constructor that requires detail plus a cause exception
Site - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for Site
Site - interface com.ibm.workplace.wcm.api.Site.
Represents a Site object.
SiteArea - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for SiteArea
SiteArea - interface com.ibm.workplace.wcm.api.SiteArea.
Represents a SiteArea object.
SiteFrameworkContainer - interface com.ibm.workplace.wcm.api.SiteFrameworkContainer.
The ability to organize and build a Site Framework is enabled by implementing the SiteFrameworkContainer interface.
save(Document) - Method in interface com.ibm.workplace.wcm.api.Workspace
Saves an editable document to the WCM repository.
setAltText(String) - Method in interface com.ibm.workplace.wcm.api.ImageComponent
Sets the alternate text of the image.
setAltText(String) - Method in interface com.ibm.workplace.wcm.api.LibraryImageComponent
Sets the alternate text of the image.
setBorder(String) - Method in interface com.ibm.workplace.wcm.api.ImageComponent
Sets the image border.
setBorder(String) - Method in interface com.ibm.workplace.wcm.api.LibraryImageComponent
Sets the image border.
setComponent(String, ContentComponent) - Method in interface com.ibm.workplace.wcm.api.ContentComponentContainer
Sets the ContentComponent with the name specified by the argument in this ContentComponentContainer.
setComponentRef(LibraryComponent) - Method in interface com.ibm.workplace.wcm.api.ReferenceComponent
Sets the Library Component that this component refers to.
setDefaultContent(DocumentId) - Method in interface com.ibm.workplace.wcm.api.SiteFrameworkContainer
Sets the default Content for this Site or SiteArea if the DocumentId argument is not null.
setDescription(String) - Method in interface com.ibm.workplace.wcm.api.Editable
Sets the description of this Editable object to the specified String argument.
setDescription(String) - Method in interface com.ibm.workplace.wcm.api.EditableLibraryComponent
Sets the description of this EditableLibraryComponent object to the specified String argument.
setEffectiveDate(Date) - Method in interface com.ibm.workplace.wcm.api.Content
Sets the effective date of this Content document.
setExpiryDate(Date) - Method in interface com.ibm.workplace.wcm.api.Content
Sets the expiry date for this Content document.
setFile(String, byte[]) - Method in interface com.ibm.workplace.wcm.api.FileComponent
Sets the file contained within this component.
setFile(String, byte[]) - Method in interface com.ibm.workplace.wcm.api.LibraryFileComponent
Sets the file contained within this component.
setGeneralDateOne(Date) - Method in interface com.ibm.workplace.wcm.api.Content
Set general date one for this Content document.
setGeneralDateTwo(Date) - Method in interface com.ibm.workplace.wcm.api.Content
Set general date two for this Content document.
setHTML(String) - Method in interface com.ibm.workplace.wcm.api.HTMLComponent
Sets the HTML contained in this HTMLComponent.
setHTML(String, EmbeddedImageMap) - Method in interface com.ibm.workplace.wcm.api.HTMLComponent
Sets the HTML contained in this HTMLComponent from the specified p_html argument that contains embedded images.
setHTML(String) - Method in interface com.ibm.workplace.wcm.api.LibraryHTMLComponent
Sets the HTML contained in this LibraryHTMLComponent from the specified p_html argument.
setHTML(String, EmbeddedImageMap) - Method in interface com.ibm.workplace.wcm.api.LibraryHTMLComponent
Sets the HTML contained in this LibraryHTMLComponent from the specified p_html argument that contains embedded images.
setHTMLNameTag(String) - Method in interface com.ibm.workplace.wcm.api.LibraryImageComponent
Sets the HTML tag name of the image.
setHeight(String) - Method in interface com.ibm.workplace.wcm.api.ImageComponent
Sets the image height.
setHeight(String) - Method in interface com.ibm.workplace.wcm.api.LibraryImageComponent
Sets the image height.
setImage(String, byte[]) - Method in interface com.ibm.workplace.wcm.api.ImageComponent
Sets the image file contained within this component.
setImage(String, byte[]) - Method in interface com.ibm.workplace.wcm.api.LibraryImageComponent
Sets the image file contained within this component.
setKeywords(String[]) - Method in interface com.ibm.workplace.wcm.api.Content
Sets the keywords for this Content document.
setName(String) - Method in interface com.ibm.workplace.wcm.api.Editable
Sets the name of this Editable object to the specified String argument.
setName(String) - Method in interface com.ibm.workplace.wcm.api.EditableLibraryComponent
Sets the name of this EditableLibraryComponent object to the specified String argument.
setNameTag(String) - Method in interface com.ibm.workplace.wcm.api.ImageComponent
Sets the HTML tag name of the image.
setPrefix(String) - Method in interface com.ibm.workplace.wcm.api.RenderingContext
Sets the prefix for all document URLs generated on rendering.
setPresentationTemplateOverride(String) - Method in interface com.ibm.workplace.wcm.api.RenderingContext
Sets the name of the presentation template to the string argument specified.
setRenderedContent(String) - Method in interface com.ibm.workplace.wcm.api.RenderingContext
Sets the full path of the Content to render.
setRenderedContent(Site) - Method in interface com.ibm.workplace.wcm.api.RenderingContext
Sets the Site to be rendered.
setRenderedContent(SiteArea) - Method in interface com.ibm.workplace.wcm.api.RenderingContext
Sets the SiteArea to be rendered.
setRenderedContent(Content, SiteArea) - Method in interface com.ibm.workplace.wcm.api.RenderingContext
Sets the Content object to be rendered.
setRichText(String) - Method in interface com.ibm.workplace.wcm.api.RichTextComponent
Sets the rich text in the component from a String of HTML.
setRichText(String, EmbeddedImageMap) - Method in interface com.ibm.workplace.wcm.api.RichTextComponent
Sets the rich text in the component from a String of HTML and embedded images.
setText(String) - Method in interface com.ibm.workplace.wcm.api.TextComponent
Sets the plain text contained in this TextComponent.
setWcmServletPath(String) - Method in interface com.ibm.workplace.wcm.api.RenderingContext
Sets the servlet path of the WCM servlet.
setWcmWebAppPath(String) - Method in interface com.ibm.workplace.wcm.api.RenderingContext
Sets the path (including host) to the WCM web application.
setWidth(String) - Method in interface com.ibm.workplace.wcm.api.ImageComponent
Sets the width of the image.
setWidth(String) - Method in interface com.ibm.workplace.wcm.api.LibraryImageComponent
Sets the width of the image.
setWorkflowId(DocumentId) - Method in interface com.ibm.workplace.wcm.api.Content
Sets the Workflow on this Content given the ID of the Workflow.

T

Taxonomy - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for Taxonomy
Taxonomy - interface com.ibm.workplace.wcm.api.Taxonomy.
Represents a Taxonomy in the repository.
TextComponent - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for a TextComponent.
TextComponent - interface com.ibm.workplace.wcm.api.TextComponent.
Represents a Text component.
toString() - Method in interface com.ibm.workplace.wcm.api.DocumentId
Returns a String representation of this DocumentId.
toString() - Method in interface com.ibm.workplace.wcm.api.DocumentType
Returns a String representation of this object.

U

URLIterator() - Method in class com.ibm.workplace.wcm.api.EmbeddedImageMap
Get an iterator of all the URLs stored in this image map.
UserProfile - interface com.ibm.workplace.wcm.api.UserProfile.
The UserProfile interface retrieves user related information.
useLiveAccess(boolean) - Method in interface com.ibm.workplace.wcm.api.Workspace
Sets the Access context to use for the following methods:

W

WCMException - exception com.ibm.workplace.wcm.api.exceptions.WCMException.
The base Lotus Workplace Web Content Management API Exception.
WCMException() - Constructor for class com.ibm.workplace.wcm.api.exceptions.WCMException
Construtor to only be used by sub classes
WCMException(Throwable) - Constructor for class com.ibm.workplace.wcm.api.exceptions.WCMException
Constructor to only be used by sub classes
WCMException(String) - Constructor for class com.ibm.workplace.wcm.api.exceptions.WCMException
Constructor that requires detail
WCMException(String, Throwable) - Constructor for class com.ibm.workplace.wcm.api.exceptions.WCMException
Constructor that requires detail plus a cause exception
WCM_API - class com.ibm.workplace.wcm.api.WCM_API.
 
WCM_API() - Constructor for class com.ibm.workplace.wcm.api.WCM_API
 
WCM_ERROR_KEY - Static variable in interface com.ibm.workplace.wcm.api.Workspace
 
WCM_RENDERINGCONTEXT_KEY - Static variable in interface com.ibm.workplace.wcm.api.Workspace
 
WCM_WORKSPACE_KEY - Static variable in interface com.ibm.workplace.wcm.api.Workspace
 
Workflow - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for Workflow
Workflow - interface com.ibm.workplace.wcm.api.Workflow.
Represents a workflow.
WorkflowStage - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for WorkflowStage
WorkflowStage - interface com.ibm.workplace.wcm.api.WorkflowStage.
Represents a workflow stage.
Workspace - interface com.ibm.workplace.wcm.api.Workspace.
Represents a view of the WCM repository for a particular user.

A C D E F G H I L N O P R S T U W