+

Search Tips | Advanced Search

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

A

addAdditionalViewers(String[]) - Method in interface com.ibm.workplace.wcm.api.WorkflowedDocument

Adds names to the list of additional live viewers for this Document document.

addApprovers(String[]) - Method in interface com.ibm.workplace.wcm.api.WorkflowedDocument

Adds each approver specified in the string array argument to the approvers of this Document object.

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.

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

addContributorAccessMembers(String[]) - Method in interface com.ibm.workplace.wcm.api.Editable

Adds each name specified in the string array argument to the members who have Contributor access to this Editable object.

addDeleteAccessMembers(String[]) - Method in interface com.ibm.workplace.wcm.api.Editable

Deprecated. Use Editable.addManagerAccessMembers(String[]) instead

addEditAccessMembers(String[]) - Method in interface com.ibm.workplace.wcm.api.Editable

Deprecated. Use Editable.addEditorAccessMembers(String[]) instead

addEditorAccessMembers(String[]) - Method in interface com.ibm.workplace.wcm.api.Editable

Adds each name specified in the string array argument to the members who have Editor access to this Editable 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. Use Editable.addUserAccessMembers(String[]) instead

addManagerAccessMembers(String[]) - Method in interface com.ibm.workplace.wcm.api.Editable

Adds each name specified in the string array argument to the members who have Manager access to this Editable object.

addMembers(LibraryMemberRole, String[]) - Method in interface com.ibm.workplace.wcm.api.DocumentLibraryACL

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.

addReadAccessMembers(String[]) - Method in interface com.ibm.workplace.wcm.api.Editable

Deprecated. Use Editable.addContributorAccessMembers(String[]) instead

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.

addUserAccessMembers(String[]) - Method in interface com.ibm.workplace.wcm.api.Editable

Adds each name specified in the string array argument to the members who have User access to this Editable object.

Administrator - Static variable in interface com.ibm.workplace.wcm.api.LibraryMemberRoles

Below are all defined library member roles

ADMINISTRATOR_STRING - Static variable in class com.ibm.workplace.wcm.api.LibraryMemberRoleConstants

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 in com.ibm.workplace.wcm.api

Represents an authoring template.

AuthoringTemplate - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes

The document type for AuthoringTemplate

AuthoringTemplate - Static variable in interface com.ibm.workplace.wcm.api.LibraryResourceTypes

AuthorizationException - Exception in com.ibm.workplace.wcm.api.exceptions

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 exception com.ibm.workplace.wcm.api.exceptions.AuthorizationException

Constructor.

AuthorizationException(String) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.AuthorizationException

Constructs a new exception with the given message.

AuthorizationException(String, Throwable) - Constructor for exception 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

cancelDraft() - Method in interface com.ibm.workplace.wcm.api.Content

Deprecated. use cancelDraftDocument() instead.

cancelDraftDocument() - Method in interface com.ibm.workplace.wcm.api.WorkflowedDocument

Cancels a draft document, if it exists.

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 in com.ibm.workplace.wcm.api

Represents a Category in the repository.

Category - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes

The document type for Category

ChildPosition - Interface in com.ibm.workplace.wcm.api

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

This package defines the Lotus Web Content Management API.

com.ibm.workplace.wcm.api.authoring - package com.ibm.workplace.wcm.api.authoring

com.ibm.workplace.wcm.api.custom - package com.ibm.workplace.wcm.api.custom

This package defines the Lotus Web Content Management API interfaces for custom code.

com.ibm.workplace.wcm.api.exceptions - package com.ibm.workplace.wcm.api.exceptions

This package defines the exceptions used in the Lotus Web Content Management API.

com.ibm.workplace.wcm.api.extensions.validation - package com.ibm.workplace.wcm.api.extensions.validation

Component - Static variable in interface com.ibm.workplace.wcm.api.LibraryResourceTypes

componentIterator() - Method in interface com.ibm.workplace.wcm.api.ContentComponentContainer

Returns an iterator of all ContentComponent objects in this ContentComponentContainer.

ComponentNotFoundException - Exception in com.ibm.workplace.wcm.api.exceptions

A ComponentNotFoundException is thrown if the API user attempts to access a component that does not exist.

ComponentNotFoundException() - Constructor for exception com.ibm.workplace.wcm.api.exceptions.ComponentNotFoundException

Constructor.

ComponentNotFoundException(String) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.ComponentNotFoundException

Constructs a new exception with the given message.

ComponentNotFoundException(String, Throwable) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.ComponentNotFoundException

Constructor that requires detail plus a cause exception

Content - Interface in com.ibm.workplace.wcm.api

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

Content - Static variable in interface com.ibm.workplace.wcm.api.LibraryResourceTypes

ContentComponent - Interface in com.ibm.workplace.wcm.api

The root interface in the Content Component hierarchy.

ContentComponentContainer - Interface in com.ibm.workplace.wcm.api

The root interface for the content component container hierarchy.

ContentComponentIterator - Interface in com.ibm.workplace.wcm.api

ContentComponentIterator, as the name suggests, iterates over ContentComponent objects in a ContentComponentContainer.

ContentLink - Interface in com.ibm.workplace.wcm.api

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.

contentSearch(DocumentId, DocumentId[], DocumentId[], String[], boolean, boolean, boolean, String, String, 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 in com.ibm.workplace.wcm.api

Represents a context processor.

ContextProcessorParams - Interface in com.ibm.workplace.wcm.api

Represents the parameters that a context processor is able to read and modify.

CONTINUE - Static variable in interface com.ibm.workplace.wcm.api.custom.Directives

Directs system to continue standard processing the target Document.

Contributor - Static variable in interface com.ibm.workplace.wcm.api.LibraryMemberRoles

CONTRIBUTOR_STRING - Static variable in class com.ibm.workplace.wcm.api.LibraryMemberRoleConstants

copyCategory(DocumentId, DocumentId) - Method in interface com.ibm.workplace.wcm.api.Workspace

Copies a category and adds it under a new parent.

copyLibraries(Workspace, DocumentLibrary[]) - Method in class com.ibm.workplace.wcm.api.WebContentLibraryService

Copies the supplied document libraries as new libraries.

copyLibraries(Workspace, DocumentLibrary[], Locale) - Method in class com.ibm.workplace.wcm.api.WebContentLibraryService

Copies the supplied document libraries as new libraries with the specified Locale.

copyLibrary(Workspace, DocumentLibrary, Locale) - Method in class com.ibm.workplace.wcm.api.WebContentLibraryService

Copies the supplied document library as a new library.

COPYRIGHT - Static variable in class com.ibm.workplace.wcm.api.CSVDocumentListWriter

Copyright statement

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.

CREATE_DRAFT - Static variable in interface com.ibm.workplace.wcm.api.custom.Directives

Directs system to create a draft of the target Document.

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

Deprecated. use createDraftDocument() instead.

createDraftDocument() - Method in interface com.ibm.workplace.wcm.api.WorkflowedDocument

Create draft copy of this WorkflowedDocument 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.

createJSPComponent() - Method in interface com.ibm.workplace.wcm.api.Workspace

Creates a new LibraryJSPComponent.

createLibrary(Workspace, Locale) - Method in class com.ibm.workplace.wcm.api.WebContentLibraryService

Creates a new Library.

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.

createPresentationTemplate() - Method in interface com.ibm.workplace.wcm.api.Workspace

Creates a new PresentationTemplate.

createRenderingContext(ServletRequest, ServletResponse, Map) - Method in interface com.ibm.workplace.wcm.api.Workspace

Creates a new rendering context.

createRenderingContext(ServletRequest, ServletResponse, Map, String, String) - Method in interface com.ibm.workplace.wcm.api.Workspace

Creates a new rendering context.

createRenderingContext(PortletRequest, PortletResponse, Map) - Method in interface com.ibm.workplace.wcm.api.Workspace

Creates a new rendering context.

createRenderingContext(PortletRequest, PortletResponse, Map, String, String) - Method in interface com.ibm.workplace.wcm.api.Workspace

Creates a new rendering context.

com.ibm.workplace.wcm.api.custom.Directive, java.lang.String)">createResult(Directive, String) - Method in interface com.ibm.workplace.wcm.api.custom.CustomWorkflowService

Create an instance of a CustomWorkflowActionResult

com.ibm.workplace.wcm.api.custom.Directive, java.lang.String)">createResult(Directive, String) - Method in class com.ibm.workplace.wcm.api.WebContentCustomWorkflowService

Create an instance of a CustomWorkflowActionResult

createRichTextComponent() - Method in interface com.ibm.workplace.wcm.api.Workspace

Creates a new LibraryRichTextComponent.

createShortTextComponent() - Method in interface com.ibm.workplace.wcm.api.Workspace

Creates a new LibraryShortTextComponent.

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.

createTextComponent() - Method in interface com.ibm.workplace.wcm.api.Workspace

Creates a new LibraryTextComponent.

createUserSelectionComponent() - Method in interface com.ibm.workplace.wcm.api.Workspace

Creates a new LibraryUserSelectionComponent.

CSVDocumentListWriter - Class in com.ibm.workplace.wcm.api

Implementation of a DocumentListWriter that writes a document list as comma separated value list with each document in a single row.

CSVDocumentListWriter(Writer) - Constructor for class com.ibm.workplace.wcm.api.CSVDocumentListWriter

Create a new CSVDocumentListWriter object that writes to the passed character stream and uses the default separator CSVDocumentListWriter.DEFAULT_SEPARATOR

CSVDocumentListWriter(Writer, String) - Constructor for class com.ibm.workplace.wcm.api.CSVDocumentListWriter

Create a new CSVDocumentListWriter object that writes to the passed character stream and uses the passed separator.

CustomItemBean - Interface in com.ibm.workplace.wcm.api.authoring

CustomItemBean Interface for the CustomItemBean used for custom JSP usage for WCM Authoring UI

CustomWorkflowAction - Interface in com.ibm.workplace.wcm.api.custom

Interface that must be implemented by all classes that will be executed by a Custom Action.

CustomWorkflowActionFactory - Interface in com.ibm.workplace.wcm.api.custom

Factory interface for producing custom workflow actions.

CustomWorkflowActionResult - Interface in com.ibm.workplace.wcm.api.custom

Represents the result from a custom workflow action.

CustomWorkflowService - Interface in com.ibm.workplace.wcm.api.custom

Service to configure custom workflow functions.

D

DATE_EXECUTE_NOW - Static variable in interface com.ibm.workplace.wcm.api.custom.CustomWorkflowAction

Date constant to return in getExecuteDate if the custom workflow action is due to execute immediately.

DateComponent - Interface in com.ibm.workplace.wcm.api

Represents a Date component.

DateComponent - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes

The document type for a DateComponent.

