Index (ILWWCM 6.0.1.3 API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV NEXT

FRAMES NO FRAMES

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

A

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.
addComponent(String, ContentComponent) - Method in interface com.ibm.workplace.wcm.api.ContentComponentContainer: Adds the ContentComponent with the name specified by the argument to this ContentComponentContainer.
addContent(DocumentId) - Method in interface com.ibm.workplace.wcm.api.SiteArea: Deprecated. use Workspace.createContent(authoringTemplateId, parentSiteId, siblingId, position) instead
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.
addHistoryLogEntry(String) - Method in interface com.ibm.workplace.wcm.api.Editable: Adds a entry to the History log of this Editable object.
addLiveAccessMembers(String[]) - Method in interface com.ibm.workplace.wcm.api.Editable: Deprecated. This method is deprecated from version 6.0. Calls to 'Live' access methods have the same effect as 'Read' access method calls.
addLiveAccessMembers(String[]) - Method in interface com.ibm.workplace.wcm.api.EditableLibraryComponent: Deprecated. This method is deprecated from version 6.0. Calls to 'Live' access methods have the same effect as 'Read' access method calls.
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: Deprecated. use Workspace.createSiteArea(parentId, siblingId, position) instead.
addTemplateMapping(DocumentId, DocumentId) - Method in interface com.ibm.workplace.wcm.api.SiteFrameworkContainer: Adds a mapping for the specified AuthoringTemplate and PresentationTemplate.
AFTER - Static variable in interface com.ibm.workplace.wcm.api.ChildPosition: Child position constant indicating the item will be placed after a given sibling.
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(String, Throwable) - Constructor for class com.ibm.workplace.wcm.api.exceptions.AuthorizationException: Constructor that requires detail plus a cause exception

B

BEFORE - Static variable in interface com.ibm.workplace.wcm.api.ChildPosition: Child position constant indicating the item will be placed before a given sibling.

C

canClear() - Method in interface com.ibm.workplace.wcm.api.Reference: Indicates if the reference from the referer Document to the referee Document can be cleared.
canReplace() - Method in interface com.ibm.workplace.wcm.api.Reference: Indicates if the reference from the referer Document to the referee Document can be replaced with another referee.
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
ChildPosition - interface com.ibm.workplace.wcm.api.ChildPosition.
clear() - Method in interface com.ibm.workplace.wcm.api.Reference: Clear the reference from the referer Document to the referee Document.
clearReferences(Reference[]) - Method in interface com.ibm.workplace.wcm.api.Workspace: Clears all the refences represented by the array of Reference instances.
com.ibm.workplace.wcm.api - package com.ibm.workplace.wcm.api
com.ibm.workplace.wcm.api.exceptions - package com.ibm.workplace.wcm.api.exceptions
componentIterator() - Method in interface com.ibm.workplace.wcm.api.ContentComponentContainer: Returns an iterator of all ContentComponent objects in this ContentComponentContainer.
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(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 interface 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.
ContentLink - interface com.ibm.workplace.wcm.api.ContentLink.: A ContentLink object represents a link to a Content item in the WCM repository.
ContentLink - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes: The document type for ContentLink
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.
ContextProcessor - interface com.ibm.workplace.wcm.api.ContextProcessor.: Represents a context processor.
ContextProcessorParams - interface com.ibm.workplace.wcm.api.ContextProcessorParams.: Represents the parameters that a context processor is able to read and modify.
copyCategory(DocumentId, DocumentId) - Method in interface com.ibm.workplace.wcm.api.Workspace: Copies a category and adds it under a new parent.
copySiteFrameworkDocument(DocumentId, DocumentId, DocumentId, int) - Method in interface com.ibm.workplace.wcm.api.Workspace: This method copies hierarchical items (SiteArea, Content, or ContentLink to another library.
copyToLibrary(DocumentLibrary, DocumentId) - Method in interface com.ibm.workplace.wcm.api.Workspace: This method copies non-hierarchical or root items to another library.
createCategory(DocumentId) - Method in interface com.ibm.workplace.wcm.api.Workspace: Creates a new Category under the given parent.
createComponent(String, DocumentType) - Method in interface com.ibm.workplace.wcm.api.ContentComponentContainer: Creates a new ContentComponent of the specified type with the name specified by the argument and associates it with this ContentComponentContainer.
createContent(DocumentId) - Method in interface com.ibm.workplace.wcm.api.Workspace: Deprecated. use createContent(authoringTemplateId, parentSiteAreaId, siblingId, position) instead.
createContent(DocumentId, DocumentId, DocumentId, int) - Method in interface com.ibm.workplace.wcm.api.Workspace: Creates a new Content object, based on an AuthoringTemplate in the parent SiteArea.
createContentLink(DocumentId, DocumentId, DocumentId, int) - Method in interface com.ibm.workplace.wcm.api.Workspace: Creates a new ContentLink object, linked to the given Content.
createDateComponent() - Method in interface com.ibm.workplace.wcm.api.Workspace: Creates a new LibraryDateComponent.
createDocumentId(String) - Method in interface com.ibm.workplace.wcm.api.Workspace: Creates a new DocumentId object from a String representation of the ID.
createDocumentIdIterator(DocumentId[]) - Method in interface com.ibm.workplace.wcm.api.Workspace: create a new DocumentIdIterator from an array of given DocumentId.
createDocumentManagerComponent() - Method in interface com.ibm.workplace.wcm.api.Workspace: Creates a new LibraryDocumentManagerComponent.
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.
createLinkComponent() - Method in interface com.ibm.workplace.wcm.api.Workspace: Creates a new LibraryLinkComponent.
createNumericComponent() - Method in interface com.ibm.workplace.wcm.api.Workspace: Creates a new LibraryNumericComponent.
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.
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.
createSite() - Method in interface com.ibm.workplace.wcm.api.Workspace: Creates a new Site.
createSiteArea() - Method in interface com.ibm.workplace.wcm.api.Workspace: Deprecated. use createSiteArea(parentId) instead
createSiteArea(DocumentId, DocumentId, int) - Method in interface com.ibm.workplace.wcm.api.Workspace: Creates a new SiteArea under the given parent.
createStyleSheetComponent() - Method in interface com.ibm.workplace.wcm.api.Workspace: Creates a new LibraryStyleSheetComponent.
createTaxonomy() - Method in interface com.ibm.workplace.wcm.api.Workspace: Creates a new Taxonomy.
createUserSelectionComponent() - Method in interface com.ibm.workplace.wcm.api.Workspace: Creates a new LibraryUserSelectionComponent.




D

DateComponent - interface com.ibm.workplace.wcm.api.DateComponent.
Represents a Date component.
DateComponent - 
Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for a DateComponent.
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.
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(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(String, Throwable) - 
Constructor for class com.ibm.workplace.wcm.api.exceptions.DocumentDeleteException
Constructor that requires detail plus a cause exception
DocumentDeleteReferentialIntegrityException - exception com.ibm.workplace.wcm.api.exceptions.DocumentDeleteReferentialIntegrityException.
This exception is thrown if a referential integrity error occurs
 while trying to delete a Document from the repository.
DocumentDeleteReferentialIntegrityException() - 
Constructor for class com.ibm.workplace.wcm.api.exceptions.DocumentDeleteReferentialIntegrityException
Constructor.
DocumentDeleteReferentialIntegrityException(String) - 
Constructor for class com.ibm.workplace.wcm.api.exceptions.DocumentDeleteReferentialIntegrityException
Constructs a new exception with the given message.
DocumentDeleteReferentialIntegrityException(String, Throwable) - 
Constructor for class com.ibm.workplace.wcm.api.exceptions.DocumentDeleteReferentialIntegrityException
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(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.
DocumentIsLockedException - exception com.ibm.workplace.wcm.api.exceptions.DocumentIsLockedException.
A DocumentIsLockedException is thrown if the Document
 is currently locked and refreshDocument is invoked aginst the doucment.
DocumentIsLockedException() - 
Constructor for class com.ibm.workplace.wcm.api.exceptions.DocumentIsLockedException
Constructor
DocumentIsLockedException(String) - 
Constructor for class com.ibm.workplace.wcm.api.exceptions.DocumentIsLockedException
Constructor that requires detail
DocumentIsLockedException(String, Throwable) - 
Constructor for class com.ibm.workplace.wcm.api.exceptions.DocumentIsLockedException
Constructor that requires detail plus a cause exception
DocumentIsLockedException(Throwable) - 
Constructor for class com.ibm.workplace.wcm.api.exceptions.DocumentIsLockedException
Constructor that requires a cause exception
DocumentIterator - interface com.ibm.workplace.wcm.api.DocumentIterator.
DocumentIterator iterates over Document
 objects.
DocumentLibrary - interface com.ibm.workplace.wcm.api.DocumentLibrary.
 
DocumentManagerComponent - interface com.ibm.workplace.wcm.api.DocumentManagerComponent.
Represents a DocumentManager component.
DocumentManagerComponent - 
Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for a DocumentManagerComponent.
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(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(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(String, Throwable) - 
Constructor for class com.ibm.workplace.wcm.api.exceptions.DocumentSaveException
Constructor that requires detail plus a cause exception
DocumentSaveReferentialIntegrityException - exception com.ibm.workplace.wcm.api.exceptions.DocumentSaveReferentialIntegrityException.
This exception is thrown if a referential integrity error occurs
 while trying to save a Document in the repository.
DocumentSaveReferentialIntegrityException() - 
Constructor for class com.ibm.workplace.wcm.api.exceptions.DocumentSaveReferentialIntegrityException
Constructor.
DocumentSaveReferentialIntegrityException(String) - 
Constructor for class com.ibm.workplace.wcm.api.exceptions.DocumentSaveReferentialIntegrityException
Constructs a new exception with the given message.
DocumentSaveReferentialIntegrityException(String, Throwable) - 
Constructor for class com.ibm.workplace.wcm.api.exceptions.DocumentSaveReferentialIntegrityException
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
 that this, or another Document with the same name 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(String, Throwable) - 
Constructor for class com.ibm.workplace.wcm.api.exceptions.DuplicateChildException
Constructor that requires detail plus a cause exception
DuplicateComponentException - exception com.ibm.workplace.wcm.api.exceptions.DuplicateComponentException.
A DuplicateComponentException is thrown if the API user attempts
 to add a component with the same name as an existing component.
DuplicateComponentException() - 
Constructor for class com.ibm.workplace.wcm.api.exceptions.DuplicateComponentException
Constructor.
DuplicateComponentException(String) - 
Constructor for class com.ibm.workplace.wcm.api.exceptions.DuplicateComponentException
Constructs a new exception with the given message.
DuplicateComponentException(String, Throwable) - 
Constructor for class com.ibm.workplace.wcm.api.exceptions.DuplicateComponentException
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(String, Throwable) - 
Constructor for class com.ibm.workplace.wcm.api.exceptions.DuplicateMappingException
Constructor that requires detail plus a cause exception



E

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.
END - 
Static variable in interface com.ibm.workplace.wcm.api.ChildPosition
Child position constant indicating the item will be placed at the end of the index.
endWorkspace() - 
Method in interface com.ibm.workplace.wcm.api.Repository
Performs a logout from the currently associated Workspace and
 unregisters the current thread from its session.
ERR_APTRIX - 
Static variable in class com.ibm.workplace.wcm.api.exceptions.WCMException
The default error code
ERR_APTRIX - 
Static variable in class com.ibm.workplace.wcm.api.exceptions.WCMRuntimeException
The default error code
exists(DocumentId) - 
Method in interface com.ibm.workplace.wcm.api.Workspace
Tests the existence of an object in the repository.



F

FileComponent - interface com.ibm.workplace.wcm.api.FileComponent.
Represents a File component.
FileComponent - 
Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for a FileComponent.
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.
findByPath(String, int) - 
Method in interface com.ibm.workplace.wcm.api.Workspace
Returns an iterator of DocumentId for a given path and
 workflow status.
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.
findContentByWorkflowStage(DocumentId[]) - 
Method in interface com.ibm.workplace.wcm.api.Workspace
Returns an iterator of all content in the given workflow stages.
findContentByWorkflowStage(DocumentId[], String[], int) - 
Method in interface com.ibm.workplace.wcm.api.Workspace
Find content by workflow stage for users in particular roles.
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.
getAdditionalAttribute() - 
Method in interface com.ibm.workplace.wcm.api.LibraryLinkComponent
Get Additional Attribute for HTML anchor tag properties.
getAdditionalAttribute() - 
Method in interface com.ibm.workplace.wcm.api.LinkComponent
Gets the additional attribute for the HTML anchor tag.
getAdditionalViewers() - 
Method in interface com.ibm.workplace.wcm.api.Content
Returns an array of names of additional 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.
getAllDirectChildren() - 
Method in interface com.ibm.workplace.wcm.api.SiteFrameworkContainer
Returns a depth first iterator over all children of this Site
 or SiteArea, excluding ContentLinks.
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.
getAuthoringTemplateIds() - 
Method in interface com.ibm.workplace.wcm.api.SiteFrameworkContainer
Returns an iterator of DocumentId objects for the 
 Authoring Templates associated with this container.
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
Return object for the given Id.
getById(DocumentId, boolean) - 
Method in interface com.ibm.workplace.wcm.api.Workspace
Return object for the given Id.
getByIds(DocumentIdIterator, boolean) - 
Method in interface com.ibm.workplace.wcm.api.Workspace
Return the list of Document objects for the given DocumentIds as a 
 DocumentIterator.
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
getCause() - 
Method in class com.ibm.workplace.wcm.api.exceptions.WCMRuntimeException
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 reference to a ContentComponent with a name specified by the
 argument from this ContentComponentContainer; ContentComponents
 returned by this method must be treated as read-only.
getComponentNames() - 
Method in interface com.ibm.workplace.wcm.api.ContentComponentContainer
Returns a list of component names for all ContentComponents in
 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.
getContainingLibrary() - 
Method in interface com.ibm.workplace.wcm.api.DocumentId
Retrieves the DocumentLibary for the object with
 this ID.
getContent() - 
Method in interface com.ibm.workplace.wcm.api.RenderingContext
Returns the Content object that will be rendered by this
 RenderingContext.
getContentId() - 
Method in interface com.ibm.workplace.wcm.api.ContentLink
Get the ID of the Content linked to by this
 ContentLink.
getCount() - 
Method in interface com.ibm.workplace.wcm.api.ContentComponentIterator
Deprecated. Please use the following code instead. while (iter.hasNext()) count = count + 1;
getCount() - 
Method in interface com.ibm.workplace.wcm.api.DocumentIdIterator
Deprecated. Please use the following code instead. while (iter.hasNext()) count = count + 1;
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.
getCurrentDocumentLibrary() - 
Method in interface com.ibm.workplace.wcm.api.Workspace
Returns the current DocumentLibrary, which is being used
 for all operations except rendering.
getCurrentLocale() - 
Method in interface com.ibm.workplace.wcm.api.ContextProcessorParams
Returns the current users Locale
getDate() - 
Method in interface com.ibm.workplace.wcm.api.DateComponent
Returns the Date contained in this component as a Date.
getDate() - 
Method in interface com.ibm.workplace.wcm.api.HistoryLogEntry
Returns the date this Log Entry was created
getDate() - 
Method in interface com.ibm.workplace.wcm.api.LibraryDateComponent
Returns the Date contained in this component as a Date.
getDateType() - 
Method in interface com.ibm.workplace.wcm.api.DateComponent
Returns the formatting type set in this DateComponent.
getDateType() - 
Method in interface com.ibm.workplace.wcm.api.LibraryDateComponent
Returns the formatting type set in this LibraryDateComponent.
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.
getDescription() - 
Method in interface com.ibm.workplace.wcm.api.DocumentLibrary
Currently unimplemented.
getDirectChildren() - 
Method in interface com.ibm.workplace.wcm.api.SiteFrameworkContainer
Returns an iterator of DocumentId objects of the immediate children
 of this container.
getDirectParent() - 
Method in interface com.ibm.workplace.wcm.api.Content
Return the parent DocumentId of this content.
getDocumentLibraries() - 
Method in interface com.ibm.workplace.wcm.api.Workspace
Returns an iterator of all DocumentLibrary objects visible
 to the user of this Workspace.
getDocumentLibrary() - 
Method in interface com.ibm.workplace.wcm.api.DocumentManagerComponent
Returns the library name for the current Document as a String.
getDocumentLibrary() - 
Method in interface com.ibm.workplace.wcm.api.LibraryDocumentManagerComponent
Returns the library name for the current Document as a String.
getDocumentLibrary(String) - 
Method in interface com.ibm.workplace.wcm.api.Workspace
Returns the DocumentLibrary with the specified name, or
 null if a DocumentLibrary with that name
 does not exist or the caller does not have access
getDocumentPath() - 
Method in interface com.ibm.workplace.wcm.api.DocumentManagerComponent
Returns the document path ( folders and filename ) within the Document library
 for this document as a  String.
getDocumentPath() - 
Method in interface com.ibm.workplace.wcm.api.LibraryDocumentManagerComponent
Returns the path ( folders and filename ) within the Document library
 of the DocumentManager Document associated with this component, as a
 String.
getDocumentReference() - 
Method in interface com.ibm.workplace.wcm.api.LibraryLinkComponent
Retrieve the Document Reference of this Component.
getDocumentReference() - 
Method in interface com.ibm.workplace.wcm.api.LinkComponent
Retrieves the Document Reference of this Component.
getDraftIdByPublishedId(DocumentId) - 
Method in interface com.ibm.workplace.wcm.api.Workspace
Returns the DocumentId of the draft document associated
 with the supplied published/expired DocumentId
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.
getErrorCode() - 
Method in class com.ibm.workplace.wcm.api.exceptions.WCMRuntimeException
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.
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.
getHistoryLog() - 
Method in interface com.ibm.workplace.wcm.api.Document
Returns the history log of this 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.
getHTMLBody() - 
Method in interface com.ibm.workplace.wcm.api.LibraryLinkComponent
Retrieves the HTML written between the start and end anchor tags when this
 link is rendered.
getHTMLNameTag() - 
Method in interface com.ibm.workplace.wcm.api.LibraryImageComponent
Returns the HTML tag name of the image.
getId() - 
Method in interface com.ibm.workplace.wcm.api.Document
Returns the DocumentId of this Document object.
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.
getLibrary() - 
Method in interface com.ibm.workplace.wcm.api.RenderingContext
Returns the DocumentLibrary of the object being rendered.
getLibraryAccess() - 
Method in interface com.ibm.workplace.wcm.api.DocumentLibrary
Currently unimplemented.
getLibraryRelativePath() - 
Method in interface com.ibm.workplace.wcm.api.RenderingContext
Returns the path relative to the library of the object being rendered.
getLibraryResourceAccess(LibraryResourceType) - 
Method in interface com.ibm.workplace.wcm.api.DocumentLibrary
Currently unimplemented.
getLinkDescription() - 
Method in interface com.ibm.workplace.wcm.api.LibraryLinkComponent
Retrieves link description for title attribute of anchor tag
getLinkDescription() - 
Method in interface com.ibm.workplace.wcm.api.LinkComponent
Retrieves the description attribute of the anchor tag.
getLinkedChildren() - 
Method in interface com.ibm.workplace.wcm.api.SiteArea
Returns an iterator of DocumentId objects of the linked children
 of this container.
getLinkedParents() - 
Method in interface com.ibm.workplace.wcm.api.Content
Return an iterator of parent DocumentIds this content is linked to.
getLinkImage() - 
Method in interface com.ibm.workplace.wcm.api.LinkComponent
Retrieves the link image DocumentId.
getLinkTarget() - 
Method in interface com.ibm.workplace.wcm.api.LinkComponent
Retrieves the target window name.
getLinkTargetName() - 
Method in interface com.ibm.workplace.wcm.api.LibraryLinkComponent
Retrieves the target window name.
getLinkTargetString() - 
Method in interface com.ibm.workplace.wcm.api.LibraryLinkComponent
Retrive the target attribute.
getLinkText() - 
Method in interface com.ibm.workplace.wcm.api.LibraryLinkComponent
Retrieves the text written between the start and end anchor tags when this
 link is rendered.
getLinkText() - 
Method in interface com.ibm.workplace.wcm.api.LinkComponent
Gets the hyperlink display text
getLinkTextImage() - 
Method in interface com.ibm.workplace.wcm.api.LibraryLinkComponent
Retrieves the Link Text Image DocumentId, this image is written
 between the start and end anchor tags when this link is rendered.
getLinkTextType() - 
Method in interface com.ibm.workplace.wcm.api.LibraryLinkComponent
Retrieves the Link Text Type
getLinkTextType() - 
Method in interface com.ibm.workplace.wcm.api.LinkComponent
Retrieves the link text type.
getLinkType() - 
Method in interface com.ibm.workplace.wcm.api.LibraryLinkComponent
Retrieves the Link Type
getLinkType() - 
Method in interface com.ibm.workplace.wcm.api.LinkComponent
Retrieves the link type.
getLiveAccessMembers() - 
Method in interface com.ibm.workplace.wcm.api.Document
Deprecated. This method is deprecated from version 6.0. Calls to 
 'Live' access methods have the same effect as 'Read' access method calls.
getLocale() - 
Method in interface com.ibm.workplace.wcm.api.DocumentLibrary
Returns the Locale of this DocumentLibrary object.
getMediaType() - 
Method in interface com.ibm.workplace.wcm.api.LibraryStyleSheetComponent
The media type of this style-sheet.
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 interface com.ibm.workplace.wcm.api.HistoryLogEntry
Returns the message associated with this Log Entry
getMessage() - 
Method in class com.ibm.workplace.wcm.api.exceptions.WCMException
Retrieves the message that accompanies this exception.
getMessage() - 
Method in class com.ibm.workplace.wcm.api.exceptions.WCMRuntimeException
Retrieves the message that accompanies this exception.
getModifiedDate() - 
Method in interface com.ibm.workplace.wcm.api.Document
Returns the modified date of this document
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.
getName() - 
Method in interface com.ibm.workplace.wcm.api.DocumentLibrary
Returns the name of this DocumentLibrary object.
getName() - 
Method in interface com.ibm.workplace.wcm.api.HistoryLogEntry
Returns the name of the user associated with this Log Entry
getNameTag() - 
Method in interface com.ibm.workplace.wcm.api.ImageComponent
Returns the HTML tag name of the image.
getNumber() - 
Method in interface com.ibm.workplace.wcm.api.LibraryNumericComponent
Returns the Number contained in this component as a Number.
getNumber() - 
Method in interface com.ibm.workplace.wcm.api.NumericComponent
Returns the Number contained in this component as a Number.
getNumberType() - 
Method in interface com.ibm.workplace.wcm.api.LibraryNumericComponent
Returns the number type of this NumberComponent.
getNumberType() - 
Method in interface com.ibm.workplace.wcm.api.NumericComponent
Returns the number type of this NumberComponent.
getNumStages() - 
Method in interface com.ibm.workplace.wcm.api.Workflow
Returns the number of stages in this Workflow.
getOwnerLibrary() - 
Method in interface com.ibm.workplace.wcm.api.Document
Returns the library in which this Document object is
 stored.
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.
getParentId() - 
Method in interface com.ibm.workplace.wcm.api.ContentLink
Get the ID of the parent SiteArea that contains this
 ContentLink.
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.
getPathById(DocumentId, boolean, boolean) - 
Method in interface com.ibm.workplace.wcm.api.Workspace
Returns the path of the document with the given id.
getPortletId() - 
Method in interface com.ibm.workplace.wcm.api.ContextProcessorParams
Returns a string which uniquely identifies the current portlet instance
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.
getPublishedIdByDraftId(DocumentId) - 
Method in interface com.ibm.workplace.wcm.api.Workspace
Returns the DocumentId of the published or expired document associated
 with the supplied draft DocumentId
getQueryString() - 
Method in interface com.ibm.workplace.wcm.api.LibraryLinkComponent
Return the QueryString
getQueryString() - 
Method in interface com.ibm.workplace.wcm.api.LinkComponent
Returns the QueryString.
getReadAccessMembers() - 
Method in interface com.ibm.workplace.wcm.api.Document
Returns a string array of members who have Read access to
 this Document object.
getReferenceDisplayName() - 
Method in interface com.ibm.workplace.wcm.api.LibraryLinkComponent
Retrieves the reference display name as it show in the Authoring UI.
getReferenceDisplayName() - 
Method in interface com.ibm.workplace.wcm.api.LinkComponent
Retrives the reference display name as shown in the Authoring UI.
getReferences(DocumentId) - 
Method in interface com.ibm.workplace.wcm.api.Workspace
Returns an array of Reference instances that represent all references to the
 specified DocumentId.
getReferencesFrom(DocumentId) - 
Method in interface com.ibm.workplace.wcm.api.Workspace
Returns an array of Reference instances that represent all references from the
 specified DocumentId.
getRefererDocumentId() - 
Method in interface com.ibm.workplace.wcm.api.Reference
Returns the DocumentId of the Document object
 being referring to another Document.
getRenderingContext() - 
Method in interface com.ibm.workplace.wcm.api.ContextProcessorParams
Returns the WCM API RenderingContext for the current request
 
 
getRepository() - 
Method in class com.ibm.workplace.wcm.api.WCMApiServiceImpl
Deprecated. Replaced by WebContentService.getRepository()
getRepository() - 
Method in interface com.ibm.workplace.wcm.api.WCMServiceHome
Deprecated. Replaced by WebContentService.getRepository()
getRepository() - 
Static method in class com.ibm.workplace.wcm.api.WCM_API
Retrieve an instance of a Repository
getRepository() - 
Method in class com.ibm.workplace.wcm.api.WebContentService
Retrieve the Repository used to access WCM.
getRequestParameters() - 
Method in interface com.ibm.workplace.wcm.api.RenderingContext
Returns the current request parameters used by this
 RenderingContext.
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.
getSelections() - 
Method in interface com.ibm.workplace.wcm.api.LibraryUserSelectionComponent
Returns the array of Principals contained in this component as a Principal[].
getSelections() - 
Method in interface com.ibm.workplace.wcm.api.OptionSelectionComponent
Returns the array of Strings contained in this component as a String[].
getSelections() - 
Method in interface com.ibm.workplace.wcm.api.UserSelectionComponent
Returns the array of Principals contained in this component as a Principal[].
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.
getStyleSheet() - 
Method in interface com.ibm.workplace.wcm.api.LibraryStyleSheetComponent
Returns the contents of the style sheet file contained within this component
 as a byte array.
getStyleSheetFileName() - 
Method in interface com.ibm.workplace.wcm.api.LibraryStyleSheetComponent
Returns the filename of the style sheet file contained within this
 component.
getStyleSheetTitle() - 
Method in interface com.ibm.workplace.wcm.api.LibraryStyleSheetComponent
Returns the title of the style sheet.
getSystemWorkspace() - 
Method in interface com.ibm.workplace.wcm.api.Repository
Returns a Workspace object representing a sytem view of the repository.
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.
getTitle() - 
Method in interface com.ibm.workplace.wcm.api.Document
Returns the title of the controllable object that this Document refers to.
getTitle() - 
Method in interface com.ibm.workplace.wcm.api.DocumentLibrary
Currently unimplemented.
getType() - 
Method in interface com.ibm.workplace.wcm.api.DocumentId
Returns the type of the Document with this
 DocumentId.
getType() - 
Method in interface com.ibm.workplace.wcm.api.LibraryStyleSheetComponent
The type this style sheet.
getURL() - 
Method in interface com.ibm.workplace.wcm.api.LibraryLinkComponent
Retrieves the URL of the Link that this Component referring to
getURL() - 
Method in interface com.ibm.workplace.wcm.api.LinkComponent
Retrieves the URL of the link that this component references.
getURL() - 
Method in interface com.ibm.workplace.wcm.api.RenderingContext
Returns the URL to WCM and any request parameters.
getUsername() - 
Method in interface com.ibm.workplace.wcm.api.UserProfile
Returns the username of the user in this set of credentials.
getUserProfile() - 
Method in interface com.ibm.workplace.wcm.api.Workspace
Returns the UserProfile for the user of this
 Workspace.
getVersionName() - 
Method in interface com.ibm.workplace.wcm.api.DocumentManagerComponent
Returns the set verisonName to be used if the verison number is locked
getVersionName() - 
Method in interface com.ibm.workplace.wcm.api.LibraryDocumentManagerComponent
Returns the set version name to be used if the version number is locked
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() - 
Method in interface com.ibm.workplace.wcm.api.ContextProcessorParams
Returns the WCM API Workspace for the current user
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.
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.



H

hasAccess(DocumentId, int) - 
Method in interface com.ibm.workplace.wcm.api.Workspace
Checks if the user of the Workspace has the specified access to specified document.
hasAccess(DocumentId, UserProfile, int) - 
Method in interface com.ibm.workplace.wcm.api.Workspace
Checks if the UserProfile has the specified access to specified document.
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
 direct child or link to Content with the given DocumentId.
hasDeleteAccess() - 
Method in interface com.ibm.workplace.wcm.api.Document
Checks if the user of the Workspace associated with the current Document has  
 Delete access to this document.
hasDeleteAccess(UserProfile) - 
Method in interface com.ibm.workplace.wcm.api.Document
Checks if the UserProfile has Delete access to this document.
hasDirectContent(DocumentId) - 
Method in interface com.ibm.workplace.wcm.api.SiteArea
Returns true if this SiteArea object has a
 direct 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.
hasEditAccess() - 
Method in interface com.ibm.workplace.wcm.api.Document
Checks if the user of the Workspace associated with the current Document has  
 Edit access to this document.
hasEditAccess(UserProfile) - 
Method in interface com.ibm.workplace.wcm.api.Document
Checks if the UserProfile has Edit access to this document.
hasLinkedContent(DocumentId) - 
Method in interface com.ibm.workplace.wcm.api.SiteArea
Returns true if this SiteArea object has a
 content link to the Content with the given DocumentId.
hasLiveAccess() - 
Method in interface com.ibm.workplace.wcm.api.Document
Deprecated. This method is deprecated from version 6.0. Calls to 'Live' access 
 methods have the same effect as 'Read' access method calls.
hasLiveAccess(UserProfile) - 
Method in interface com.ibm.workplace.wcm.api.Document
Deprecated. This method is deprecated from version 6.0. Calls to 'Live' access 
 methods have the same effect as 'Read' access method calls.
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.
hasNext() - 
Method in interface com.ibm.workplace.wcm.api.DocumentIterator
Returns true if the iteration has more elements.
hasNext() - 
Method in interface com.ibm.workplace.wcm.api.HistoryLogIterator
Returns true if the iteration has more elements.
hasReadAccess() - 
Method in interface com.ibm.workplace.wcm.api.Document
Checks if the user of the Workspace associated with the current Document has 
 Read access to this document.
hasReadAccess(UserProfile) - 
Method in interface com.ibm.workplace.wcm.api.Document
Checks if the UserProfile has Read access to this document.
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.
HistoryLogEntry - interface com.ibm.workplace.wcm.api.HistoryLogEntry.
A read-only History Log Entry
HistoryLogIterator - interface com.ibm.workplace.wcm.api.HistoryLogIterator.
HistoryLogIterator iterates over HistoryLogEntry
 objects.
HTMLComponent - interface com.ibm.workplace.wcm.api.HTMLComponent.
Represents a HTML component.
HTMLComponent - 
Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for a HTMLComponent.



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(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(String, Throwable) - 
Constructor for class com.ibm.workplace.wcm.api.exceptions.IllegalTypeChangeException
Constructor that requires detail plus a cause exception
ImageComponent - interface com.ibm.workplace.wcm.api.ImageComponent.
Represents an Image component.
ImageComponent - 
Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for a ImageComponent.
insertContent(DocumentId, DocumentId) - 
Method in interface com.ibm.workplace.wcm.api.SiteArea
Deprecated. use Workspace.createContent(authoringTemplateId,
 parentSiteId, siblingId, position) instead
insertSiteArea(DocumentId, DocumentId) - 
Method in interface com.ibm.workplace.wcm.api.SiteFrameworkContainer
Deprecated. use Workspace.createSiteArea(parentId, siblingId, position)
 instead.
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.
isClearable() - 
Method in interface com.ibm.workplace.wcm.api.LibraryLinkComponent
Checks if the link can be cleared.
isClearable() - 
Method in interface com.ibm.workplace.wcm.api.LinkComponent
Checks if the link can be cleared.
isDeletionProhibited() - 
Method in interface com.ibm.workplace.wcm.api.DocumentLibrary
Currently unimplemented.
isDraft() - 
Method in interface com.ibm.workplace.wcm.api.Content
Return true if this content object is a draft.
isDraft() - 
Method in interface com.ibm.workplace.wcm.api.DocumentId
Returns true if the Document
 represented by this DocumentId is a draft document.
isEnabled() - 
Method in interface com.ibm.workplace.wcm.api.DocumentLibrary
Currently unimplemented.
isExpired() - 
Method in interface com.ibm.workplace.wcm.api.Content
Return true if this Content has expired.
isExpired() - 
Method in interface com.ibm.workplace.wcm.api.DocumentId
Returns true if the Document
 represented by this DocumentId is a expired document.
isLocked(DocumentId) - 
Method in interface com.ibm.workplace.wcm.api.Workspace
Indicates whether the DocumentId provided is locked or not
isLockedToVersion() - 
Method in interface com.ibm.workplace.wcm.api.DocumentManagerComponent
Returns true is the document is locked to a specific verison.
isLockedToVersion() - 
Method in interface com.ibm.workplace.wcm.api.LibraryDocumentManagerComponent
Returns true is the document is locked to a specific version.
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.
isPublished() - 
Method in interface com.ibm.workplace.wcm.api.DocumentId
Returns true if the Document
 represented by this DocumentId is a published document.
isSystemWorkspace() - 
Method in interface com.ibm.workplace.wcm.api.Workspace
 
isUseReferenceDescription() - 
Method in interface com.ibm.workplace.wcm.api.LibraryLinkComponent
Checks if we use the referenced Document description as the anchor tag title attribute
isUseReferenceDescription() - 
Method in interface com.ibm.workplace.wcm.api.LinkComponent
Checks if we use the referenced Document Description as the anchor tag title attribute.
isUseReferenceLinkText() - 
Method in interface com.ibm.workplace.wcm.api.LibraryLinkComponent
Checks if we use the referenced Document title as the default Link Text
isUseReferenceLinkTextEnabled() - 
Method in interface com.ibm.workplace.wcm.api.LinkComponent
Checks if we use the referenced document title as the default hyperlink display text.



L

LibraryComponent - interface com.ibm.workplace.wcm.api.LibraryComponent.
The root interface in the Library Component hierarchy.
LibraryComponent - 
Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for Library Components.
LibraryDateComponent - interface com.ibm.workplace.wcm.api.LibraryDateComponent.
Represents a Date component.
LibraryDateComponent - 
Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for a LibraryDateComponent.
LibraryDocumentManagerComponent - interface com.ibm.workplace.wcm.api.LibraryDocumentManagerComponent.
Represents a DocumentManager component.
LibraryDocumentManagerComponent - 
Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for a LibraryDocumentManagerComponent.
LibraryFileComponent - interface com.ibm.workplace.wcm.api.LibraryFileComponent.
Represents a File component that exists in the Component Library.
LibraryFileComponent - 
Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for a LibraryFileComponent.
LibraryHTMLComponent - interface com.ibm.workplace.wcm.api.LibraryHTMLComponent.
Represents a HTML component that exists in the Component Library.
LibraryHTMLComponent - 
Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for a LibraryHTMLComponent.
LibraryImageComponent - interface com.ibm.workplace.wcm.api.LibraryImageComponent.
Represents an Image component that exists in the Component Library.
LibraryImageComponent - 
Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for a LibraryImageComponent.
LibraryLinkComponent - interface com.ibm.workplace.wcm.api.LibraryLinkComponent.
Represents a Link component that exists in the Component Library.
LibraryLinkComponent - 
Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for LibraryLinkComponent
LibraryNumericComponent - interface com.ibm.workplace.wcm.api.LibraryNumericComponent.
Represents a Number component.
LibraryNumericComponent - 
Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for a LibraryNumericComponent.
LibraryStyleSheetComponent - interface com.ibm.workplace.wcm.api.LibraryStyleSheetComponent.
Represents a Style Sheet component that exists in the Component Library.
LibraryStyleSheetComponent - 
Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for a LibraryStyleSheetComponent.
LibraryUserSelectionComponent - interface com.ibm.workplace.wcm.api.LibraryUserSelectionComponent.
Represents a UserSelection component.
LibraryUserSelectionComponent - 
Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for a LibraryUserSelectionComponent.
LinkComponent - interface com.ibm.workplace.wcm.api.LinkComponent.
Represents a Link component.
lock(DocumentId) - 
Method in interface com.ibm.workplace.wcm.api.Workspace
Locks the document (draft or non-draft) provided by the DocumentId.
login() - 
Method in interface com.ibm.workplace.wcm.api.Workspace
Performs a login at the Workspace level
 
 
logout() - 
Method in interface com.ibm.workplace.wcm.api.Workspace
Performs a logout at the Workspace level
 
 



M

MEDIA_TYPE_ALL - 
Static variable in interface com.ibm.workplace.wcm.api.LibraryStyleSheetComponent
Target style rules for any media-type device
MEDIA_TYPE_AURAL - 
Static variable in interface com.ibm.workplace.wcm.api.LibraryStyleSheetComponent
Target style rules for speech and sound synthesizers
MEDIA_TYPE_BRAILLE - 
Static variable in interface com.ibm.workplace.wcm.api.LibraryStyleSheetComponent
Target style rules for Braille trouch-feedback devices
MEDIA_TYPE_HANDHELD - 
Static variable in interface com.ibm.workplace.wcm.api.LibraryStyleSheetComponent
Target style rules for small or handheld devices
MEDIA_TYPE_PRINT - 
Static variable in interface com.ibm.workplace.wcm.api.LibraryStyleSheetComponent
Target style rules for page-by-page use, typically printed on paper
MEDIA_TYPE_PROJECTION - 
Static variable in interface com.ibm.workplace.wcm.api.LibraryStyleSheetComponent
Target style rules for projection using transparent media
MEDIA_TYPE_SCREEN - 
Static variable in interface com.ibm.workplace.wcm.api.LibraryStyleSheetComponent
Target style rules for continuous (non-paged) color computer screens
MEDIA_TYPE_TTY - 
Static variable in interface com.ibm.workplace.wcm.api.LibraryStyleSheetComponent
Target style rules for media that uses a fixed-pitch character grid
MEDIA_TYPE_TV - 
Static variable in interface com.ibm.workplace.wcm.api.LibraryStyleSheetComponent
Target style rules for television-link devices
MEDIA_TYPE_UNSPECIFIED - 
Static variable in interface com.ibm.workplace.wcm.api.LibraryStyleSheetComponent
No style rules have been specified
moveCategory(DocumentId, DocumentId) - 
Method in interface com.ibm.workplace.wcm.api.Workspace
Moves a category and adds it under a new parent.
moveSiteFrameworkDocument(DocumentId, DocumentId, DocumentId, int) - 
Method in interface com.ibm.workplace.wcm.api.Workspace
This method moves hierarchical items (SiteArea,
 Content, or ContentLink to another library.
moveToLibrary(DocumentLibrary, DocumentId) - 
Method in interface com.ibm.workplace.wcm.api.Workspace
This method moves non-hierarchical or root items to another library.



N

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.
next() - 
Method in interface com.ibm.workplace.wcm.api.DocumentIterator
Returns the next element in the interation.
next() - 
Method in interface com.ibm.workplace.wcm.api.HistoryLogIterator
Returns the next element in the interation.
nextDocument() - 
Method in interface com.ibm.workplace.wcm.api.DocumentIterator
Returns the next Document in the interation.
nextId() - 
Method in interface com.ibm.workplace.wcm.api.DocumentIdIterator
Returns the next DocumentId in the interation.
nextLogEntry() - 
Method in interface com.ibm.workplace.wcm.api.HistoryLogIterator
Returns the next HistoryLogEntry in the interation.
nextWorkflowStage() - 
Method in interface com.ibm.workplace.wcm.api.Content
Move this Content object into the next stage in its
 workflow.
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(String, Throwable) - 
Constructor for class com.ibm.workplace.wcm.api.exceptions.NoMoreWorkflowStagesException
Constructor that requires detail plus a cause exception
NumericComponent - interface com.ibm.workplace.wcm.api.NumericComponent.
Represents a Number component.
NumericComponent - 
Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for a NumericComponent.



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(String, Throwable) - 
Constructor for class com.ibm.workplace.wcm.api.exceptions.OperationFailedException
Constructor that requires detail plus a cause exception
OptionSelectionComponent - interface com.ibm.workplace.wcm.api.OptionSelectionComponent.
Represents a OptionSelection component.
OptionSelectionComponent - 
Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for a OptionSelectionComponent.



P

PresentationTemplate - interface com.ibm.workplace.wcm.api.PresentationTemplate.
Represents a Presentation Template in the repository.
PresentationTemplate - 
Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for a PresentationTemplate
printStackTrace() - 
Method in class com.ibm.workplace.wcm.api.exceptions.WCMException
Overridden to include cause
printStackTrace() - 
Method in class com.ibm.workplace.wcm.api.exceptions.WCMRuntimeException
Overridden to include cause
printStackTrace(PrintStream) - 
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.WCMRuntimeException
Overridden to include cause
printStackTrace(PrintWriter) - 
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.WCMRuntimeException
Overridden to include cause
process(HttpSession, ContextProcessorParams) - 
Method in interface com.ibm.workplace.wcm.api.ContextProcessor
Processes the supplied ContextProcessorParams and updates parameters within
 as necessary
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(String, Throwable) - 
Constructor for class com.ibm.workplace.wcm.api.exceptions.PropertyRetrievalException
Constructor that requires detail plus a cause exception



R

Reference - interface com.ibm.workplace.wcm.api.Reference.
An interface defining a reference from one entity in the repository to another.
ReferenceComponent - interface com.ibm.workplace.wcm.api.ReferenceComponent.
Represents a component that can contain a reference to one
 LibraryComponent.
ReferenceComponent - 
Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for a ReferenceComponent.
refreshDocument() - 
Method in interface com.ibm.workplace.wcm.api.DocumentManagerComponent
Refresh the document information, including latest version information for the document
 from Document Manager.
refreshDocument() - 
Method in interface com.ibm.workplace.wcm.api.LibraryDocumentManagerComponent
Refresh the document information, including latest version information for the document
 from Document Manager.
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.
remove() - 
Method in interface com.ibm.workplace.wcm.api.DocumentIterator
This method is not implemented.
remove() - 
Method in interface com.ibm.workplace.wcm.api.HistoryLogIterator
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.
removeComponent(String) - 
Method in interface com.ibm.workplace.wcm.api.ContentComponentContainer
Removes the ContentComponent with the name specified by the
 argument in this ContentComponentContainer.
removeContent(DocumentId) - 
Method in interface com.ibm.workplace.wcm.api.SiteArea
Deprecated. use Workspace.delete(DocumentId) instead.
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
Deprecated. This method is deprecated from version 6.0. Calls to 'Live' 
 access methods have the same effect as 'Read' access method calls.
removeLiveAccessMembers(String[]) - 
Method in interface com.ibm.workplace.wcm.api.EditableLibraryComponent
Deprecated. This method is deprecated from version 6.0. Calls to
 'Live' access methods have the same effect as 'Read' access method calls.
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
Deprecated. use Workspace.delete(id) instead.
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.
RenderingContext - interface com.ibm.workplace.wcm.api.RenderingContext.
Represents a rendering context.
replace(DocumentId) - 
Method in interface com.ibm.workplace.wcm.api.Reference
Replace the referer's reference with the specified Document
replaceReferences(Reference[], DocumentId) - 
Method in interface com.ibm.workplace.wcm.api.Workspace
Replaces all the refences represented by the array of Reference instances
 with the new object represented by the specified DocumentId.
Repository - interface com.ibm.workplace.wcm.api.Repository.
The entry point into the WCM repository.
restartWorkflow() - 
Method in interface com.ibm.workplace.wcm.api.Content
Restart the workflow on this Content object.
RichTextComponent - interface com.ibm.workplace.wcm.api.RichTextComponent.
Represents a Rich Text component.
RichTextComponent - 
Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for a RichTextComponent.
ROLE_APPROVER - 
Static variable in interface com.ibm.workplace.wcm.api.Workspace
Constant for Content Approver
ROLE_AUTHOR - 
Static variable in interface com.ibm.workplace.wcm.api.Workspace
Constant for Content Author
ROLE_OWNER - 
Static variable in interface com.ibm.workplace.wcm.api.Workspace
Constant for Content Owner



S

save(Document) - 
Method in interface com.ibm.workplace.wcm.api.Workspace
Saves an editable document to the WCM repository.
SECURITY_DELETE_ACCESS - 
Static variable in interface com.ibm.workplace.wcm.api.Workspace
security delete access
SECURITY_EDIT_ACCESS - 
Static variable in interface com.ibm.workplace.wcm.api.Workspace
security edit access
SECURITY_READ_ACCESS - 
Static variable in interface com.ibm.workplace.wcm.api.Workspace
security read access
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(String, Throwable) - 
Constructor for class com.ibm.workplace.wcm.api.exceptions.ServiceNotAvailableException
Constructor that requires detail plus a cause exception
setAdditionalAttribute(String) - 
Method in interface com.ibm.workplace.wcm.api.LibraryLinkComponent
Sets Additional Attribute for HTML anchor tag properties.
setAdditionalAttribute(String) - 
Method in interface com.ibm.workplace.wcm.api.LinkComponent
Sets an additional attribute for the HTML anchor tag.
setAllowClear(boolean) - 
Method in interface com.ibm.workplace.wcm.api.LibraryLinkComponent
Enable/Disable whether link may be cleared
setAllowClear(boolean) - 
Method in interface com.ibm.workplace.wcm.api.LinkComponent
Enables/Disables whether link may be cleared.
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.
setCurrentDocumentLibrary(DocumentLibrary) - 
Method in interface com.ibm.workplace.wcm.api.Workspace
Sets the current DocumentLibrary for this
 Workspace.
setDate(Date) - 
Method in interface com.ibm.workplace.wcm.api.DateComponent
Sets the Date contained in this DateComponent.
setDate(Date) - 
Method in interface com.ibm.workplace.wcm.api.LibraryDateComponent
Sets the Date contained in this DateComponent.
setDateType(int) - 
Method in interface com.ibm.workplace.wcm.api.DateComponent
Sets the formatting type for this DateComponent.
setDateType(int) - 
Method in interface com.ibm.workplace.wcm.api.LibraryDateComponent
Sets the formatting type for this LibraryDateComponent.
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.
setDeletionProhibited(boolean) - 
Method in interface com.ibm.workplace.wcm.api.DocumentLibrary
Currently unimplemented.
setDescription(String) - 
Method in interface com.ibm.workplace.wcm.api.DocumentLibrary
Currently unimplemented.
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.
setDocumentInformation(String, String) - 
Method in interface com.ibm.workplace.wcm.api.DocumentManagerComponent
Sets the Document library and path information for the DocumentManager Document associated with this component.
setDocumentInformation(String, String) - 
Method in interface com.ibm.workplace.wcm.api.LibraryDocumentManagerComponent
Sets the Document library and path information for the DocumentManager Document associated with this component.
setDocumentReference(DocumentId) - 
Method in interface com.ibm.workplace.wcm.api.LibraryLinkComponent
Sets the Document Reference of this Component to the document provided.
setDocumentReference(DocumentId) - 
Method in interface com.ibm.workplace.wcm.api.LinkComponent
Sets the Document Reference of this Component to the document provided.
setEffectiveDate(Date) - 
Method in interface com.ibm.workplace.wcm.api.Content
Sets the effective date of this Content document.
setEnabled(boolean) - 
Method in interface com.ibm.workplace.wcm.api.DocumentLibrary
Currently unimplemented.
setExpiryDate(Date) - 
Method in interface com.ibm.workplace.wcm.api.Content
Sets the expiry date for this Content document.
setExternalReference(String) - 
Method in interface com.ibm.workplace.wcm.api.LibraryLinkComponent
Sets the External URL Reference of this Component to the URL provided.
setExternalReference(String) - 
Method in interface com.ibm.workplace.wcm.api.LinkComponent
Sets the External URL Reference of this Component to the URL provided.
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.
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.
setHTML(String) - 
Method in interface com.ibm.workplace.wcm.api.HTMLComponent
Sets the HTML contained in this HTMLComponent.
setHTML(String) - 
Method in interface com.ibm.workplace.wcm.api.LibraryHTMLComponent
Sets the HTML contained in this LibraryHTMLComponent from the 
 specified html argument.
setHTML(String, EmbeddedImageMap) - 
Method in interface com.ibm.workplace.wcm.api.HTMLComponent
Deprecated. This method is deprecated from version 6.0. 
 Use HTMLComponent.setHTML(String) instead.
setHTML(String, EmbeddedImageMap) - 
Method in interface com.ibm.workplace.wcm.api.LibraryHTMLComponent
Deprecated. This method is deprecated from version 6.0. 
 Use LibraryHTMLComponent.setHTML(String) instead.
setHTMLBody(String) - 
Method in interface com.ibm.workplace.wcm.api.LibraryLinkComponent
Sets the HTML to be written between the start and end anchor tags when this
 link is rendered.
setHTMLNameTag(String) - 
Method in interface com.ibm.workplace.wcm.api.LibraryImageComponent
Sets the HTML tag name of the image.
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.
setLibraryAccess(DocumentLibraryACL) - 
Method in interface com.ibm.workplace.wcm.api.DocumentLibrary
Currently unimplemented.
setLibraryResourceAccess(LibraryResourceType, DocumentLibraryACL) - 
Method in interface com.ibm.workplace.wcm.api.DocumentLibrary
Currently unimplemented.
setLinkDescription(String) - 
Method in interface com.ibm.workplace.wcm.api.LibraryLinkComponent
Sets Link description for title attribute of anchor tag.
setLinkDescription(String) - 
Method in interface com.ibm.workplace.wcm.api.LinkComponent
Sets the description attribute of the anchor tag.
setLinkImage(DocumentId) - 
Method in interface com.ibm.workplace.wcm.api.LinkComponent
Sets the image of the DocumentId as the link image.
setLinkTarget(String) - 
Method in interface com.ibm.workplace.wcm.api.LinkComponent
Sets the target window name.
setLinkTargetName(String) - 
Method in interface com.ibm.workplace.wcm.api.LibraryLinkComponent
Sets the target window name.
setLinkTargetString(String) - 
Method in interface com.ibm.workplace.wcm.api.LibraryLinkComponent
Sets the Target of the anchor tag target attribute
setLinkText(String) - 
Method in interface com.ibm.workplace.wcm.api.LibraryLinkComponent
Sets the plain text to be written between the start and end anchor tags when this
 link is rendered.
setLinkText(String) - 
Method in interface com.ibm.workplace.wcm.api.LinkComponent
Sets the hyperlink display text.
setLinkTextImage(DocumentId) - 
Method in interface com.ibm.workplace.wcm.api.LibraryLinkComponent
Sets the image of the DocumentId as the Link Text image.
setLockToVersion(boolean) - 
Method in interface com.ibm.workplace.wcm.api.DocumentManagerComponent
Sets the current lock state for the document,
 If locked is true then the docuemnt will be locked to the
 current document version.
setLockToVersion(boolean) - 
Method in interface com.ibm.workplace.wcm.api.LibraryDocumentManagerComponent
Sets the current lock state for the document,
 if locked is true then the document will be locked to the
 current document version.
setMediaType(int) - 
Method in interface com.ibm.workplace.wcm.api.LibraryStyleSheetComponent
Sets the media type of the style sheet.
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.
setNumber(Number) - 
Method in interface com.ibm.workplace.wcm.api.LibraryNumericComponent
Sets the Number contained in this NumericComponent.
setNumber(Number) - 
Method in interface com.ibm.workplace.wcm.api.NumericComponent
Sets the Number contained in this NumericComponent.
setNumberType(int) - 
Method in interface com.ibm.workplace.wcm.api.LibraryNumericComponent
Sets the number type contained in this NumericComponent.
setNumberType(int) - 
Method in interface com.ibm.workplace.wcm.api.NumericComponent
Sets the Number Type contained in this NumericComponent.
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.
setQueryString(String) - 
Method in interface com.ibm.workplace.wcm.api.LibraryLinkComponent
Sets the Query String to append to URL
setQueryString(String) - 
Method in interface com.ibm.workplace.wcm.api.LinkComponent
Sets the query string append to a URL.
setRenderedContent(Content, SiteArea) - 
Method in interface com.ibm.workplace.wcm.api.RenderingContext
Sets the Content object to be rendered.
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(String) - 
Method in interface com.ibm.workplace.wcm.api.RenderingContext
Sets the full path of the Content to render.
setRenderingContext(RenderingContext) - 
Method in interface com.ibm.workplace.wcm.api.ContextProcessorParams
Sets the WCM API RenderingContext for the current request
setRequestParameters(Map) - 
Method in interface com.ibm.workplace.wcm.api.RenderingContext
Sets the request parameters to be used by this
 RenderingContext while rendering.
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
Deprecated. This method is deprecated from version 6.0. 
 Use RichTextComponent.setRichText(String) instead.
setSelections(Principal[]) - 
Method in interface com.ibm.workplace.wcm.api.LibraryUserSelectionComponent
Sets the Principal[] contained in this UserSelectionComponent.
setSelections(Principal[]) - 
Method in interface com.ibm.workplace.wcm.api.UserSelectionComponent
Sets the Principal[] contained in this UserSelectionComponent.
setSelections(String[]) - 
Method in interface com.ibm.workplace.wcm.api.OptionSelectionComponent
Sets the String[] contained in this OptionSelectionComponent.
setStyleSheet(String, byte[]) - 
Method in interface com.ibm.workplace.wcm.api.LibraryStyleSheetComponent
Sets the style sheet file contained within this component.
setStyleSheetTitle(String) - 
Method in interface com.ibm.workplace.wcm.api.LibraryStyleSheetComponent
Sets the title of the style sheet.
setText(String) - 
Method in interface com.ibm.workplace.wcm.api.TextComponent
Sets the plain text contained in this TextComponent.
setTitle(String) - 
Method in interface com.ibm.workplace.wcm.api.DocumentLibrary
Currently unimplemented.
setTitle(String) - 
Method in interface com.ibm.workplace.wcm.api.Editable
Sets the title of this Editable object to the
 specified String argument.
setTitle(String) - 
Method in interface com.ibm.workplace.wcm.api.EditableLibraryComponent
Sets the title of this EditableLibraryComponent object to the
 specified String argument.
setType(int) - 
Method in interface com.ibm.workplace.wcm.api.LibraryStyleSheetComponent
Sets the type of the style sheet.
setUseReferenceDescription(boolean) - 
Method in interface com.ibm.workplace.wcm.api.LibraryLinkComponent
Enable/Disable use of the referenced Document description as the anchor tag title attribute
setUseReferenceDescription(boolean) - 
Method in interface com.ibm.workplace.wcm.api.LinkComponent
Enables/Disables the usage of the referenced document description as the anchor tag title attribute.
setUseReferenceLinkText(boolean) - 
Method in interface com.ibm.workplace.wcm.api.LibraryLinkComponent
Enable/Disable use of the referenced Document title as the Link Text
setUseReferenceLinkText(boolean) - 
Method in interface com.ibm.workplace.wcm.api.LinkComponent
Enables/Disables the usage of the referenced document title as the hyperlink display text.
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.
Site - interface com.ibm.workplace.wcm.api.Site.
Represents a Site object.
Site - 
Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for Site
SiteArea - interface com.ibm.workplace.wcm.api.SiteArea.
Represents a SiteArea object.
SiteArea - 
Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for SiteArea
SiteFrameworkContainer - interface com.ibm.workplace.wcm.api.SiteFrameworkContainer.
The ability to organize and build a Site Framework is enabled
 by implementing the SiteFrameworkContainer interface.
START - 
Static variable in interface com.ibm.workplace.wcm.api.ChildPosition
Child position constant indicating the item will be placed at the start of the index.



T

Taxonomy - interface com.ibm.workplace.wcm.api.Taxonomy.
Represents a Taxonomy in the repository.
Taxonomy - 
Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for Taxonomy
TEXT_HTML - 
Static variable in interface com.ibm.workplace.wcm.api.LibraryLinkComponent
A format for the Link.
TEXT_LIBRARYIMAGE - 
Static variable in interface com.ibm.workplace.wcm.api.LibraryLinkComponent
A format for the Link.
TEXT_LIBRARYIMAGE - 
Static variable in interface com.ibm.workplace.wcm.api.LinkComponent
The hyperlink displays text as the defined library image.
TEXT_PLAINTEXT - 
Static variable in interface com.ibm.workplace.wcm.api.LibraryLinkComponent
A format for the Link.
TEXT_PLAINTEXT - 
Static variable in interface com.ibm.workplace.wcm.api.LinkComponent
The hyperlink displays text as plain text.
TextComponent - interface com.ibm.workplace.wcm.api.TextComponent.
Represents a Text component.
TextComponent - 
Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for a TextComponent.
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.
TYPE_ALTERNATE - 
Static variable in interface com.ibm.workplace.wcm.api.LibraryStyleSheetComponent
Alternate style sheets grouped under a single style name.
TYPE_DATE - 
Static variable in interface com.ibm.workplace.wcm.api.DateComponent
Type constant indicating that the Date returned from this DateComponent
 will be formatted to only show the date.
TYPE_DATE - 
Static variable in interface com.ibm.workplace.wcm.api.LibraryDateComponent
Type constant indicating that the Date returned from this DateComponent
 will be formatted to only show the date.
TYPE_DOUBLE - 
Static variable in interface com.ibm.workplace.wcm.api.LibraryNumericComponent
Type constant indicating that the Number returned will be a double.
TYPE_DOUBLE - 
Static variable in interface com.ibm.workplace.wcm.api.NumericComponent
Type constant indicating that the Number returned will be a double.
TYPE_EXISTINGLINK - 
Static variable in interface com.ibm.workplace.wcm.api.LibraryLinkComponent
A type of Link.
TYPE_EXISTINGLINK - 
Static variable in interface com.ibm.workplace.wcm.api.LinkComponent
TYPE_EXISTINGLINK references an existing link component.
TYPE_EXTERNALURL - 
Static variable in interface com.ibm.workplace.wcm.api.LibraryLinkComponent
A type of Link.
TYPE_EXTERNALURL - 
Static variable in interface com.ibm.workplace.wcm.api.LinkComponent
TYPE_EXTERNALURL references an external URL.
TYPE_INTEGER - 
Static variable in interface com.ibm.workplace.wcm.api.LibraryNumericComponent
Type constant indicating that the Number returned will be an integer.
TYPE_INTEGER - 
Static variable in interface com.ibm.workplace.wcm.api.NumericComponent
Type constant indicating that the Number returned will be an integer.
TYPE_MANAGEDCONTENT - 
Static variable in interface com.ibm.workplace.wcm.api.LibraryLinkComponent
A type of Link.
TYPE_MANAGEDCONTENT - 
Static variable in interface com.ibm.workplace.wcm.api.LinkComponent
TYPE_MANAGEDCONTENT references content, file or image resources.
TYPE_PERSISTENT - 
Static variable in interface com.ibm.workplace.wcm.api.LibraryStyleSheetComponent
A style sheet that user agents must apply in addition to alternate style sheets.
TYPE_PREFERRED - 
Static variable in interface com.ibm.workplace.wcm.api.LibraryStyleSheetComponent
The authors preferred cascading style sheet, that should be applied unless the user
 selects an alternate style
TYPE_TIME - 
Static variable in interface com.ibm.workplace.wcm.api.DateComponent
Type constant indicating that the Date returned from this DateComponent
 will be formatted to only show the time.
TYPE_TIME - 
Static variable in interface com.ibm.workplace.wcm.api.LibraryDateComponent
Type constant indicating that the Date returned from this DateComponent
 will be formatted to only show the time.
TYPE_TIME_AND_DATE - 
Static variable in interface com.ibm.workplace.wcm.api.DateComponent
Type constant indicating that the Date returned from this DateComponent
 will be formatted to show the time and date.
TYPE_TIME_AND_DATE - 
Static variable in interface com.ibm.workplace.wcm.api.LibraryDateComponent
Type constant indicating that the Date returned from this DateComponent
 will be formatted to show the time and date.



U

unlock(DocumentId) - 
Method in interface com.ibm.workplace.wcm.api.Workspace
Unlocks the document (draft or non-draft) provided by the DocumentId.
useLiveAccess(boolean) - 
Method in interface com.ibm.workplace.wcm.api.Workspace
Deprecated. This method is deprecated from version 6.0. Calls to 'Live' access methods have the same
 effect as 'Read' access method calls.
UserProfile - interface com.ibm.workplace.wcm.api.UserProfile.
The UserProfile interface retrieves user related information.
UserSelectionComponent - interface com.ibm.workplace.wcm.api.UserSelectionComponent.
Represents a UserSelection component.
UserSelectionComponent - 
Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for a UserSelectionComponent.



W

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
 
WCMApiService - class com.ibm.workplace.wcm.api.WCMApiService.
Deprecated. Replaced by WebContentService
WCMApiService() - 
Constructor for class com.ibm.workplace.wcm.api.WCMApiService
Deprecated.  
WCMApiServiceImpl - class com.ibm.workplace.wcm.api.WCMApiServiceImpl.
Deprecated. Replaced by WebContentService
WCMApiServiceImpl() - 
Constructor for class com.ibm.workplace.wcm.api.WCMApiServiceImpl
Deprecated. WCMApiService implementation constructor
WCMException - exception com.ibm.workplace.wcm.api.exceptions.WCMException.
The base Lotus Workplace Web Content Management API Exception.
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
WCMIllegalStateException - exception com.ibm.workplace.wcm.api.exceptions.WCMIllegalStateException.
 
WCMIllegalStateException() - 
Constructor for class com.ibm.workplace.wcm.api.exceptions.WCMIllegalStateException
Constructor.
WCMIllegalStateException(String) - 
Constructor for class com.ibm.workplace.wcm.api.exceptions.WCMIllegalStateException
Constructs a new exception with the given message.
WCMIllegalStateException(String, Throwable) - 
Constructor for class com.ibm.workplace.wcm.api.exceptions.WCMIllegalStateException
Constructor that requires detail plus a cause exception
WCMRuntimeException - exception com.ibm.workplace.wcm.api.exceptions.WCMRuntimeException.
The base Lotus Workplace Web Content Management API Runtime Exception.
WCMRuntimeException(String) - 
Constructor for class com.ibm.workplace.wcm.api.exceptions.WCMRuntimeException
Constructor that requires detail
WCMRuntimeException(String, Throwable) - 
Constructor for class com.ibm.workplace.wcm.api.exceptions.WCMRuntimeException
Constructor that requires detail plus a cause exception
WCMServiceHome - interface com.ibm.workplace.wcm.api.WCMServiceHome.
Deprecated. Replaced by WebContentService
WebContentService - class com.ibm.workplace.wcm.api.WebContentService.
WebContentService enables access to the WCM API through Portal services.
WebContentService() - 
Constructor for class com.ibm.workplace.wcm.api.WebContentService
 
Workflow - interface com.ibm.workplace.wcm.api.Workflow.
Represents a workflow.
Workflow - 
Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for Workflow
WorkflowNotFoundException - exception com.ibm.workplace.wcm.api.exceptions.WorkflowNotFoundException.
A WorkflowNotFoundException is thrown if the Document
 being accessed is not workflowable.
WorkflowNotFoundException() - 
Constructor for class com.ibm.workplace.wcm.api.exceptions.WorkflowNotFoundException
Constructor.
WorkflowNotFoundException(String) - 
Constructor for class com.ibm.workplace.wcm.api.exceptions.WorkflowNotFoundException
Constructs a new exception with the given message.
WorkflowNotFoundException(String, Throwable) - 
Constructor for class com.ibm.workplace.wcm.api.exceptions.WorkflowNotFoundException
Constructor that requires detail plus a cause exception
WorkflowStage - interface com.ibm.workplace.wcm.api.WorkflowStage.
Represents a workflow stage.
WorkflowStage - 
Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
The document type for WorkflowStage
WORKFLOWSTATUS_ALL - 
Static variable in interface com.ibm.workplace.wcm.api.Workspace
workflow status for draft, published or expired.
WORKFLOWSTATUS_DRAFT - 
Static variable in interface com.ibm.workplace.wcm.api.Workspace
workflow status for draft
 These constants can be bit-OR'ed together
WORKFLOWSTATUS_EXPIRED - 
Static variable in interface com.ibm.workplace.wcm.api.Workspace
workflow status for expired.
WORKFLOWSTATUS_PUBLISHED - 
Static variable in interface com.ibm.workplace.wcm.api.Workspace
workflow status for published
 These constants can be bit-OR'ed together
Workspace - interface com.ibm.workplace.wcm.api.Workspace.
Represents a view of the WCM repository for a particular user.

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







  
      Overview 
      Package 
      Class 
      Tree 
      Deprecated 
    Index 
      Help 
  









 PREV 
 NEXT

  FRAMES   
 NO FRAMES