DECLINE - Static variable in interface com.ibm.workplace.wcm.api.custom.Directives

Directs system to decline the target Document.

decline() - Method in interface com.ibm.workplace.wcm.api.WorkflowedDocument

Declines this document.

DEFAULT_SEPARATOR - Static variable in class com.ibm.workplace.wcm.api.CSVDocumentListWriter

The default separator "," used when no other separator string was set

Delegator - Static variable in interface com.ibm.workplace.wcm.api.LibraryMemberRoles

DELEGATOR_STRING - Static variable in class com.ibm.workplace.wcm.api.LibraryMemberRoleConstants

delete(DocumentId) - Method in interface com.ibm.workplace.wcm.api.Workspace

Deletes an editable document from the WCM repository.

deleteLibrary(Workspace, DocumentLibrary) - Method in class com.ibm.workplace.wcm.api.WebContentLibraryService

Deletes the DocumentLibrary.

Directive - Interface in com.ibm.workplace.wcm.api.custom

A directive is returned within a CustomWorkflowActionResult.

Directives - Interface in com.ibm.workplace.wcm.api.custom

Provides access to Directive objects.

DisableDocumentTypeException - Exception in com.ibm.workplace.wcm.api.exceptions

DisableDocumentTypeException description

DisableDocumentTypeException() - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DisableDocumentTypeException

Document - Interface in com.ibm.workplace.wcm.api

An interface defining an object that exists as an entity in the repository.

DocumentCreationException - Exception in com.ibm.workplace.wcm.api.exceptions

This exception is thrown if an error occurs while attempting to create a Document in the repository.

DocumentCreationException() - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DocumentCreationException

Constructor.

DocumentCreationException(String) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DocumentCreationException

Constructs a new exception with the given message.

DocumentCreationException(String, Throwable) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DocumentCreationException

Constructor that requires detail plus a cause exception

DocumentDeleteException - Exception in com.ibm.workplace.wcm.api.exceptions

This exception is thrown if an error occurs while trying to delete a Document from the repository.

DocumentDeleteException() - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DocumentDeleteException

Constructor.

DocumentDeleteException(String) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DocumentDeleteException

Constructs a new exception with the given message.

DocumentDeleteException(String, Throwable) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DocumentDeleteException

Constructor that requires detail plus a cause exception

DocumentDeleteReferentialIntegrityException - Exception in com.ibm.workplace.wcm.api.exceptions

This exception is thrown if a referential integrity error occurs while trying to delete a Document from the repository.

DocumentDeleteReferentialIntegrityException() - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DocumentDeleteReferentialIntegrityException

Constructor.

DocumentDeleteReferentialIntegrityException(String) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DocumentDeleteReferentialIntegrityException

Constructs a new exception with the given message.

DocumentDeleteReferentialIntegrityException(String, Throwable) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DocumentDeleteReferentialIntegrityException

Constructor that requires detail plus a cause exception

DocumentId - Interface in com.ibm.workplace.wcm.api

Represents the ID of a Document in the repository.

DocumentIdCreationException - Exception in com.ibm.workplace.wcm.api.exceptions

This exception is thrown if a DocumentId could not be created.

DocumentIdCreationException() - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DocumentIdCreationException

Constructor.

DocumentIdCreationException(String) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DocumentIdCreationException

Constructs a new exception with the given message.

DocumentIdCreationException(String, Throwable) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DocumentIdCreationException

Constructor that requires detail plus a cause exception

DocumentIdIterator - Interface in com.ibm.workplace.wcm.api

DocumentIdIterator iterates over DocumentId objects.

DocumentIsLockedException - Exception in com.ibm.workplace.wcm.api.exceptions

A DocumentIsLockedException is thrown if the Document is currently locked and refreshDocument is invoked aginst the doucment.

DocumentIsLockedException() - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DocumentIsLockedException

Constructor

DocumentIsLockedException(Throwable) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DocumentIsLockedException

Constructor that requires a cause exception

DocumentIsLockedException(String) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DocumentIsLockedException

Constructor that requires detail

DocumentIsLockedException(String, Throwable) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DocumentIsLockedException

Constructor that requires detail plus a cause exception

DocumentIterator - Interface in com.ibm.workplace.wcm.api

DocumentIterator iterates over Document objects.

DocumentLibrary - Interface in com.ibm.workplace.wcm.api

Represents a library containing Documents.

DocumentLibraryACL - Interface in com.ibm.workplace.wcm.api

DocumentListWriter - Interface in com.ibm.workplace.wcm.api

The DocumentListWriter interface defines a character writer that can be used to write a list with information about documents from a document library.

DocumentManagerComponent - Interface in com.ibm.workplace.wcm.api

Represents a DocumentManager component.

DocumentManagerComponent - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes

The document type for a DocumentManagerComponent.

DocumentNotFoundException - Exception in com.ibm.workplace.wcm.api.exceptions

A DocumentNotFoundException is thrown if the Document being accessed could not be found in the repository.

DocumentNotFoundException() - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DocumentNotFoundException

Constructor.

DocumentNotFoundException(String) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DocumentNotFoundException

Constructs a new exception with the given message.

DocumentNotFoundException(String, Throwable) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DocumentNotFoundException

Constructor that requires detail plus a cause exception

DocumentPurgeException - Exception in com.ibm.workplace.wcm.api.exceptions

This exception is thrown if an error occurs while trying to purge a Document from the repository.

DocumentPurgeException() - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DocumentPurgeException

Constructor.

DocumentPurgeException(String) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DocumentPurgeException

Constructs a new exception with the given message.

DocumentPurgeException(String, Throwable) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DocumentPurgeException

Constructor that requires detail plus a cause exception

DocumentRetrievalException - Exception in com.ibm.workplace.wcm.api.exceptions

This exception is thrown if an error occurs while attempting to retrieve a Document from the repository.

DocumentRetrievalException() - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DocumentRetrievalException

Constructor.

DocumentRetrievalException(String) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DocumentRetrievalException

Constructs a new exception with the given message.

DocumentRetrievalException(String, Throwable) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DocumentRetrievalException

Constructor that requires detail plus a cause exception

DocumentSaveException - Exception in com.ibm.workplace.wcm.api.exceptions

This exception is thrown if an error occurs while saving a Document to the repository.

DocumentSaveException() - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DocumentSaveException

Constructor.

DocumentSaveException(String) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DocumentSaveException

Constructs a new exception with the given message.

DocumentSaveException(String, Throwable) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DocumentSaveException

Constructor that requires detail plus a cause exception

DocumentSaveReferentialIntegrityException - Exception in com.ibm.workplace.wcm.api.exceptions

This exception is thrown if a referential integrity error occurs while trying to save a Document in the repository.

DocumentSaveReferentialIntegrityException() - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DocumentSaveReferentialIntegrityException

Constructor.

DocumentSaveReferentialIntegrityException(String) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DocumentSaveReferentialIntegrityException

Constructs a new exception with the given message.

DocumentSaveReferentialIntegrityException(String, Throwable) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DocumentSaveReferentialIntegrityException

Constructor that requires detail plus a cause exception

DocumentType - Interface in com.ibm.workplace.wcm.api

This interface is used to define the types of documents that are available to the API.

DocumentTypes - Interface in com.ibm.workplace.wcm.api

This interface holds constants that define each of the DocumentTypes that are known to the API.

DuplicateChildException - Exception in com.ibm.workplace.wcm.api.exceptions

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 exception com.ibm.workplace.wcm.api.exceptions.DuplicateChildException

Constructor.

DuplicateChildException(String) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DuplicateChildException

Constructs a new exception with the given message.

DuplicateChildException(String, Throwable) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DuplicateChildException

Constructor that requires detail plus a cause exception

DuplicateComponentException - Exception in com.ibm.workplace.wcm.api.exceptions

A DuplicateComponentException is thrown if the API user attempts to add a component with the same name as an existing component.

DuplicateComponentException() - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DuplicateComponentException

Constructor.

DuplicateComponentException(String) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DuplicateComponentException

Constructs a new exception with the given message.

DuplicateComponentException(String, Throwable) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DuplicateComponentException

Constructor that requires detail plus a cause exception

DuplicateMappingException - Exception in com.ibm.workplace.wcm.api.exceptions

This exception is thrown if the AuthoringTemplate to PresentationTemplate mapping already exists for the Document.

DuplicateMappingException() - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DuplicateMappingException

Constructor.

DuplicateMappingException(String) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DuplicateMappingException

Constructs a new exception with the given message.

DuplicateMappingException(String, Throwable) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.DuplicateMappingException

Constructor that requires detail plus a cause exception

E

Editable - Interface in com.ibm.workplace.wcm.api

Defines the behaviour for editable objects within the API.

EditableLibraryComponent - Interface in com.ibm.workplace.wcm.api

The EditableLibraryComponent interface represents components that can be stored in the repository that are both Editable through this API and a Library Component.

Editor - Static variable in interface com.ibm.workplace.wcm.api.LibraryMemberRoles

EDITOR_STRING - Static variable in class com.ibm.workplace.wcm.api.LibraryMemberRoleConstants

EditorBean - Interface in com.ibm.workplace.wcm.api.authoring

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 exception com.ibm.workplace.wcm.api.exceptions.WCMException

The default error code

ERR_APTRIX - Static variable in exception com.ibm.workplace.wcm.api.exceptions.WCMRuntimeException

The default error code

execute(Document) - Method in interface com.ibm.workplace.wcm.api.custom.CustomWorkflowAction

Execute the action against the supplied document.

exists(DocumentId) - Method in interface com.ibm.workplace.wcm.api.Workspace

Tests the existence of an object in the repository.

exportLibraryToStream(Workspace, DocumentLibrary, OutputStream) - Method in class com.ibm.workplace.wcm.api.WebContentLibraryService

Export a document library to the supplied output stream.

F

factoryExists(String) - Method in interface com.ibm.workplace.wcm.api.custom.CustomWorkflowService

Determine if a factory with the supplied factory name exists as a registered custom workflow action factory.

factoryExists(String) - Method in class com.ibm.workplace.wcm.api.WebContentCustomWorkflowService

Determine if a factory with the supplied factory name exists as a registered custom workflow action factory.

FileComponent - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes

The document type for a FileComponent.

FileComponent - Interface in com.ibm.workplace.wcm.api

Represents a File component.

FileUploadValidationContext - Interface in com.ibm.workplace.wcm.api.extensions.validation

Passed to the validation plugin as part of the validate method.

FileUploadValidationException - Exception in com.ibm.workplace.wcm.api.extensions.validation

A FileUploadValidationException if any error occurs while validation file contents by a FileUploadValidation Plugin.

FileUploadValidationException() - Constructor for exception com.ibm.workplace.wcm.api.extensions.validation.FileUploadValidationException

Constructs a new exception with the given message.

FileUploadValidationException(String, Throwable) - Constructor for exception com.ibm.workplace.wcm.api.extensions.validation.FileUploadValidationException

Constructs a new exception with the given message.

FileUploadValidationException(String) - Constructor for exception com.ibm.workplace.wcm.api.extensions.validation.FileUploadValidationException

Constructs a new exception with the given message.

FileUploadValidationException(Throwable) - Constructor for exception com.ibm.workplace.wcm.api.extensions.validation.FileUploadValidationException

Constructs a new exception with the given message.

FileUploadValidationPlugin - Interface in com.ibm.workplace.wcm.api.extensions.validation

Represents a FileUploadValidation plugin.

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.

findByName(DocumentType, String, int) - 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 that match the given workflow status filter.

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.

findByType(DocumentType, int) - Method in interface com.ibm.workplace.wcm.api.Workspace

Returns an iterator of IDs of all objects of the given type that match the given workflow status filter.

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.

findContentByAuthoringTemplate(DocumentId, int) - 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 that match the given workflow status filter.

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.

findContentByCategory(DocumentId, int) - 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 that match the given workflow status filter.

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[], String[], int) - Method in interface com.ibm.workplace.wcm.api.Workspace

Find content by workflow stage for users in particular roles.

findContentByWorkflowStage(DocumentId[]) - Method in interface com.ibm.workplace.wcm.api.Workspace

Returns an iterator of all content in the given workflow stages.

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.

findContentModifiedBetween(Date, Date, int) - 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 that match the given workflow status filter.

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.

findContentModifiedSince(Date, int) - 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 that match the given workflow status filter.

findDocumentsByWorkflowStage(DocumentId[]) - Method in interface com.ibm.workplace.wcm.api.Workspace

Returns an iterator of all Documents in the given workflow stages.

findDocumentsByWorkflowStage(DocumentId[], String[], int) - Method in interface com.ibm.workplace.wcm.api.Workspace

Find Documents by workflow stage for users in particular roles.

findDocumentsModifiedBetween(Date, Date) - Method in interface com.ibm.workplace.wcm.api.Workspace

Returns an iterator of IDs of all Documents that have been modified between the specified start and end dates.

findDocumentsModifiedBetween(Date, Date, int) - Method in interface com.ibm.workplace.wcm.api.Workspace

Returns an iterator of IDs of all Documents that have been modified between the specified start and end dates.

findDocumentsModifiedSince(Date) - Method in interface com.ibm.workplace.wcm.api.Workspace

Returns an iterator of IDs of all Documents that have been modified since the specified date.

findDocumentsModifiedSince(Date, int) - Method in interface com.ibm.workplace.wcm.api.Workspace

Returns an iterator of IDs of all Documents that have been modified since the specified date.

findItemsDeletedBefore(Date, DocumentType, DocumentId) - Method in interface com.ibm.workplace.wcm.api.Workspace

Returns a DocumentIdIterator of deleted documents restricted by date, document type and workflow stage.

findItemsDeletedBetween(Date, Date, DocumentType, DocumentId) - Method in interface com.ibm.workplace.wcm.api.Workspace

Returns a DocumentIdIterator of documents restricted by date, workflow stage and document type

findItemsDeletedSince(Date, DocumentType, DocumentId) - Method in interface com.ibm.workplace.wcm.api.Workspace

Returns a DocumentIdIterator of documents restricted by date, workflow stage and document type

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.

getAction(String, Document) - Method in interface com.ibm.workplace.wcm.api.custom.CustomWorkflowActionFactory

Get an instance of the custom workflow action to execute.

getActionDescription(Locale, String) - Method in interface com.ibm.workplace.wcm.api.custom.CustomWorkflowActionFactory

Get the description for the supplied action name

getActionNames() - Method in interface com.ibm.workplace.wcm.api.custom.CustomWorkflowActionFactory

Get an array of action names supported by this factory.

getActionTitle(Locale, String) - Method in interface com.ibm.workplace.wcm.api.custom.CustomWorkflowActionFactory

Get the display title for the supplied action name.

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.WorkflowedDocument

Returns an array of names of additional live viewers for this Document 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(int) - 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.

getAllDirectChildren(int) - Method in interface com.ibm.workplace.wcm.api.SiteFrameworkContainer

Returns a depth first iterator over all children of this Site or SiteArea, excluding ContentLinks.

getAllFactories() - Method in interface com.ibm.workplace.wcm.api.custom.CustomWorkflowService

Get all of the registered custom workflow action factories.

getAllFactories() - Method in class com.ibm.workplace.wcm.api.WebContentCustomWorkflowService

Get all of the registered custom workflow action factories.

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.

getAvailableSelectionValues() - Method in interface com.ibm.workplace.wcm.api.OptionSelectionComponent

Returns the array of available options defined in the authoring template for this OptionSelectionComponent

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 exception com.ibm.workplace.wcm.api.exceptions.WCMException

Retrieves the cause exception for this exception

getCause() - Method in exception 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(int) - 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.

getContributorAccessMembers() - Method in interface com.ibm.workplace.wcm.api.Document

Returns a string array of members who have Contributor access to this Document object.

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;

getCreationDate() - Method in interface com.ibm.workplace.wcm.api.Document

Returns the creation date of this document

getCurrentApprovers() - Method in interface com.ibm.workplace.wcm.api.WorkflowedDocument

Returns a string array of members who have Approver access to this Document object.

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

getCurrentResultId() - Method in interface com.ibm.workplace.wcm.api.RenderingContext

Returns the current result DocumentId value.

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

Deprecated. Use Document.getManagerAccessMembers() instead

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

Returns the description for this DocumentLibrary

getDirectChildren() - Method in interface com.ibm.workplace.wcm.api.SiteFrameworkContainer

Returns an iterator of DocumentId objects of the immediate children of this container.

getDirectChildren(int) - Method in interface com.ibm.workplace.wcm.api.SiteFrameworkContainer

Returns an iterator of DocumentId objects of the immediate children of this container.

getDirection() - Method in interface com.ibm.workplace.wcm.api.authoring.EditorBean

Returns the default text direction of this editor control.

getDirective() - Method in interface com.ibm.workplace.wcm.api.custom.CustomWorkflowActionResult

Get a directive to instruct the system to perform an action against the target Document.

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.LibraryTaskResult

Returns an array of all DocumentLibrary objects that were created during the operation (either successfully or unsuccessfully)

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.authoring.CustomItemBean

getDocumentPath returns the path to the document associated with this CustomItemBean

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.

getDocumentType() - Method in interface com.ibm.workplace.wcm.api.extensions.validation.FileUploadValidationContext

Return a DocuemntType indicating the type of Component that will hold the File bytes being validated.

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

Deprecated. Use Document.getEditorAccessMembers() instead

getEditorAccessMembers() - Method in interface com.ibm.workplace.wcm.api.Document

Returns a string array of members who have Editor access to this Document object.

getEffectiveDate() - Method in interface com.ibm.workplace.wcm.api.WorkflowedDocument

Returns the effective date of this Document.

getEncoding() - Method in interface com.ibm.workplace.wcm.api.authoring.CustomItemBean

getEncoding returns encoding associated with CustomItemBean

getErrorCode() - Method in exception com.ibm.workplace.wcm.api.exceptions.WCMException

The error code for this exception.

getErrorCode() - Method in exception com.ibm.workplace.wcm.api.exceptions.WCMRuntimeException

The error code for this exception.

getErrorMessage() - Method in interface com.ibm.workplace.wcm.api.JSPComponent

Returns the error message contained in this component as a String.

getErrorMessage() - Method in interface com.ibm.workplace.wcm.api.LibraryJSPComponent

Returns the error message contained in this component as a String.

getExecuteDate(Document) - Method in interface com.ibm.workplace.wcm.api.custom.CustomWorkflowAction

Get the Date that this action should execute.

getExpiryDate() - Method in interface com.ibm.workplace.wcm.api.WorkflowedDocument

Returns the expiry date for this Document document.

getFactory(String) - Method in interface com.ibm.workplace.wcm.api.custom.CustomWorkflowService

Get a factory given a factory name

getFactory(String) - Method in class com.ibm.workplace.wcm.api.WebContentCustomWorkflowService

Get a factory given a factory name

getFieldName() - Method in interface com.ibm.workplace.wcm.api.authoring.CustomItemBean

getFieldName returns the fieldname associated with the CustomItemBean

getFieldValue() - Method in interface com.ibm.workplace.wcm.api.authoring.CustomItemBean

getFieldValue returns the value of the field associated with the CustomItemBean

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

Deprecated. - use getFileStream() instead

getFileName() - Method in interface com.ibm.workplace.wcm.api.extensions.validation.FileUploadValidationContext

File name of the uploaded file,

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.

getFileSize() - Method in interface com.ibm.workplace.wcm.api.extensions.validation.FileUploadValidationContext

Size of the File/Stream to be validate

getFileStream() - Method in interface com.ibm.workplace.wcm.api.LibraryFileComponent

Returns the contents of the file contained within this component as a input stream

getGeneralDateOne() - Method in interface com.ibm.workplace.wcm.api.WorkflowedDocument

Return general date one for this Document document.

getGeneralDateTwo() - Method in interface com.ibm.workplace.wcm.api.WorkflowedDocument

Return general date two for this Document document.

getHeight() - Method in interface com.ibm.workplace.wcm.api.authoring.EditorBean

Returns the pixel height of this editor component.

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.

getHiddenContentFieldName() - Method in interface com.ibm.workplace.wcm.api.authoring.EditorBean

Returns the name of the hidden form field that will be used to accept editor content.

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.

getHTML() - Method in interface com.ibm.workplace.wcm.api.PresentationTemplate

Returns the HTML contained in this Presentation Template 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.

getId() - Method in interface com.ibm.workplace.wcm.api.DocumentId

Returns the unique Id of the Document with this DocumentId.

getId() - Method in interface com.ibm.workplace.wcm.api.DocumentLibrary

Returns the unique Id of this DocumentLibrary 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

Deprecated. use getImageStream() instead

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.

getImageStream() - Method in interface com.ibm.workplace.wcm.api.LibraryImageComponent

Returns the contents of the image file contained within this component as a input stream

getInheritedContributorAccessMembers() - Method in interface com.ibm.workplace.wcm.api.Document

Returns a string array of members who have inherited Contributor access to this Document object.

getInheritedEditorAccessMembers() - Method in interface com.ibm.workplace.wcm.api.Document

Returns a string array of members who have inherited Editor access to this Document object.

getInheritedManagerAccessMembers() - Method in interface com.ibm.workplace.wcm.api.Document

Returns a string array of members who have inherited Manager access to this Document object.

getInheritedUserAccessMembers() - Method in interface com.ibm.workplace.wcm.api.Document

Returns a string array of members who have inherited User access to this Document object.

getItemsAlreadyRemoved() - Method in interface com.ibm.workplace.wcm.api.SyndicationResult

Returns all of the items that were to be removed, but did not exist on the subscriber.

getItemsCreated() - Method in interface com.ibm.workplace.wcm.api.SyndicationResult

Returns the total number of items that were created by the update.

getItemsFailedToRemove() - Method in interface com.ibm.workplace.wcm.api.SyndicationResult

Returns the total number of items for which the remove failed.

getItemsNotRequiringUpdates() - Method in interface com.ibm.workplace.wcm.api.SyndicationResult

Returns the total number of updates that were sent, but not processed because the item was already up to date on the subscriber.

getItemsRemoved() - Method in interface com.ibm.workplace.wcm.api.SyndicationResult

Returns the number of items successfully removed on the subscriber.

getItemsUpdated() - Method in interface com.ibm.workplace.wcm.api.SyndicationResult

Returns the total number of item updates to pre-existing items on the subscriber.

getItemUpdatesFailed() - Method in interface com.ibm.workplace.wcm.api.SyndicationResult

Returns the total number of items for which the update failed.

getJspPath() - Method in interface com.ibm.workplace.wcm.api.JSPComponent

Returns the JSP path contained in this component as a String.

getJspPath() - Method in interface com.ibm.workplace.wcm.api.LibraryJSPComponent

Returns the JSP path contained in this component as a String.

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.

getLastRunDate() - Method in interface com.ibm.workplace.wcm.api.SyndicationStatus

Returns the Date the last time a syndication had occurred.

getLibraries(Workspace) - Method in interface com.ibm.workplace.wcm.api.Syndicator

Returns an array of document libraries which are currently being syndicated by this Syndicator.

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

Returns the access control object for this DocumentLibrary

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

Returns the access control object for a library resource (e.g.

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. Use Document.getUserAccessMembers() instead

getLocale() - Method in interface com.ibm.workplace.wcm.api.DocumentLibrary

Returns the Locale of this DocumentLibrary object.

getManagerAccessMembers() - Method in interface com.ibm.workplace.wcm.api.Document

Returns a string array of members who have Manager access to this Document 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

Deprecated. Use the PUMA API

getMemberNames(String) - Method in interface com.ibm.workplace.wcm.api.Workspace

Deprecated. Use the PUMA API

getMembers(LibraryMemberRole) - Method in interface com.ibm.workplace.wcm.api.DocumentLibraryACL

getMessage() - Method in interface com.ibm.workplace.wcm.api.custom.CustomWorkflowActionResult

Get message for this result.

getMessage() - Method in exception com.ibm.workplace.wcm.api.exceptions.WCMException

Retrieves the message that accompanies this exception.

getMessage() - Method in exception com.ibm.workplace.wcm.api.exceptions.WCMRuntimeException

Retrieves the message that accompanies this exception.

getMessage() - Method in interface com.ibm.workplace.wcm.api.HistoryLogEntry

Returns the message associated with this Log Entry

getMimeType() - Method in interface com.ibm.workplace.wcm.api.extensions.validation.FileUploadValidationContext

MimeType for the file.

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.authoring.EditorBean

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.custom.CustomWorkflowActionFactory

Get the name for this factory.

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.extensions.validation.FileUploadValidationPlugin

Returns the name for this plugin

getName() - Method in interface com.ibm.workplace.wcm.api.HistoryLogEntry

Returns the name of the user associated with this Log Entry

getName() - Method in interface com.ibm.workplace.wcm.api.Subscriber

Returns the name of this subscriber.

getName() - Method in interface com.ibm.workplace.wcm.api.Syndicator

Returns the name of this syndicator.

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

Deprecated. Use Document.getContributorAccessMembers() instead

getReason() - Method in exception com.ibm.workplace.wcm.api.extensions.validation.FileUploadValidationException

Retrieves the detailed reason for validation failure.

getReason(Locale) - Method in exception com.ibm.workplace.wcm.api.extensions.validation.FileUploadValidationException

Retrieves the detailed reason for validation failure.

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() - Static method in class com.ibm.workplace.wcm.api.WCM_API

Retrieve an instance of a Repository

getRepository() - Method in interface com.ibm.workplace.wcm.api.WCMServiceHome

Deprecated. Replaced by WebContentService.getRepository()

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.

getResultType() - Method in interface com.ibm.workplace.wcm.api.LibraryTaskResult

Retrieves the result type of an operation

getRichText() - Method in interface com.ibm.workplace.wcm.api.LibraryRichTextComponent

Returns the rich text contained in this component as a String representation of the HTML.

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.

getSize() - Method in interface com.ibm.workplace.wcm.api.FileComponent

Returns the size in bytes of the file contained within this component.

getSize() - Method in interface com.ibm.workplace.wcm.api.ImageComponent

Returns the size in bytes of the file contained within this component.

getSize() - Method in interface com.ibm.workplace.wcm.api.LibraryFileComponent

Returns the size in bytes of the file contained within this component.

getSize() - Method in interface com.ibm.workplace.wcm.api.LibraryImageComponent

Returns the size in bytes of the file contained within this component.

getSourceWorkspace() - Method in interface com.ibm.workplace.wcm.api.Document

Returns the Workspace of this Document object.

getStagesIterator() - Method in interface com.ibm.workplace.wcm.api.Workflow

Returns an iterator of DocumentId objects of the WorkflowStages in this Workflow.

getStatus() - Method in interface com.ibm.workplace.wcm.api.Subscriber

Returns the SyndicationStatus of this Subscriber.

getStatus() - Method in interface com.ibm.workplace.wcm.api.Syndicator

Returns the SyndicationStatus of this Syndicator.

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.

getStyleSheetURL() - Method in interface com.ibm.workplace.wcm.api.authoring.EditorBean

getSubmitFunctionName() - Method in interface com.ibm.workplace.wcm.api.authoring.CustomItemBean

getSubmitFunctionName get the name of the submit function.

getSubscriberByName(Workspace, String) - Method in class com.ibm.workplace.wcm.api.SyndicationService

Returns the Subscriber with the specified name, or null if a Subscriber with that name does not exist or the caller does not have access

getSubscribers(Workspace) - Method in class com.ibm.workplace.wcm.api.SyndicationService

Returns an iterator of all Subscriber objects visible to the user of the Workspace.

getSyndicationResult() - Method in interface com.ibm.workplace.wcm.api.SyndicationStatus

Returns the SyndicationResult for the last time the syndication occurred.

getSyndicatorByName(Workspace, String) - Method in class com.ibm.workplace.wcm.api.SyndicationService

Returns the Syndicator with the specified name, or null if a Syndicator with that name does not exist or the caller does not have access

getSyndicators(Workspace) - Method in class com.ibm.workplace.wcm.api.SyndicationService

Returns an iterator of all Syndicator objects visible to the user of the Workspace.

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.LibraryTextComponent

Returns the text contained in this component as a String.

getText() - Method in interface com.ibm.workplace.wcm.api.TextComponent

Returns the text contained in this component as a String.

getTitle(Locale) - Method in interface com.ibm.workplace.wcm.api.custom.CustomWorkflowActionFactory

Get the display title for this factory.

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

Returns the title of this DocumentLibrary object.

getTotalRemovesAttempted() - Method in interface com.ibm.workplace.wcm.api.SyndicationResult

Returns all of the items that were marked for removal.

getTotalUpdatesAttempted() - Method in interface com.ibm.workplace.wcm.api.SyndicationResult

Returns the total number of updates attempted.

getTotalUpdatesFailed() - Method in interface com.ibm.workplace.wcm.api.SyndicationResult

Returns the total number of modifications that failed.

getTotalUpdatesSent() - Method in interface com.ibm.workplace.wcm.api.SyndicationResult

Returns the total number of items that was sent in this syndication run.

getTotalUpdatesSucceeded() - Method in interface com.ibm.workplace.wcm.api.SyndicationResult

Returns the total number of modifications that succeeded.

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.

getUserAccessMembers() - Method in interface com.ibm.workplace.wcm.api.Document

Returns a string array of members who have User access to this Document object.

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.

getValidationFailureMessage(Locale) - Method in exception com.ibm.workplace.wcm.api.extensions.validation.FileUploadValidationException

Retrieves the reason for validation failure, formatted ( if possible ) to the given Locale.

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.authoring.EditorBean

Returns the pixel width of this editor component.

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.WorkflowedDocument

Return ID of the workflow associated with this document.

getWorkflowStageId() - Method in interface com.ibm.workplace.wcm.api.WorkflowedDocument

Returns the ID of the current WorkflowStage that this Document document is in.

getWorkspace() - Method in interface com.ibm.workplace.wcm.api.ContextProcessorParams

Returns the WCM API Workspace for the current user

getWorkspace(String, String) - Method in interface com.ibm.workplace.wcm.api.Repository

Returns a Workspace object that represents a view of the repository for a user with the specified credentials.

getWorkspace(Principal) - Method in interface com.ibm.workplace.wcm.api.Repository

Returns a Workspace object representing a view of the repository for the specified Principal.

getWorkspace() - Method in interface com.ibm.workplace.wcm.api.Repository

Returns a Workspace object representing a view of the repository for the current User accessing the system.

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.

hasApproverAccess(UserProfile) - Method in interface com.ibm.workplace.wcm.api.WorkflowedDocument

Checks if the UserProfile has Approver access to this Document.

hasApproverAccess() - Method in interface com.ibm.workplace.wcm.api.WorkflowedDocument

Checks if the user of the Workspace associated with the current document has Approver access to this 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.

hasContributorAccess(DocumentId) - Method in interface com.ibm.workplace.wcm.api.Workspace

Checks if user associated with the workspace has Contributor Acccess to the given DocumentId

hasDeleteAccess(UserProfile) - Method in interface com.ibm.workplace.wcm.api.Document

Deprecated. This method is deprecated from version 6.0. Calls to This method will be deprecated. Calls to 'Delete' access methods have the same effect as 'Manager' access method calls. Use Workspace.hasManagerAccess(DocumentId documentId) instead

hasDeleteAccess() - Method in interface com.ibm.workplace.wcm.api.Document

Deprecated. This method is deprecated from version 6.0. Calls to This method will be deprecated. Calls to 'Delete' access methods have the same effect as 'Manager' access method calls. Use Workspace.hasManagerAccess(DocumentId documentId) instead

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.WorkflowedDocument

Returns true if this Document has a draft document.

hasEditAccess(UserProfile) - Method in interface com.ibm.workplace.wcm.api.Document

Deprecated. This method is deprecated from version 6.0. Calls to This method will be deprecated. Calls to 'Edit' access methods have the same effect as 'Editor' access method calls. Use Workspace.hasEditorAccess(DocumentId documentId) instead

hasEditAccess() - Method in interface com.ibm.workplace.wcm.api.Document

Deprecated. This method is deprecated from version 6.0. Calls to This method will be deprecated. Calls to 'Edit' access methods have the same effect as 'Editor' access method calls. Use Workspace.hasEditorAccess(DocumentId documentId) instead

hasEditorAccess(DocumentId) - Method in interface com.ibm.workplace.wcm.api.Workspace

Checks if user associated with the workspace has Editor Acccess to the given DocumentId

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(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 'Contributor' access method calls. Use Workspace.hasContributorAccess(DocumentId documentId) instead

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 'Contributor' access method calls. Use Workspace.hasContributorAccess(DocumentId documentId) instead

hasManagerAccess(DocumentId) - Method in interface com.ibm.workplace.wcm.api.Workspace

Checks if user associated with the workspace has Manager Acccess to the given DocumentId

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(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 'Contributor' access method calls. Use Workspace.hasContributorAccess(DocumentId documentId) instead

hasReadAccess() - 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 'Contributor' access method calls. Use Workspace.hasContributorAccess(DocumentId documentId) instead

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.

hasUserAccess(DocumentId) - Method in interface com.ibm.workplace.wcm.api.Workspace

Checks if user associated with the workspace has User Acccess to the given DocumentId

HistoryLogEntry - Interface in com.ibm.workplace.wcm.api

A read-only History Log Entry

HistoryLogIterator - Interface in com.ibm.workplace.wcm.api

HistoryLogIterator iterates over HistoryLogEntry objects.

HTMLComponent - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes

The document type for a HTMLComponent.

HTMLComponent - Interface in com.ibm.workplace.wcm.api

Represents a HTML component.

I

IllegalDocumentTypeException - Exception in com.ibm.workplace.wcm.api.exceptions

An IllegalDocumentTypeException is thrown if an object is not of the expected type.

IllegalDocumentTypeException() - Constructor for exception com.ibm.workplace.wcm.api.exceptions.IllegalDocumentTypeException

Constructor.

IllegalDocumentTypeException(String) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.IllegalDocumentTypeException

Constructs a new exception with the given message.

IllegalDocumentTypeException(String, Throwable) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.IllegalDocumentTypeException

Constructor that requires detail plus a cause exception

IllegalTypeChangeException - Exception in com.ibm.workplace.wcm.api.exceptions

This exception is thrown if the type of an object being set is not allowed.

IllegalTypeChangeException() - Constructor for exception com.ibm.workplace.wcm.api.exceptions.IllegalTypeChangeException

Constructor.

IllegalTypeChangeException(String) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.IllegalTypeChangeException

Constructs a new exception with the given message.

IllegalTypeChangeException(String, Throwable) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.IllegalTypeChangeException

Constructor that requires detail plus a cause exception

ImageComponent - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes

The document type for a ImageComponent.

ImageComponent - Interface in com.ibm.workplace.wcm.api

Represents an Image component.

importLibraryFromStream(Workspace, InputStream, Locale) - Method in class com.ibm.workplace.wcm.api.WebContentLibraryService

Import document library from the supplied input stream as a new library.

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.

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.

isConsiderFileContentsValid() - Method in exception com.ibm.workplace.wcm.api.extensions.validation.FileUploadValidationException

If true the file contents should be considered valid, even though an exception was thrown during validation.

isContributorAccessInherited() - Method in interface com.ibm.workplace.wcm.api.Document

Checks if the Contributor access permissions will be inherited from the parent of this Document.

isDeletionProhibited() - Method in interface com.ibm.workplace.wcm.api.DocumentLibrary

Indicates if this DocumentLibrary has deletion prohibited.

isDistinguishedNamesUsed() - Method in interface com.ibm.workplace.wcm.api.Workspace

Indicates whether this Workspace is set to use distinguished names for users Returns true if this Workspace is set to use distinguished names rather than their common names.

isDraft() - Method in interface com.ibm.workplace.wcm.api.authoring.CustomItemBean

isDraft whether or not the document is draft

isDraft() - Method in interface com.ibm.workplace.wcm.api.DocumentId

Returns true if the Document represented by this DocumentId is a draft document.

isDraft() - Method in interface com.ibm.workplace.wcm.api.WorkflowedDocument

Return true if this Document object is a draft.

isEditable() - Method in interface com.ibm.workplace.wcm.api.authoring.EditorBean

Returns the editable status of this component.

isEditorAccessInherited() - Method in interface com.ibm.workplace.wcm.api.Document

Checks if the Editor access permissions will be inherited from the parent of this Document.

isEnabled() - Method in interface com.ibm.workplace.wcm.api.DocumentLibrary

Indicates if this DocumentLibrary is enabled

isEnabled() - Method in interface com.ibm.workplace.wcm.api.Subscriber

Returns true if this Subscriber is enabled, false if not.

isEnabled() - Method in interface com.ibm.workplace.wcm.api.Syndicator

Returns true if this Syndicator is enabled, false if not.

isExpired() - Method in interface com.ibm.workplace.wcm.api.authoring.CustomItemBean

isExpired whether or not the document is expired

isExpired() - Method in interface com.ibm.workplace.wcm.api.DocumentId

Returns true if the Document represented by this DocumentId is a expired document.

isExpired() - Method in interface com.ibm.workplace.wcm.api.WorkflowedDocument

Return true if this Document has expired.

isFormattingControlsHidden() - Method in interface com.ibm.workplace.wcm.api.authoring.EditorBean

Indicates whether the formatting controls should be hidden from the user when the editor is rendered..

isGenerateContextualLinks() - Method in interface com.ibm.workplace.wcm.api.RenderingContext

Returns whether to generate contextual links if possible.

isHTMLModeHidden() - Method in interface com.ibm.workplace.wcm.api.authoring.EditorBean

Indicates whether the HTML mode should be hidden from the user when the editor is rendered.

isInherited(LibraryMemberRole) - Method in interface com.ibm.workplace.wcm.api.DocumentLibraryACL

isLimitedToLibraryImagePicker() - Method in interface com.ibm.workplace.wcm.api.authoring.EditorBean

Indicates whether the Image picker dialog will be limited to library images, and not allow users to upload their own images.

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.

isManagerAccessInherited() - Method in interface com.ibm.workplace.wcm.api.Document

Checks if the Manager access permissions will be inherited from the parent of this Document.

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.

isPropagated(LibraryMemberRole) - Method in interface com.ibm.workplace.wcm.api.DocumentLibraryACL

isPublished() - Method in interface com.ibm.workplace.wcm.api.authoring.CustomItemBean

isPublished whether or not the document is published

isPublished() - Method in interface com.ibm.workplace.wcm.api.DocumentId

Returns true if the Document represented by this DocumentId is a published document.

isPublished() - Method in interface com.ibm.workplace.wcm.api.WorkflowedDocument

Return true if this Document document is live published document.

isRunning() - Method in interface com.ibm.workplace.wcm.api.SyndicationStatus

Returns true if syndication is currently active.

isSingleSelect() - Method in interface com.ibm.workplace.wcm.api.OptionSelectionComponent

Returns true if this OptionSelectionComponent has been configured within the authoring template to be single select, false if not.

isSystemWorkspace() - Method in interface com.ibm.workplace.wcm.api.Workspace

Returns true if this Workspace will act with system credentials Indicates this Workspace will perform operations with system credentials.

isUserAccessInherited() - Method in interface com.ibm.workplace.wcm.api.Document

Checks if the User access permissions will be inherited from the parent of this Document.

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.

isWorkflowed() - Method in interface com.ibm.workplace.wcm.api.Document

Return true if this Document object is workflowed.

J

JSPComponent - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes

The document type for a JSPComponent.

JSPComponent - Interface in com.ibm.workplace.wcm.api

Represents a JSP component.

L

LibraryComponent - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes

The document type for Library Components.

LibraryComponent - Interface in com.ibm.workplace.wcm.api

The root interface in the Library Component hierarchy.

LibraryCreationException - Exception in com.ibm.workplace.wcm.api.exceptions

This exception is thrown if an error occurs while attempting to create a DocumentLibrary in the repository.

LibraryCreationException() - Constructor for exception com.ibm.workplace.wcm.api.exceptions.LibraryCreationException

Constructor.

LibraryCreationException(String) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.LibraryCreationException

Constructs a new exception with the given message.

LibraryCreationException(String, Throwable) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.LibraryCreationException

Constructor that requires detail plus a cause exception

LibraryDateComponent - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes

The document type for a LibraryDateComponent.

LibraryDateComponent - Interface in com.ibm.workplace.wcm.api

Represents a Date component.

LibraryDocumentManagerComponent - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes

The document type for a LibraryDocumentManagerComponent.

LibraryDocumentManagerComponent - Interface in com.ibm.workplace.wcm.api

Represents a DocumentManager component.

LibraryFileComponent - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes

The document type for a LibraryFileComponent.

LibraryFileComponent - Interface in com.ibm.workplace.wcm.api

Represents a File component that exists in the Component Library.

LibraryHTMLComponent - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes

The document type for a LibraryHTMLComponent.

LibraryHTMLComponent - Interface in com.ibm.workplace.wcm.api

Represents a HTML component that exists in the Component Library.

LibraryImageComponent - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes

The document type for a LibraryImageComponent.

LibraryImageComponent - Interface in com.ibm.workplace.wcm.api

Represents an Image component that exists in the Component Library.

LibraryJSPComponent - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes

The document type for a LibraryJSPComponent.

LibraryJSPComponent - Interface in com.ibm.workplace.wcm.api

Represents an JSP component that exists in the Component Library.

LibraryLinkComponent - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes

The document type for LibraryLinkComponent

LibraryLinkComponent - Interface in com.ibm.workplace.wcm.api

Represents a Link component that exists in the Component Library.

LIBRARYLOCK_RETRIEVAL_FAILURE - Static variable in interface com.ibm.workplace.wcm.api.ResultTypes

The document type for an operation that could not retrieve the lock on the library in which the operation is to be performed

LibraryMemberRole - Interface in com.ibm.workplace.wcm.api

LibraryMemberRoleConstants - Class in com.ibm.workplace.wcm.api

Constants for library member roles

LibraryMemberRoleConstants() - Constructor for class com.ibm.workplace.wcm.api.LibraryMemberRoleConstants

LibraryMemberRoles - Interface in com.ibm.workplace.wcm.api

This class contains static references to all library member roles

LibraryNumericComponent - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes

The document type for a LibraryNumericComponent.

LibraryNumericComponent - Interface in com.ibm.workplace.wcm.api

Represents a Number component.

LibraryResourceType - Interface in com.ibm.workplace.wcm.api

LibraryResourceTypes - Interface in com.ibm.workplace.wcm.api

LibraryRichTextComponent - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes

The document type for a LibraryRichTextComponent.

LibraryRichTextComponent - Interface in com.ibm.workplace.wcm.api

Represents a RichText component that exists in the Component Library.

LibraryShortTextComponent - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes

The document type for a LibraryShortTextComponent.

LibraryShortTextComponent - Interface in com.ibm.workplace.wcm.api

Represents an Short Text component that exists in the Component Library.

LibraryStyleSheetComponent - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes

The document type for a LibraryStyleSheetComponent.

LibraryStyleSheetComponent - Interface in com.ibm.workplace.wcm.api

Represents a Style Sheet component that exists in the Component Library.

LibraryTaskResult - Interface in com.ibm.workplace.wcm.api

Represents the result of performing an operation on an item in the repository

LibraryTextComponent - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes

The document type for a LibraryTextComponent.

LibraryTextComponent - Interface in com.ibm.workplace.wcm.api

Represents an Text component that exists in the Component Library.

LibraryUserSelectionComponent - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes

The document type for a LibraryUserSelectionComponent.

LibraryUserSelectionComponent - Interface in com.ibm.workplace.wcm.api

Represents a UserSelection component.

LinkComponent - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes

The document type for a LinkComponent.

LinkComponent - Interface in com.ibm.workplace.wcm.api

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

Manager - Static variable in interface com.ibm.workplace.wcm.api.LibraryMemberRoles

MANAGER_STRING - Static variable in class com.ibm.workplace.wcm.api.LibraryMemberRoleConstants

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.

NEXT_WORKFLOW_STAGE - Static variable in interface com.ibm.workplace.wcm.api.custom.Directives

Directs system to move the target Document to the next workflow stage.

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.WorkflowedDocument

Move this Document object into the next stage in its workflow.

nextWorkflowStage(boolean, boolean) - Method in interface com.ibm.workplace.wcm.api.WorkflowedDocument

Move this Document object into the next stage in its workflow.

NoMoreWorkflowStagesException - Exception in com.ibm.workplace.wcm.api.exceptions

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 exception com.ibm.workplace.wcm.api.exceptions.NoMoreWorkflowStagesException

Constructor.

NoMoreWorkflowStagesException(String) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.NoMoreWorkflowStagesException

Constructs a new exception with the given message.

NoMoreWorkflowStagesException(String, Throwable) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.NoMoreWorkflowStagesException

Constructor that requires detail plus a cause exception

NumericComponent - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes

The document type for a NumericComponent.

NumericComponent - Interface in com.ibm.workplace.wcm.api

Represents a Number component.

O

OPERATION_PARTIAL_SUCCESS - Static variable in interface com.ibm.workplace.wcm.api.ResultTypes

The document type for an operation that was partially successful - there were some errors during its execution

OPERATION_SUCCESS - Static variable in interface com.ibm.workplace.wcm.api.ResultTypes

The document type for a completely successful operation

OperationFailedException - Exception in com.ibm.workplace.wcm.api.exceptions

An OperationFailedException is thrown if an error occurred while trying to set a property on a Document.

OperationFailedException() - Constructor for exception com.ibm.workplace.wcm.api.exceptions.OperationFailedException

Constructor.

OperationFailedException(String) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.OperationFailedException

Constructs a new exception with the given message.

OperationFailedException(String, Throwable) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.OperationFailedException

Constructor that requires detail plus a cause exception

OptionSelectionComponent - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes

The document type for a OptionSelectionComponent.

OptionSelectionComponent - Interface in com.ibm.workplace.wcm.api

Represents a OptionSelection component.

outputDocumentListModifiedBetweenToStream(Workspace, String, Date, Date, DocumentListWriter, Locale) - Method in class com.ibm.workplace.wcm.api.WebContentLibraryService

Export a list of all items modified between the specified dates to the passed character stream.

outputDocumentListModifiedSinceToStream(Workspace, String, Date, DocumentListWriter, Locale) - Method in class com.ibm.workplace.wcm.api.WebContentLibraryService

Export a list of all items modified since the specified date to the passed character stream.

outputDocumentListToStream(Workspace, String, DocumentListWriter, Locale) - Method in class com.ibm.workplace.wcm.api.WebContentLibraryService

Export a list of all items in a document library to the passed character stream.

P

PresentationTemplate - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes

The document type for a PresentationTemplate

PresentationTemplate - Static variable in interface com.ibm.workplace.wcm.api.LibraryResourceTypes

PresentationTemplate - Interface in com.ibm.workplace.wcm.api

Represents a Presentation Template in the repository.

printStackTrace() - Method in exception com.ibm.workplace.wcm.api.exceptions.WCMException

Overridden to include cause

printStackTrace(PrintStream) - Method in exception com.ibm.workplace.wcm.api.exceptions.WCMException

Overridden to include cause

printStackTrace(PrintWriter) - Method in exception com.ibm.workplace.wcm.api.exceptions.WCMException

Overridden to include cause

printStackTrace() - Method in exception com.ibm.workplace.wcm.api.exceptions.WCMRuntimeException

Overridden to include cause

printStackTrace(PrintStream) - Method in exception com.ibm.workplace.wcm.api.exceptions.WCMRuntimeException

Overridden to include cause

printStackTrace(PrintWriter) - Method in exception com.ibm.workplace.wcm.api.exceptions.WCMRuntimeException

Overridden to include cause

Privileged_User - Static variable in interface com.ibm.workplace.wcm.api.LibraryMemberRoles

PRIVILEGED_USER_STRING - Static variable in class com.ibm.workplace.wcm.api.LibraryMemberRoleConstants

process(HttpSession, ContextProcessorParams) - Method in interface com.ibm.workplace.wcm.api.ContextProcessor

Processes the supplied ContextProcessorParams and updates parameters within as necessary

PropertyRetrievalException - Exception in com.ibm.workplace.wcm.api.exceptions

This exception is thrown if an error occurs while attempting to retrieve a property of a Document.

PropertyRetrievalException() - Constructor for exception com.ibm.workplace.wcm.api.exceptions.PropertyRetrievalException

Constructor.

PropertyRetrievalException(String) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.PropertyRetrievalException

Constructs a new exception with the given message.

PropertyRetrievalException(String, Throwable) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.PropertyRetrievalException

Constructor that requires detail plus a cause exception

purge(DocumentId) - Method in interface com.ibm.workplace.wcm.api.Workspace

Purges an item with the given DocumentId.

R

rebuild() - Method in interface com.ibm.workplace.wcm.api.Subscriber

Trigger a full rebuild of the Subscriber.

rebuild() - Method in interface com.ibm.workplace.wcm.api.Syndicator

Trigger a full rebuild of the Syndicator.

Reference - Interface in com.ibm.workplace.wcm.api

An interface defining a reference from one entity in the repository to another.

ReferenceComponent - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes

The document type for a ReferenceComponent.

ReferenceComponent - Interface in com.ibm.workplace.wcm.api

Represents a component that can contain a reference to one LibraryComponent.

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.

com.ibm.workplace.wcm.api.custom.CustomWorkflowActionFactory)">registerFactory(CustomWorkflowActionFactory) - Method in interface com.ibm.workplace.wcm.api.custom.CustomWorkflowService

Register a custom workflow action factory.

com.ibm.workplace.wcm.api.custom.CustomWorkflowActionFactory)">registerFactory(CustomWorkflowActionFactory) - Method in class com.ibm.workplace.wcm.api.WebContentCustomWorkflowService

Register a custom workflow action factory.

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.WorkflowedDocument

Removes names from the list of additional live viewers for this Document.

removeApprovers(String[]) - Method in interface com.ibm.workplace.wcm.api.WorkflowedDocument

Removes each approver specified in the string array argument from the approvers of this Document object.

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.

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.

removeContributorAccessMembers(String[]) - Method in interface com.ibm.workplace.wcm.api.Editable

Removes each name specified in the string array argument from the members who have Contributor access to this Editable object.

removeDeleteAccessMembers(String[]) - Method in interface com.ibm.workplace.wcm.api.Editable

Deprecated. Use Editable.removeManagerAccessMembers(String[]) instead

removeEditAccessMembers(String[]) - Method in interface com.ibm.workplace.wcm.api.Editable

Deprecated. Use Editable.removeEditorAccessMembers(String[]) instead

removeEditorAccessMembers(String[]) - Method in interface com.ibm.workplace.wcm.api.Editable

Removes each name specified in the string array argument from the members who have Editor access to this Editable object.

removeFile() - Method in interface com.ibm.workplace.wcm.api.FileComponent

Removes file contained within this component.

removeFile() - Method in interface com.ibm.workplace.wcm.api.LibraryFileComponent

Removes file contained within this component.

removeImage() - Method in interface com.ibm.workplace.wcm.api.ImageComponent

Removes the image file contained within this component.

removeImage() - Method in interface com.ibm.workplace.wcm.api.LibraryImageComponent

Removes the image file contained within this component.

removeLiveAccessMembers(String[]) - Method in interface com.ibm.workplace.wcm.api.Editable

Deprecated. Use Editable.removeUserAccessMembers(String[]) instead

removeManagerAccessMembers(String[]) - Method in interface com.ibm.workplace.wcm.api.Editable

Removes each name specified in the string array argument from the members who have Manager access to this Editable object.

removeMembers(LibraryMemberRole, String[]) - Method in interface com.ibm.workplace.wcm.api.DocumentLibraryACL

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.

removeReadAccessMembers(String[]) - Method in interface com.ibm.workplace.wcm.api.Editable

Deprecated. Use Editable.removeContributorAccessMembers(String[]) instead

removeSiteArea(DocumentId) - Method in interface com.ibm.workplace.wcm.api.SiteFrameworkContainer

Deprecated. use Workspace.delete(id) instead.

removeStyleSheet() - Method in interface com.ibm.workplace.wcm.api.LibraryStyleSheetComponent

Removes the style sheet file contained within this component.

removeTemplateMapping(DocumentId) - Method in interface com.ibm.workplace.wcm.api.SiteFrameworkContainer

Removes the mapping for the AuthoringTemplate with the given DocumentId

removeUserAccessMembers(String[]) - Method in interface com.ibm.workplace.wcm.api.Editable

Removes each name specified in the string array argument from the members who have User access to this Editable object.

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 in com.ibm.workplace.wcm.api

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 in com.ibm.workplace.wcm.api

The entry point into the WCM repository.

RESTART_WORKFLOW - Static variable in interface com.ibm.workplace.wcm.api.custom.Directives

Directs system to restart the workflow on the target Document.

restartWorkflow() - Method in interface com.ibm.workplace.wcm.api.WorkflowedDocument

Restart the workflow on this Document object.

ResultType - Interface in com.ibm.workplace.wcm.api

This interface is used to define the types of results that are available to the API.

ResultTypes - Interface in com.ibm.workplace.wcm.api

This interface holds constants that define each of the ResultTypes that are known to the API.

RichTextComponent - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes

The document type for a RichTextComponent.

RichTextComponent - Interface in com.ibm.workplace.wcm.api

Represents a Rich Text component.

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

ROLLBACK_DOCUMENT - Static variable in interface com.ibm.workplace.wcm.api.custom.Directives

Directs system to rollback all changes to the target Document.

S

save(Document) - Method in interface com.ibm.workplace.wcm.api.Workspace

Saves an editable document to the WCM repository.

saveLibrary(Workspace, DocumentLibrary) - Method in class com.ibm.workplace.wcm.api.WebContentLibraryService

Save the DocumentLibrary.

Security_Admin - Static variable in interface com.ibm.workplace.wcm.api.LibraryMemberRoles

SECURITY_ADMIN_STRING - Static variable in class com.ibm.workplace.wcm.api.LibraryMemberRoleConstants

SECURITY_CONTRIBUTOR_ACCESS - Static variable in interface com.ibm.workplace.wcm.api.Workspace

security CONTRIBUTOR access

SECURITY_DELETE_ACCESS - Static variable in interface com.ibm.workplace.wcm.api.Workspace

Deprecated. Use manager access

SECURITY_EDIT_ACCESS - Static variable in interface com.ibm.workplace.wcm.api.Workspace

Deprecated. Use editor access

SECURITY_EDITOR_ACCESS - Static variable in interface com.ibm.workplace.wcm.api.Workspace

security EDITOR access

SECURITY_MANAGER_ACCESS - Static variable in interface com.ibm.workplace.wcm.api.Workspace

security MANAGER access

SECURITY_READ_ACCESS - Static variable in interface com.ibm.workplace.wcm.api.Workspace

Deprecated. Use contributor access

SECURITY_USER_ACCESS - Static variable in interface com.ibm.workplace.wcm.api.Workspace

security USER access

ServiceNotAvailableException - Exception in com.ibm.workplace.wcm.api.exceptions

This exception is thrown if the WCM service is not available.

ServiceNotAvailableException() - Constructor for exception com.ibm.workplace.wcm.api.exceptions.ServiceNotAvailableException

Constructor.

ServiceNotAvailableException(String) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.ServiceNotAvailableException

Constructs a new exception with the given message.

ServiceNotAvailableException(String, Throwable) - Constructor for exception 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.

setAuthoringTemplateID(DocumentId) - Method in interface com.ibm.workplace.wcm.api.Content

Sets the authoring template associated with this content

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.

setConsiderFileContentsValid(boolean) - Method in exception com.ibm.workplace.wcm.api.extensions.validation.FileUploadValidationException

If set to true, WCM will consider the file content valid ( is passed validation) even though an exception is being thrown during validation.

setContributorAccessInheritance(boolean) - Method in interface com.ibm.workplace.wcm.api.Editable

Sets if the Contributor access permissions will be inherited from the parent of this Document.

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

Set the DocumentLibrary deletion prohibited status

setDescription(String) - Method in interface com.ibm.workplace.wcm.api.DocumentLibrary

Set the description of this DocumentLibrary

setDescription(String) - Method in interface com.ibm.workplace.wcm.api.Editable

Sets the description of this Editable 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.

setDocumentManagerReference(String, String) - Method in interface com.ibm.workplace.wcm.api.LinkComponent

Sets the Document Reference of this Component to a document within the DocumentManager.

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.

setEditorAccessInheritance(boolean) - Method in interface com.ibm.workplace.wcm.api.Editable

Sets if the Editor access permissions will be inherited from the parent of this Document.

setEffectiveDate(Date) - Method in interface com.ibm.workplace.wcm.api.WorkflowedDocument

Sets the effective date of this Document document.

setEnabled(boolean) - Method in interface com.ibm.workplace.wcm.api.DocumentLibrary

Set the DocumentLibrary enabled status (enable or disable)

setEnabled(boolean, Workspace) - Method in interface com.ibm.workplace.wcm.api.Subscriber

Set true to enable this Syndicator.

setEnabled(boolean, Workspace) - Method in interface com.ibm.workplace.wcm.api.Syndicator

Set true to enable this Syndicator.

setErrorMessage(String) - Method in interface com.ibm.workplace.wcm.api.JSPComponent

Sets the error message contained in this JSPComponent.

setErrorMessage(String) - Method in interface com.ibm.workplace.wcm.api.LibraryJSPComponent

Sets the error message contained in this JSPComponent.

setExpiryDate(Date) - Method in interface com.ibm.workplace.wcm.api.WorkflowedDocument

Sets the expiry date for this Document 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.

setFieldValue(Object) - Method in interface com.ibm.workplace.wcm.api.authoring.CustomItemBean

setFieldValue sets the value of the field

setFile(String, byte[]) - Method in interface com.ibm.workplace.wcm.api.FileComponent

Sets the file contained within this component.

setFile(String, File) - 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.

setFile(String, File) - 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.WorkflowedDocument

Set general date one for this Document document.

setGeneralDateTwo(Date) - Method in interface com.ibm.workplace.wcm.api.WorkflowedDocument

Set general date two for this Document document.

setGenerateContextualLinks(boolean) - Method in interface com.ibm.workplace.wcm.api.RenderingContext

Sets whether to generate contextual links if possible.

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, 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) - 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.LibraryHTMLComponent

Deprecated. This method is deprecated from version 6.0. Use LibraryHTMLComponent.setHTML(String) instead.

setHTML(String) - Method in interface com.ibm.workplace.wcm.api.PresentationTemplate

Sets the HTML contained in this PresentationTemplate from the specified html argument.

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, File) - 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.

setImage(String, File) - Method in interface com.ibm.workplace.wcm.api.LibraryImageComponent

Sets the image file contained within this component.

setInheritance(LibraryMemberRole, boolean) - Method in interface com.ibm.workplace.wcm.api.DocumentLibraryACL

setJspPath(String) - Method in interface com.ibm.workplace.wcm.api.JSPComponent

Sets the JSP path to be contained in this JSPComponent.

setJspPath(String) - Method in interface com.ibm.workplace.wcm.api.LibraryJSPComponent

Sets the JSP path to be contained in this JSPComponent.

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

Set the access control for this DocumentLibrary

setLibraryResourceAccess(LibraryResourceType, DocumentLibraryACL) - Method in interface com.ibm.workplace.wcm.api.DocumentLibrary

Set the access control for the supplied library resource type

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.

setManagerAccessInheritance(boolean) - Method in interface com.ibm.workplace.wcm.api.Editable

Sets if the Manager access permissions will be inherited from the parent of this Document.

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.

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.

setPropagation(LibraryMemberRole, boolean) - Method in interface com.ibm.workplace.wcm.api.DocumentLibraryACL

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.

setReason(String) - Method in exception com.ibm.workplace.wcm.api.extensions.validation.FileUploadValidationException

Sets the reason for the validation failure.

setRenderedContent(String) - Method in interface com.ibm.workplace.wcm.api.RenderingContext

Sets the full path of the Content to render.

setRenderedContent(Site) - Method in interface com.ibm.workplace.wcm.api.RenderingContext

Sets the Site to be rendered.

setRenderedContent(SiteArea) - Method in interface com.ibm.workplace.wcm.api.RenderingContext

Sets the SiteArea to be rendered.

setRenderedContent(Content, SiteArea) - Method in interface com.ibm.workplace.wcm.api.RenderingContext

Sets the Content object to be rendered.

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.LibraryRichTextComponent

Sets the rich text in the component from a String of HTML.

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(String[]) - Method in interface com.ibm.workplace.wcm.api.OptionSelectionComponent

Sets the String[] contained in this OptionSelectionComponent.

setSelections(Principal[]) - Method in interface com.ibm.workplace.wcm.api.UserSelectionComponent

Sets the Principal[] contained in this UserSelectionComponent.

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.

setSubmitFunctionName(String) - Method in interface com.ibm.workplace.wcm.api.authoring.CustomItemBean

setSubmitFunctionName set the name of the submit function.

setText(String) - Method in interface com.ibm.workplace.wcm.api.LibraryTextComponent

Sets the plain text contained in this TextComponent.

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

Set the title of this DocumentLibrary

setTitle(String) - Method in interface com.ibm.workplace.wcm.api.Editable

Sets the title of this Editable object to the specified String argument.

setType(int) - Method in interface com.ibm.workplace.wcm.api.LibraryStyleSheetComponent

Sets the type of the style sheet.

setUserAccessInheritance(boolean) - Method in interface com.ibm.workplace.wcm.api.Editable

Sets if the User access permissions will be inherited from the parent of this Document.

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.WorkflowedDocument

Sets the Workflow on this Document given the ID of the Workflow.

setWorkflowId(DocumentId, boolean) - Method in interface com.ibm.workplace.wcm.api.WorkflowedDocument

Sets the Workflow on this Document given the ID of the Workflow.

ShortTextComponent - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes

The document type for a ShortTextComponent.

ShortTextComponent - Interface in com.ibm.workplace.wcm.api

Represents a Short Text component.

Site - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes

The document type for Site

Site - Interface in com.ibm.workplace.wcm.api

Represents a Site object.

SiteArea - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes

The document type for SiteArea

SiteArea - Interface in com.ibm.workplace.wcm.api

Represents a SiteArea object.

SiteFramework - Static variable in interface com.ibm.workplace.wcm.api.LibraryResourceTypes

SiteFrameworkContainer - Interface in com.ibm.workplace.wcm.api

The ability to organize and build a Site Framework is enabled by implementing the SiteFrameworkContainer interface.

SORT_KEY_CREATION_DATE - Static variable in interface com.ibm.workplace.wcm.api.Workspace

contentSearch method sort key for creation date

SORT_KEY_DESCRIPTION - Static variable in interface com.ibm.workplace.wcm.api.Workspace

contentSearch method sort key for description

SORT_KEY_EXPIRY_DATE - Static variable in interface com.ibm.workplace.wcm.api.Workspace

contentSearch method sort key for expiry date

SORT_KEY_GENERAL_DATE_ONE - Static variable in interface com.ibm.workplace.wcm.api.Workspace

contentSearch method sort key for general date one

SORT_KEY_GENERAL_DATE_TWO - Static variable in interface com.ibm.workplace.wcm.api.Workspace

contentSearch method sort key for general date two

SORT_KEY_LASTMODIFIED_DATE - Static variable in interface com.ibm.workplace.wcm.api.Workspace

contentSearch method sort key for last modified date

SORT_KEY_NAME - Static variable in interface com.ibm.workplace.wcm.api.Workspace

contentSearch method sort key for name

SORT_KEY_NONE - Static variable in interface com.ibm.workplace.wcm.api.Workspace

contentSearch method sort key for no sorting

SORT_KEY_PUBLISH_DATE - Static variable in interface com.ibm.workplace.wcm.api.Workspace

contentSearch method sort key for publish date

SORT_KEY_TITLE - Static variable in interface com.ibm.workplace.wcm.api.Workspace

contentSearch method sort key for title

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.

STOP - Static variable in interface com.ibm.workplace.wcm.api.custom.Directives

Directs system to stop executing any further actions for the current workflow stage.

Subscriber - Interface in com.ibm.workplace.wcm.api

Represents a WCM Subscriber.

SyndicationDeploymentException - Exception in com.ibm.workplace.wcm.api.exceptions

SyndicationDeploymentException() - Constructor for exception com.ibm.workplace.wcm.api.exceptions.SyndicationDeploymentException

Constructor.

SyndicationDeploymentException(String) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.SyndicationDeploymentException

Constructs a new exception with the given message.

SyndicationDeploymentException(String, Throwable) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.SyndicationDeploymentException

Constructor that requires detail plus a cause exception

SyndicationNotEnabledException - Exception in com.ibm.workplace.wcm.api.exceptions

SyndicationNotEnabledException() - Constructor for exception com.ibm.workplace.wcm.api.exceptions.SyndicationNotEnabledException

Constructor.

SyndicationNotEnabledException(String) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.SyndicationNotEnabledException

Constructs a new exception with the given message.

SyndicationNotEnabledException(String, Throwable) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.SyndicationNotEnabledException

Constructor that requires detail plus a cause exception

SyndicationResult - Interface in com.ibm.workplace.wcm.api

The SyndicationResult class contains the results of a particular syndication event at the time it was generated.

SyndicationService - Class in com.ibm.workplace.wcm.api

SyndicationService enables access to control syndication between Syndicator and Subscriber.

SyndicationService() - Constructor for class com.ibm.workplace.wcm.api.SyndicationService

Constructor

SyndicationStatus - Interface in com.ibm.workplace.wcm.api

The SyndicationStatus class represents the state of a particular syndicator or subscriber when getStatus is called on it.

Syndicator - Interface in com.ibm.workplace.wcm.api

Represents a WCM Syndicator.

T

Taxonomy - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes

The document type for Taxonomy

Taxonomy - Static variable in interface com.ibm.workplace.wcm.api.LibraryResourceTypes

Taxonomy - Interface in com.ibm.workplace.wcm.api

Represents a Taxonomy in the repository.

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 - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes

The document type for a TextComponent.

TextComponent - Interface in com.ibm.workplace.wcm.api

Represents a Text component.

toString() - Method in interface com.ibm.workplace.wcm.api.DocumentId

Returns a String representation of this DocumentId.

toString() - Method in interface com.ibm.workplace.wcm.api.DocumentType

Returns a String representation of this object.

toString() - Method in interface com.ibm.workplace.wcm.api.LibraryMemberRole

toString() - Method in interface com.ibm.workplace.wcm.api.LibraryResourceType

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 LibraryDateComponent will be formatted to only show the date.

TYPE_DOCUMENTMANAGER - Static variable in interface com.ibm.workplace.wcm.api.LinkComponent

TYPE_DOCUMENTMANAGER references a document in the Document Manager.

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 LibraryDateComponent 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 LibraryDateComponent 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.

update() - Method in interface com.ibm.workplace.wcm.api.Subscriber

Trigger an update of the Subscriber.

update() - Method in interface com.ibm.workplace.wcm.api.Syndicator

Trigger an update of the Syndicator.

useDistinguishedNames(boolean) - Method in interface com.ibm.workplace.wcm.api.Workspace

Sets the Workspace to use distinguished names users.

useLiveAccess(boolean) - Method in interface com.ibm.workplace.wcm.api.Workspace

Deprecated. use useUserAccess(boolean userAccess)

User - Static variable in interface com.ibm.workplace.wcm.api.LibraryMemberRoles

USER_STRING - Static variable in class com.ibm.workplace.wcm.api.LibraryMemberRoleConstants

UserProfile - Interface in com.ibm.workplace.wcm.api

The UserProfile interface retrieves user related information.

UserSelectionComponent - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes

The document type for a UserSelectionComponent.

UserSelectionComponent - Interface in com.ibm.workplace.wcm.api

Represents a UserSelection component.

useUserAccess(boolean) - Method in interface com.ibm.workplace.wcm.api.Workspace

Sets the Access context to use for the following methods.

V

validate(InputStream, FileUploadValidationContext) - Method in interface com.ibm.workplace.wcm.api.extensions.validation.FileUploadValidationPlugin

The FileUploadValidation Plugin should validate inputStream to determine if the file or image should be stored in the WCM repository.

W

WCM_API - Class in com.ibm.workplace.wcm.api

Provides a handle to the WCM Repository object.

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 in com.ibm.workplace.wcm.api

Deprecated. Replaced by WebContentService

WCMApiService() - Constructor for class com.ibm.workplace.wcm.api.WCMApiService

Deprecated.

WCMException - Exception in com.ibm.workplace.wcm.api.exceptions

The base Lotus Web Content Management API Exception.

WCMException(String) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.WCMException

Constructor that requires detail

WCMException(String, Throwable) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.WCMException

Constructor that requires detail plus a cause exception

WCMIllegalStateException - Exception in com.ibm.workplace.wcm.api.exceptions

WCMIllegalStateException() - Constructor for exception com.ibm.workplace.wcm.api.exceptions.WCMIllegalStateException

Constructor.

WCMIllegalStateException(String) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.WCMIllegalStateException

Constructs a new exception with the given message.

WCMIllegalStateException(String, Throwable) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.WCMIllegalStateException

Constructor that requires detail plus a cause exception

WCMRuntimeException - Exception in com.ibm.workplace.wcm.api.exceptions

The base Lotus Web Content Management API Runtime Exception.

WCMRuntimeException(String) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.WCMRuntimeException

Constructor that requires detail

WCMRuntimeException(String, Throwable) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.WCMRuntimeException

Constructor that requires detail plus a cause exception

WCMServiceHome - Interface in com.ibm.workplace.wcm.api

Deprecated. Replaced by WebContentService

WebContentCustomWorkflowService - Class in com.ibm.workplace.wcm.api

WebContentCustomWorkflowService enables access to the Web Content Custom Workflow methods through Portal services.

WebContentCustomWorkflowService() - Constructor for class com.ibm.workplace.wcm.api.WebContentCustomWorkflowService

WebContentCustomWorkflowService implementation constructor

WebContentLibraryService - Class in com.ibm.workplace.wcm.api

WebContentLibraryService enables access to Web Content Library methods through Portal services.

WebContentLibraryService() - Constructor for class com.ibm.workplace.wcm.api.WebContentLibraryService

Constructor

WebContentService - Class in com.ibm.workplace.wcm.api

WebContentService enables access to the WCM API through Portal services.

WebContentService() - Constructor for class com.ibm.workplace.wcm.api.WebContentService

Workflow - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes

The document type for Workflow

Workflow - Static variable in interface com.ibm.workplace.wcm.api.LibraryResourceTypes

Workflow - Interface in com.ibm.workplace.wcm.api

Represents a workflow.

WorkflowedDocument - Interface in com.ibm.workplace.wcm.api

WorkflowedDocument Interface Represents a WCM API object that supports workflow methods WorkflowedDocument description

WorkflowNotFoundException - Exception in com.ibm.workplace.wcm.api.exceptions

A WorkflowNotFoundException is thrown if the Document being accessed is not workflowable.

WorkflowNotFoundException() - Constructor for exception com.ibm.workplace.wcm.api.exceptions.WorkflowNotFoundException

Constructor.

WorkflowNotFoundException(String) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.WorkflowNotFoundException

Constructs a new exception with the given message.

WorkflowNotFoundException(String, Throwable) - Constructor for exception com.ibm.workplace.wcm.api.exceptions.WorkflowNotFoundException

Constructor that requires detail plus a cause exception

WorkflowStage - Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes

The document type for WorkflowStage

WorkflowStage - Interface in com.ibm.workplace.wcm.api

Represents a workflow stage.

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 in com.ibm.workplace.wcm.api

Represents a view of the WCM repository for a particular user.

writeEndDocument() - Method in class com.ibm.workplace.wcm.api.CSVDocumentListWriter

writeEndDocument() - Method in interface com.ibm.workplace.wcm.api.DocumentListWriter

Write an element for the end of a new document entry in the document list

writeEndDocumentList() - Method in class com.ibm.workplace.wcm.api.CSVDocumentListWriter

writeEndDocumentList() - Method in interface com.ibm.workplace.wcm.api.DocumentListWriter

Write an element for the end of a document list.

writeEndProperty() - Method in class com.ibm.workplace.wcm.api.CSVDocumentListWriter

writeEndProperty() - Method in interface com.ibm.workplace.wcm.api.DocumentListWriter

Write an element for the end of a property entry for a document entry in the document list

writeEndType() - Method in class com.ibm.workplace.wcm.api.CSVDocumentListWriter

writeEndType() - Method in interface com.ibm.workplace.wcm.api.DocumentListWriter

Write an element for the end of a document type section within the document list

writeStartDocument() - Method in class com.ibm.workplace.wcm.api.CSVDocumentListWriter

writeStartDocument() - Method in interface com.ibm.workplace.wcm.api.DocumentListWriter

Write an element for the start of a new document entry in the document list

writeStartDocumentList(Locale) - Method in class com.ibm.workplace.wcm.api.CSVDocumentListWriter

writeStartDocumentList(Locale) - Method in interface com.ibm.workplace.wcm.api.DocumentListWriter

Writes an element for the start of the document list.

writeStartProperty() - Method in class com.ibm.workplace.wcm.api.CSVDocumentListWriter

writeStartProperty() - Method in interface com.ibm.workplace.wcm.api.DocumentListWriter

Write an element for the start of a property entry for a document entry in the document list

writeStartType(String) - Method in class com.ibm.workplace.wcm.api.CSVDocumentListWriter

writeStartType(String) - Method in interface com.ibm.workplace.wcm.api.DocumentListWriter

Write an element for the start of a new document type section within the document list

writeValue(String) - Method in class com.ibm.workplace.wcm.api.CSVDocumentListWriter

writeValue(String) - Method in interface com.ibm.workplace.wcm.api.DocumentListWriter

Write a value to the document list

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