|
||||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||
AbstractAuthoringTemplate
Since 8.0, there are two types of AbstractAuthoringTemplate,
AuthoringTemplate and SiteAreaTemplate.
DocumentType of the given document against this folder's one.
DocumentType of the given document id against this folder's one.
Document
where the action is not available on the current stage of the Document's workflow.ActionResult of an AuthoringAction can display messages to the user and control
the state of the form on the next load via its AuthoringDirectiveMoveOption to the list
Document document.
Document object.
Editable object.
ContentComponent with the name specified by the
argument to this ContentComponentContainer.
Workspace.createContent(authoringTemplateId, parentSiteId,
siblingId, position) instead
Editable
object.
Editable.addManagerAccessMembers(String[]) instead
Editable.addEditorAccessMembers(String[]) instead
Editable
object.
Editable
object.
Document into the given Project.
Editable.addUserAccessMembers(String[]) instead
Editable
object.
Access
to the associated Item.
Editable object.
Editable.addContributorAccessMembers(String[]) instead
Selector to this DocumentQuery.
Selector to this DocumentQuery.
Workspace.createSiteArea(parentId, siblingId, position)
instead.
Sort to this DocumentQuery.
AuthoringTemplate and
PresentationTemplate.
Editable
object.
Iterator to all available Versions of this Document
HistoryLogEntry created using the public API.
Associations are Selectors which associate other Selectors with an Operation
Example use of Associations Conjunction and DisjunctionAuthoringAction has
been executed.AuthoringTemplate.
Sort representing 'by author'.
Sort representing 'by created date'.
Sort representing 'by modified date'.
Sort representing 'by name'.
Sort representing 'by title'.
Document on a Project
- 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.
- canPublish() -
Method in interface com.ibm.workplace.wcm.api.Project
- Checks if the project is in a State that allows publishing.
- 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.
- categoriesContains(Identity) -
Static method in class com.ibm.workplace.wcm.api.query.ProfileSelectors
- Returns a selector representing category 'contain'.
- categoriesContains(Collection<? extends Identity>) -
Static method in class com.ibm.workplace.wcm.api.query.ProfileSelectors
- Returns a selector representing categories 'contain'.
- 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.
- clearApprovers() -
Method in interface com.ibm.workplace.wcm.api.Project
- A convenient method to remove all approvers from the object.
- clearApprovers() -
Method in interface com.ibm.workplace.wcm.api.ProjectPrototype
- A convenient method to remove all approvers from the object.
- clearApprovers() -
Method in interface com.ibm.workplace.wcm.api.WorkflowedDocument
- A convenient method to remove all approvers from the project.
- clearReferences(Reference[]) -
Method in interface com.ibm.workplace.wcm.api.Workspace
- Clears all the references represented by the array of
Reference instances.
- clearSorts() -
Method in interface com.ibm.workplace.wcm.api.query.Query
- Clean the sort setting for this query.
- clearWorkflowActionsForState(ProjectStateSelectors.State) -
Method in interface com.ibm.workplace.wcm.api.Project
- A convenient method to clear all
WorkflowActions currently associated with the given State.
- clearWorkflowActionsForState(ProjectStateSelectors.State) -
Method in interface com.ibm.workplace.wcm.api.ProjectPrototype
- A convenient method to clear all
WorkflowActions currently associated with the given State.
- CloseForm - Class in com.ibm.workplace.wcm.api.extensions.authoring.directive
- When returned in the
ActionResult this directive will close the current open form. - CloseForm() -
Constructor for class com.ibm.workplace.wcm.api.extensions.authoring.directive.CloseForm
- Constructor
- 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 IBM Web Content Manager API.
- com.ibm.workplace.wcm.api.extensions.authoring - package com.ibm.workplace.wcm.api.extensions.authoring
-
- com.ibm.workplace.wcm.api.extensions.authoring.directive - package com.ibm.workplace.wcm.api.extensions.authoring.directive
-
- com.ibm.workplace.wcm.api.extensions.digitalasset - package com.ibm.workplace.wcm.api.extensions.digitalasset
-
- com.ibm.workplace.wcm.api.extensions.resolution - package com.ibm.workplace.wcm.api.extensions.resolution
- This package defines the Lotus Web Content Management API interfaces for the ContentPageResolution Filter
- com.ibm.workplace.wcm.api.extensions.resolution.exceptions - package com.ibm.workplace.wcm.api.extensions.resolution.exceptions
- This package defines exceptions used by IBM Web Content Manager API interfaces for the ContentPageResolution filter.
- com.ibm.workplace.wcm.api.extensions.syndication - package com.ibm.workplace.wcm.api.extensions.syndication
-
- com.ibm.workplace.wcm.api.extensions.url - package com.ibm.workplace.wcm.api.extensions.url
- This package defines the Lotus Web Content Management API interfaces for the content URL generation.
- com.ibm.workplace.wcm.api.extensions.validation - package com.ibm.workplace.wcm.api.extensions.validation
-
- com.ibm.workplace.wcm.api.messaging - package com.ibm.workplace.wcm.api.messaging
-
- com.ibm.workplace.wcm.api.plugin - package com.ibm.workplace.wcm.api.plugin
-
- com.ibm.workplace.wcm.api.plugin.rendering - package com.ibm.workplace.wcm.api.plugin.rendering
-
- com.ibm.workplace.wcm.api.plugin.textprovider - package com.ibm.workplace.wcm.api.plugin.textprovider
-
- com.ibm.workplace.wcm.api.prerender - package com.ibm.workplace.wcm.api.prerender
-
- com.ibm.workplace.wcm.api.query - package com.ibm.workplace.wcm.api.query
-
- com.ibm.workplace.wcm.api.security - package com.ibm.workplace.wcm.api.security
-
- com.ibm.workplace.wcm.api.versioning - package com.ibm.workplace.wcm.api.versioning
-
- COMMENT_DRAFT_CANCELED -
Static variable in interface com.ibm.workplace.wcm.api.HistoryLogEntryCodes
- A free form comment
HistoryLogEntry entered when a draft Document was cancelLed.
- COMMENT_DRAFT_CREATED -
Static variable in interface com.ibm.workplace.wcm.api.HistoryLogEntryCodes
- A free form comment
HistoryLogEntry entered when a draft Document was created.
- COMMENT_PROJECT_APPROVAL_WITHDRAWN -
Static variable in interface com.ibm.workplace.wcm.api.HistoryLogEntryCodes
- A free form comment
HistoryLogEntry entered when an approval is withdrawn from a Project.
- COMMENT_PROJECT_SUBMITTED_FOR_REVIEW -
Static variable in interface com.ibm.workplace.wcm.api.HistoryLogEntryCodes
- A free form comment
HistoryLogEntry entered when a Project is submitted for Review.
- COMMENT_PROJECT_WITHDRAWN_FROM_REVIEW -
Static variable in interface com.ibm.workplace.wcm.api.HistoryLogEntryCodes
- A free form comment
HistoryLogEntry entered when a Project is withdrawn for Review.
- COMMENT_WORKFLOW_APPROVED -
Static variable in interface com.ibm.workplace.wcm.api.HistoryLogEntryCodes
- A free form comment
HistoryLogEntry entered when a Document was reviewed and approved.
- COMMENT_WORKFLOW_NEXT_STAGE -
Static variable in interface com.ibm.workplace.wcm.api.HistoryLogEntryCodes
- A free form comment
HistoryLogEntry entered when a Document was moved to the next Workflow stage.
- COMMENT_WORKFLOW_PREVIOUS_STAGE -
Static variable in interface com.ibm.workplace.wcm.api.HistoryLogEntryCodes
- A free form comment
HistoryLogEntry entered when a Document was moved to the previous Workflow stage.
- COMMENT_WORKFLOW_PROCESS_NOW -
Static variable in interface com.ibm.workplace.wcm.api.HistoryLogEntryCodes
- A free form comment
HistoryLogEntry entered when a Document manually executed a scheduled action.
- COMMENT_WORKFLOW_PUBLISHED -
Static variable in interface com.ibm.workplace.wcm.api.HistoryLogEntryCodes
- A free form comment
HistoryLogEntry entered when a Document was published.
- COMMENT_WORKFLOW_REJECTED -
Static variable in interface com.ibm.workplace.wcm.api.HistoryLogEntryCodes
- A free form comment
HistoryLogEntry entered when a Document was reviewed and rejected.
- COMMENT_WORKFLOW_RESTARTED -
Static variable in interface com.ibm.workplace.wcm.api.HistoryLogEntryCodes
- A free form comment
HistoryLogEntry entered when the Workflow was restarted on a Document.
- compareTo(Object) -
Method in interface com.ibm.workplace.wcm.api.Identity
- Compares this object with the specified object for order.
- 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
-
- 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
- CompoundSelector - Class in com.ibm.workplace.wcm.api.query
- This class simply implements the QueryElement interface for
conditions which can be decomposed into other conditions.
- CompoundSelector() -
Constructor for class com.ibm.workplace.wcm.api.query.CompoundSelector
-
- congruent(Sort) -
Method in class com.ibm.workplace.wcm.api.query.Sort
- returns true if this sort is congruent to the specified Sort.
- Conjunction - Class in com.ibm.workplace.wcm.api.query
Conjunction associates Selectors with Operation.AND.- Conjunction() -
Constructor for class com.ibm.workplace.wcm.api.query.Conjunction
- Constructor
- Conjunction(Collection<Selector>) -
Constructor for class com.ibm.workplace.wcm.api.query.Conjunction
- Constructor
- contains(String) -
Method in interface com.ibm.workplace.wcm.api.LibraryProperties
- Does the item have a property value for the given property name
- 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
- ContentPageResolutionException - Exception in com.ibm.workplace.wcm.api.extensions.resolution.exceptions
- A
ContentPageResolutionException if any errors occur while resolving the ContentPageResolution Filter. - ContentPageResolutionException() -
Constructor for exception com.ibm.workplace.wcm.api.extensions.resolution.exceptions.ContentPageResolutionException
- Constructs a new
- ContentPageResolutionException(Throwable) -
Constructor for exception com.ibm.workplace.wcm.api.extensions.resolution.exceptions.ContentPageResolutionException
- Constructs a new exception from an exception that caused this exception
- ContentPageResolutionException(Throwable, Localized) -
Constructor for exception com.ibm.workplace.wcm.api.extensions.resolution.exceptions.ContentPageResolutionException
- Constructs a new exception from an exception that caused this exception and a localized object
- ContentPageResolutionException(String) -
Constructor for exception com.ibm.workplace.wcm.api.extensions.resolution.exceptions.ContentPageResolutionException
- Constructs a new exception with the given message.
- ContentPageResolutionException(String, Throwable) -
Constructor for exception com.ibm.workplace.wcm.api.extensions.resolution.exceptions.ContentPageResolutionException
- Constructs a new exception with the given message and an exception that caused this exception
- ContentPageResolutionFilter - Interface in com.ibm.workplace.wcm.api.extensions.resolution
- This interface can be implemented to realize a custom element in the filter chain for ContentPageResolution in WCM.
- ContentPageResolutionFilterChain - Interface in com.ibm.workplace.wcm.api.extensions.resolution
- This interface represents the chain of filters and is used to call the next element in the content page resolution filter chain.
- ContentPageResolutionRequest - Interface in com.ibm.workplace.wcm.api.extensions.resolution
- Request object of the content page resolution filter chain that contains various parameters
used to resolve a content item addressed by a path to a web content page.
- ContentPageResolutionResponse - Interface in com.ibm.workplace.wcm.api.extensions.resolution
- The
ContentPageResolutionResponse is passed to the resolve method of the
ContentPageResolutionFilter. - ContentPrototype - Interface in com.ibm.workplace.wcm.api
- An interface defining an object which is a content prototype in the repository.
- 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[], int) -
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, int) -
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.
- contentSearch(DocumentId, DocumentId[], DocumentId[], String[], boolean, boolean, 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.
- contentSearch(DocumentId, DocumentId[], DocumentId[], String[], boolean, boolean, boolean, boolean, boolean, String, String, String, boolean, int) -
Method in interface com.ibm.workplace.wcm.api.Workspace
- Returns an iterator of IDs of objects that match the given search criteria.
- ContentTemplate - Interface in com.ibm.workplace.wcm.api
- Deprecated. Use AuthoringTemplate
- ContentTemplate -
Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
- Deprecated. Use AuthoringTemplate
- ContentUrlFilterInstantiationException - Exception in com.ibm.workplace.wcm.api.extensions.url
- Exception that occurred during instantiation of a content URL generation
filter
- ContentUrlFilterInstantiationException() -
Constructor for exception com.ibm.workplace.wcm.api.extensions.url.ContentUrlFilterInstantiationException
- Constructs a new exception with no message or details
- ContentUrlFilterInstantiationException(Throwable) -
Constructor for exception com.ibm.workplace.wcm.api.extensions.url.ContentUrlFilterInstantiationException
- Constructs a new exception from an exception that caused this exception
- ContentUrlFilterInstantiationException(Throwable, Localized) -
Constructor for exception com.ibm.workplace.wcm.api.extensions.url.ContentUrlFilterInstantiationException
- Constructs a new exception from an exception that caused this exception
and a localized object
- ContentUrlFilterInstantiationException(String) -
Constructor for exception com.ibm.workplace.wcm.api.extensions.url.ContentUrlFilterInstantiationException
- Constructs a new exception with the given message.
- ContentUrlFilterInstantiationException(String, Throwable) -
Constructor for exception com.ibm.workplace.wcm.api.extensions.url.ContentUrlFilterInstantiationException
- Constructs a new exception with the given message and an exception that
caused this exception
- ContentUrlGenerationException - Exception in com.ibm.workplace.wcm.api.extensions.url
- Exception that occurred during content URL generation
- ContentUrlGenerationException() -
Constructor for exception com.ibm.workplace.wcm.api.extensions.url.ContentUrlGenerationException
- Constructs a new exception with no message or details
- ContentUrlGenerationException(Throwable) -
Constructor for exception com.ibm.workplace.wcm.api.extensions.url.ContentUrlGenerationException
- Constructs a new exception from an exception that caused this exception
- ContentUrlGenerationException(Throwable, Localized) -
Constructor for exception com.ibm.workplace.wcm.api.extensions.url.ContentUrlGenerationException
- Constructs a new exception from an exception that caused this exception
and a localized object
- ContentUrlGenerationException(String) -
Constructor for exception com.ibm.workplace.wcm.api.extensions.url.ContentUrlGenerationException
- Constructs a new exception with the given message.
- ContentUrlGenerationException(String, Throwable) -
Constructor for exception com.ibm.workplace.wcm.api.extensions.url.ContentUrlGenerationException
- Constructs a new exception with the given message and an exception that
caused this exception
- ContentUrlGenerationFilter - Interface in com.ibm.workplace.wcm.api.extensions.url
- This interface can be implemented by a filter in the content URL generation
chain that is used to generate URLs to content items.
- ContentUrlGenerationFilterChain - Interface in com.ibm.workplace.wcm.api.extensions.url
- This interface represents a chain of intercepting filters and is used to call the next
element in the chain.
- ContentUrlGenerationFilterFactory - Interface in com.ibm.workplace.wcm.api.extensions.url
- This interface can be implemented by a filter factory to serve references to
a
ContentUrlGenerationFilter. - ContentUrlGenerationRequest - Interface in com.ibm.workplace.wcm.api.extensions.url
- Request object of the content URL generation filter chain that contains
various parameters that might be required to generate a URL for a given
content.
- ContentUrlGenerationResponse - Interface in com.ibm.workplace.wcm.api.extensions.url
- Response object of the content URL generation filter chain that allows to
write the URL.
- 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.
- Continue - Class in com.ibm.workplace.wcm.api.extensions.authoring.directive
- When returned in the
ActionResult this directive will reload the form. - Continue() -
Constructor for class com.ibm.workplace.wcm.api.extensions.authoring.directive.Continue
- Constructor
- Contributor -
Static variable in interface com.ibm.workplace.wcm.api.LibraryMemberRoles
-
- CONTRIBUTOR_STRING -
Static variable in class com.ibm.workplace.wcm.api.LibraryMemberRoleConstants
-
- copy(DocumentId<T>, DocumentId) -
Method in interface com.ibm.workplace.wcm.api.Workspace
- Copies a document and adds it under a new parent.
- copy(Placeable, PlacementLocation, CopyOptions) -
Method in interface com.ibm.workplace.wcm.api.Workspace
- Copies the supplied
Positionable document to the target location
according to the rules specified by the copyOptions parameter.
- copy(T, ParentLocation, CopyOptions) -
Method in interface com.ibm.workplace.wcm.api.Workspace
- Copies the supplied document to the new parent according to the rules specified
by the
copyOptions parameter.
- copyCategory(DocumentId, DocumentId) -
Method in interface com.ibm.workplace.wcm.api.Workspace
- Deprecated. use Workspace.copy(Document, ParentLocation, CopyOptions) instead.
- CopyIntoProjectOption - Class in com.ibm.workplace.wcm.api
- This
CopyIntoProjectOption is used copy the item into a given project. - CopyIntoProjectOption(String) -
Constructor for class com.ibm.workplace.wcm.api.CopyIntoProjectOption
- Constructor.
- 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.
- CopyOption - Interface in com.ibm.workplace.wcm.api
- An optional parameter when performing an API copy.
- CopyOptions - Class in com.ibm.workplace.wcm.api
- A container for specifying multiple
CopyOptions
when performing an API copy. - CopyOptions() -
Constructor for class com.ibm.workplace.wcm.api.CopyOptions
-
- 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
- Deprecated. use Workspace.copy(Placeable, PlacementLocation, CopyOptions) instead.
- copyToLibrary(DocumentLibrary, DocumentId<T>) -
Method in interface com.ibm.workplace.wcm.api.Workspace
- This method copies non-hierarchical or root items to another library.
- copyToLibrary(DocumentLibrary, DocumentId<T>, CopyOptions) -
Method in interface com.ibm.workplace.wcm.api.Workspace
- This method copies non-hierarchical or root items to another library.
- count(Query) -
Method in interface com.ibm.workplace.wcm.api.query.QueryService
- Count the query result without retrieving the actual data.
- CREATE_DRAFT -
Static variable in interface com.ibm.workplace.wcm.api.custom.Directives
- Directs system to create a draft of the target Document.
- createAssociation(Operator) -
Method in class com.ibm.workplace.wcm.api.query.Association
- Create a association
- createAuthoringTemplate() -
Method in interface com.ibm.workplace.wcm.api.Workspace
- Creates a new
AuthoringTemplate.
- createCategory(DocumentId) -
Method in interface com.ibm.workplace.wcm.api.Workspace
- Creates a new
Category under the given parent.
- createComponent(String, DocumentType<T>) -
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(contentTemplateId, 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 a
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.
- createContentLink(DocumentId, DocumentId, DocumentId, int, LinkOptions) -
Method in interface com.ibm.workplace.wcm.api.Workspace
- Creates a new
ContentLink object, linked to the given Content.
- createContentTemplate() -
Method in interface com.ibm.workplace.wcm.api.Workspace
- Deprecated. Use createAuthoringTemplate()
- createDateComponent() -
Method in interface com.ibm.workplace.wcm.api.Workspace
- Creates a new
LibraryDateComponent.
- createdBefore(Date) -
Static method in class com.ibm.workplace.wcm.api.query.HistorySelectors
- Returns a selector matching content created before the specified date
The comparison is exclusive, i.e.
- createDirectiveParams() -
Method in interface com.ibm.workplace.wcm.api.custom.Directive
- Returns a new instance of a
DirectiveParams object for the current Directive
- 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<T>[]) -
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
- Deprecated. LibraryDocumentManagerComponent is deprecated since 7.0
- 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.
- createdSince(Date) -
Static method in class com.ibm.workplace.wcm.api.query.HistorySelectors
- Returns a selector matching content created since the specified date
The comparison is inclusive, i.e.
- createFileComponent() -
Method in interface com.ibm.workplace.wcm.api.Workspace
- Creates a new
LibraryFileComponent.
- createFolder(Workspace, Folder) -
Method in class com.ibm.workplace.wcm.api.WebContentLibraryService
- Deprecated. Use Workspace.createFolder instead
- createFolder(Folder) -
Method in interface com.ibm.workplace.wcm.api.Workspace
- Create a folder object under the specified parent folder.
- createFolder(DocumentId) -
Method in interface com.ibm.workplace.wcm.api.Workspace
- Create a folder object under the specified parent folder.
- 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.
- createNavigatorComponent() -
Method in interface com.ibm.workplace.wcm.api.Workspace
- Creates a new
LibraryNavigatorComponent.
- createNumericComponent() -
Method in interface com.ibm.workplace.wcm.api.Workspace
- Creates a new
LibraryNumericComponent.
- createOptions(SaveOption...) -
Static method in class com.ibm.workplace.wcm.api.SaveOptions
- Constructs a new save options variable
- createPresentationTemplate() -
Method in interface com.ibm.workplace.wcm.api.Workspace
- Creates a new
PresentationTemplate.
- createProject(Workspace) -
Method in class com.ibm.workplace.wcm.api.ProjectService
- Create a new
Project object.
- createProject(Workspace, DocumentId) -
Method in class com.ibm.workplace.wcm.api.ProjectService
- Create a
Project using the specified ProjectTemplate.
- createProjectTemplate(Workspace) -
Method in class com.ibm.workplace.wcm.api.ProjectService
- Creates a new
ProjectTemplate.
- createQuery() -
Method in interface com.ibm.workplace.wcm.api.query.QueryService
- Create a empty query that will inherit the default options.
- createQuery(Class<? extends Item>) -
Method in interface com.ibm.workplace.wcm.api.query.QueryService
- Create a query for a given WCM API type, this query will inherit the default options.
- createQuery(Class<? extends Item>, Query, QueryDepth) -
Method in interface com.ibm.workplace.wcm.api.query.QueryService
- Create a query for a given type and parent, this query will inherit the default options.
- 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.
- createResult(Directive, String) -
Method in interface com.ibm.workplace.wcm.api.custom.CustomWorkflowService
- Create an instance of a CustomWorkflowActionResult
- createResult(Directive, String, DirectiveParams) -
Method in interface com.ibm.workplace.wcm.api.custom.CustomWorkflowService
- Create an instance of a CustomWorkflowActionResult
- createResult(Directive, String) -
Method in class com.ibm.workplace.wcm.api.WebContentCustomWorkflowService
- Create an instance of a CustomWorkflowActionResult
- createResult(Directive, String, DirectiveParams) -
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
- Deprecated. use
createSiteArea() instead.
- createSiteArea() -
Method in interface com.ibm.workplace.wcm.api.Workspace
- Creates a new top-level
SiteArea.
- createSiteArea(DocumentId) -
Method in interface com.ibm.workplace.wcm.api.Workspace
- Creates a new top-level
SiteArea with the given existing site area template.
- createSiteArea(DocumentId, DocumentId, int) -
Method in interface com.ibm.workplace.wcm.api.Workspace
- Creates a new
SiteArea under the given parent.
- createSiteArea(DocumentId, DocumentId, DocumentId, int) -
Method in interface com.ibm.workplace.wcm.api.Workspace
- Creates a new
SiteArea under the given parent with a given existing site area template.
- createSiteAreaTemplate() -
Method in interface com.ibm.workplace.wcm.api.Workspace
- Creates a new
SiteAreaTemplate.
- 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.
- createVersion(String...) -
Method in interface com.ibm.workplace.wcm.api.VersionCatalog
- Create a new
Version of the live Document stored in the repository.
- creator() -
Method in class com.ibm.workplace.wcm.api.ReplaceCreatorCopyOption
-
- creatorEquals(String) -
Static method in class com.ibm.workplace.wcm.api.query.Selectors
- Returns a selector which matches items with the specified creator
- creatorIn(String...) -
Static method in class com.ibm.workplace.wcm.api.query.Selectors
- Returns a selector which matches items with a creator from the specified collection
- creatorIn(Collection<String>) -
Static method in class com.ibm.workplace.wcm.api.query.Selectors
- Returns a selector which matches items with a creator from the specified collection
- 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
- Represents a custom element within the 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.
- CustomWorkflowAction - Interface in com.ibm.workplace.wcm.api
- Represents a custom workflow action.
- CustomWorkflowAction -
Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
- The document type for
CustomWorkflowAction
- 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.
Date that this Version was created.
- 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.Project
- Declines this project.
- decline(String) -
Method in interface com.ibm.workplace.wcm.api.Project
- Declines the current project with a valid comment.
- 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 -
Static variable in interface com.ibm.workplace.wcm.api.custom.Directives
- Directs system to perform a delete on the target Document.
- delete(DocumentId) -
Method in interface com.ibm.workplace.wcm.api.Workspace
- Deletes an editable document from the WCM repository.
- DeleteDirectiveParams - Interface in com.ibm.workplace.wcm.api.custom
- The
DeleteDirectiveParams object is used to specify arguments or options to a 'Delete' Directive. - deleteFolder(Workspace, Item) -
Method in class com.ibm.workplace.wcm.api.WebContentLibraryService
- Deprecated. Use Workspace.purge instead
- deleteLibrary(Workspace, DocumentLibrary) -
Method in class com.ibm.workplace.wcm.api.WebContentLibraryService
- Deletes the
DocumentLibrary.
- deleteProject(Workspace, Project) -
Method in class com.ibm.workplace.wcm.api.ProjectService
- Delete
Project object from WCM repository.
- DigitalAssetID - Interface in com.ibm.workplace.wcm.api.extensions.digitalasset
- DigitalAssetID provides a generic Interface representing the DigitalAsset Management ID for a given resource
The actual ID object is generated and owned by the DigitalAssetResourceManagerPlugin providing the DAM support. - DigitalAssetManagable - Interface in com.ibm.workplace.wcm.api
- DigitalAssetManagable marks a LibraryComponent or ContentComponent as being manageable via a
DigitalAsset Management system.
- DigitalAssetMetaData - Interface in com.ibm.workplace.wcm.api.extensions.digitalasset
-
- DigitialAssetChooserModel - Interface in com.ibm.workplace.wcm.api.extensions.digitalasset
- DigitialAssetChooserModel identifies the Selection model to use when picking a resource/asset.
- DigitialAssetChooserModel.ResourceSelectionModel - Enum in com.ibm.workplace.wcm.api.extensions.digitalasset
- ResourceSelectionModel identifies the Selection model to use when picking a resource/asset.
- Directive - Interface in com.ibm.workplace.wcm.api.custom
- A directive is returned within a CustomWorkflowActionResult.
- directive() -
Method in interface com.ibm.workplace.wcm.api.extensions.authoring.ActionResult
- The directive to perform now that the AuthoringAction has completed its processing.
- DirectiveParams - Interface in com.ibm.workplace.wcm.api.custom
- The directive parameter object is used to specify arguments or options to a Directive.
- Directives - Interface in com.ibm.workplace.wcm.api.custom
- Provides access to Directive objects.
- DirectiveType - Enum in com.ibm.workplace.wcm.api.extensions.syndication
- ResultDirectiveType description
- DisableDocumentTypeException - Exception in com.ibm.workplace.wcm.api.exceptions
-
- DisableDocumentTypeException() -
Constructor for exception com.ibm.workplace.wcm.api.exceptions.DisableDocumentTypeException
-
- DisableSiteAreaCreationCopyOption - Class in com.ibm.workplace.wcm.api
- This
CopyOption is used to disable the automatic creation
of a parent sitearea (if that option is enabled) on the authoring template
when performing copy operations. - DisableSiteAreaCreationCopyOption() -
Constructor for class com.ibm.workplace.wcm.api.DisableSiteAreaCreationCopyOption
-
- DisableSiteAreaCreationLinkOption - Class in com.ibm.workplace.wcm.api
- This
LinkOption is used to disable the automatic creation
of a parent SiteArea (if that option is enabled) on the authoring template
when performing link operations. - DisableSiteAreaCreationLinkOption() -
Constructor for class com.ibm.workplace.wcm.api.DisableSiteAreaCreationLinkOption
-
- Disjunction - Class in com.ibm.workplace.wcm.api.query
Disjunction associates Selectors with Operation.OR.- Disjunction() -
Constructor for class com.ibm.workplace.wcm.api.query.Disjunction
- Constructor
- Disjunction(Collection<Selector>) -
Constructor for class com.ibm.workplace.wcm.api.query.Disjunction
- Constructor
- Document - Interface in com.ibm.workplace.wcm.api
- An interface defining an object that exists as an entity in the repository.
- document() -
Method in interface com.ibm.workplace.wcm.api.extensions.authoring.FormContext
- The
Document that will be shown in the Authoring interface
- DOCUMENT_APPLY_AUTHORING_TEMPLATE -
Static variable in interface com.ibm.workplace.wcm.api.HistoryLogEntryCodes
- A
HistoryLogEntry recording a Authoring Template being applied to a Document.
- DOCUMENT_CREATED -
Static variable in interface com.ibm.workplace.wcm.api.HistoryLogEntryCodes
- A
HistoryLogEntry recording the creation of a new Document.
- DOCUMENT_CREATED_AS_COPY -
Static variable in interface com.ibm.workplace.wcm.api.HistoryLogEntryCodes
- A
HistoryLogEntry recording the creation of a new Document as a copy of another Document.
- DOCUMENT_DELETED -
Static variable in interface com.ibm.workplace.wcm.api.HistoryLogEntryCodes
- A
HistoryLogEntry recording a Document being deleted.
- DOCUMENT_IMPORTED -
Static variable in interface com.ibm.workplace.wcm.api.HistoryLogEntryCodes
- A
HistoryLogEntry recording a Document being imported.
- DOCUMENT_MOVED -
Static variable in interface com.ibm.workplace.wcm.api.HistoryLogEntryCodes
- A
HistoryLogEntry recording a Document being moved.
- DOCUMENT_REVERTED -
Static variable in interface com.ibm.workplace.wcm.api.HistoryLogEntryCodes
- A
HistoryLogEntry recording the a Document being reverted to an old version.
- DOCUMENT_UPDATED -
Static variable in interface com.ibm.workplace.wcm.api.HistoryLogEntryCodes
- A
HistoryLogEntry recording an update to a Document.
- DocumentCreationException - Exception in com.ibm.workplace.wcm.api.exceptions
-
- 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
-
- 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
- DocumentDeleteException(Localized) -
Constructor for exception com.ibm.workplace.wcm.api.exceptions.DocumentDeleteException
- Constructor that requires a localized message
- DocumentDeleteReferentialIntegrityException - Exception in com.ibm.workplace.wcm.api.exceptions
-
- 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
- DocumentDeleteReferentialIntegrityException(Localized) -
Constructor for exception com.ibm.workplace.wcm.api.exceptions.DocumentDeleteReferentialIntegrityException
- Constructor that requires a localized message
- DocumentId<T extends Document> - 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
-
- 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<T extends Document> - Interface in com.ibm.workplace.wcm.api
DocumentIdIterator iterates over DocumentId
objects.- DocumentIsLockedException - Exception in com.ibm.workplace.wcm.api.exceptions
-
- 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<T extends Document> - 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
- Deprecated. Document Manager is deprecated since 7.0
- DocumentManagerComponent -
Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
- Deprecated. Document Manager is deprecated since 7.0
- DocumentNotFoundException - Exception in com.ibm.workplace.wcm.api.exceptions
-
- 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
- DocumentNotFoundIdCreationException - Exception in com.ibm.workplace.wcm.api.exceptions
- This exception is thrown if the item targeted by the
DocumentId
could not be found, and as a result the DocumentId could
not be be created. - DocumentNotFoundIdCreationException() -
Constructor for exception com.ibm.workplace.wcm.api.exceptions.DocumentNotFoundIdCreationException
- Constructor.
- DocumentNotFoundIdCreationException(String) -
Constructor for exception com.ibm.workplace.wcm.api.exceptions.DocumentNotFoundIdCreationException
- Constructs a new exception with the given message.
- DocumentNotFoundIdCreationException(String, Throwable) -
Constructor for exception com.ibm.workplace.wcm.api.exceptions.DocumentNotFoundIdCreationException
- Constructor that requires detail plus a cause exception
- DocumentPurgeException - Exception in com.ibm.workplace.wcm.api.exceptions
-
- 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
-
- 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
-
- 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
-
- 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<T extends WCMApiObject> - Interface in com.ibm.workplace.wcm.api
- This interface is used to define the types of
WCMApiObjects 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. - DRAFT_CANCELED -
Static variable in interface com.ibm.workplace.wcm.api.HistoryLogEntryCodes
- A
HistoryLogEntry recording the cancellation of a draft Document.
- DRAFT_CREATED -
Static variable in interface com.ibm.workplace.wcm.api.HistoryLogEntryCodes
- A
HistoryLogEntry recording the creation of a draft Document.
- DuplicateChildException - Exception in com.ibm.workplace.wcm.api.exceptions
-
- 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
-
- 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
-
- 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
EditableLibraryComponent interface represents
components that can be stored in the repository that are both
Editable through this API and a Library Component.Item.ActionResult this directive will change the current open form
to edit mode if it was in read mode.EmailAction
Workspace and
unregisters the current thread from its session.
Localized error message that will be shown in the authoring interface.
- escapeXml() -
Method in interface com.ibm.workplace.wcm.api.extensions.url.ContentUrlGenerationRequest
- Should characters reserved in XML be escaped in the URL generated.
- execute(Document) -
Method in interface com.ibm.workplace.wcm.api.custom.CustomWorkflowAction
- Execute the action against the supplied document.
- execute(FormContext) -
Method in interface com.ibm.workplace.wcm.api.extensions.authoring.AuthoringAction
- This method of the AuthoringAction will be invoked after a user clicks on the button visible in
the object form.
- execute(Query) -
Method in interface com.ibm.workplace.wcm.api.query.QueryService
- Execute a
Query.
- execute(Query, int, int) -
Method in interface com.ibm.workplace.wcm.api.query.QueryService
- Execute a
Query with paging parameter.
- exists(DocumentId<? extends Document>) -
Method in interface com.ibm.workplace.wcm.api.Workspace
- Tests the existence of an document in the repository.
- exists(String) -
Method in interface com.ibm.workplace.wcm.api.Workspace
- Return true if object with given ID exists.
- ExpireAction -
Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
- The document type for
ExpireAction
- ExpireAction - Interface in com.ibm.workplace.wcm.api
- Represents an expire action.
- expireAfter(Date, boolean) -
Static method in class com.ibm.workplace.wcm.api.query.WorkflowSelectors
- Returns a selector representing 'after' a specified workflow expire date.
- expireBefore(Date, boolean) -
Static method in class com.ibm.workplace.wcm.api.query.WorkflowSelectors
- Returns a selector representing 'before' a specified workflow expire date.
- exportLibraryToStream(Workspace, DocumentLibrary, OutputStream) -
Method in class com.ibm.workplace.wcm.api.WebContentLibraryService
- Export a document library to the supplied output stream.
FileComponent.
FileUploadValidationException if any error occurs while validation file contents by a FileUploadValidation Plugin.DocumentIdIterator for the items on the supplied relative path in the supplied document libraries.
DocumentId for a given path and
workflow status.
Content with the given path.
Project(s) from WCM repository by their name.
Project from WCM repository with its project state.
Project(s) from WCM repository by their title.
Folder
DocumentType can be stored under a FolderFormContext interface provides access to the current Document shown
in the authoring interface and the state of the form.DocumentType for the specified API interface/class
name.
RenderingContext.
RenderingContext.
Set of the bindings that the caller accepts as
results of the resolution process.
ACTION_GROUP in this WorkflowStage.
com.ibm.workplace.wcm.api.custom.CustomWorkflowAction as defined within the
CustomWorkflowActionFactory that this CustomWorkflowAction will run
DocumentId objects of the WorkflowActions for the given
ACTION_GROUP in this WorkflowStage.
Document document.
Category.
Site
or SiteArea.
Site
or SiteArea.
Taxonomy.
Site
or SiteArea, excluding ContentLinks.
Site
or SiteArea, excluding ContentLinks.
SiteArea objects
that are in the path to be rendered by this RenderingContext.
Workspace object representing a view of the repository
for the Anonymous user.
Document with this
DocumentId.
ApprovalMode set on this object.
ApprovalMode set on this object.
Object, or
null if no attribute of the given name exists.
Iterator containing the names of the attributes
available to this request.
AuthoringTemplate that was used to
create this TemplatedDocument.
DocumentId objects for the
Authoring Templates associated with this container.
Document object as a
string array.
OptionSelectionComponent
OptionSelectionComponent
Reference instances that are references from items outside of the
specified branch to the root of the branch or any of the items within the branch.
Reference instances that are references from items outside of the
specified DocumentLibrary to the DocumentLibrary or any of the items within the branch.
Document objects for the given DocumentIds as a
DocumentIterator.
Document objects for the given DocumentIds as a
DocumentIterator.
List of candidate Portal pages that should be used to resolve a Portal page.
DocumentId[].
DocumentId objects of the immediate child
categories of this Category object.
DocumentId objects of the immediate children
of this container.
DocumentId objects of the immediate children
of this container.
DocumentId objects of the immediate
child categories of this Taxonomy.
CommentMode of this project.
CommentMode set on this project.
ContentComponent with a name specified by the
argument from this ContentComponentContainer.
ContentComponent with a name specified by the
argument from this ContentComponentContainer; ContentComponents
returned by this method must be treated as read-only.
ContentComponents in
this ContentComponentContainer.
ContentComponentContainer object that contains this
ContentComponent.
DocumentLibary for the object with
this ID.
Content object that will be rendered by this
RenderingContext.
Content linked to by this
ContentLink.
Document.getMembersForAccess(Access)
while (iter.hasNext()) count = count + 1;
Document object as a string.
Document object.
DocumentLibrary, which is being used
for all operations except rendering.
DocumentId value.
Date.
Date.
DateComponent.
LibraryDateComponent.
DocumentId of the default Content object.
Document.getManagerAccessMembers() instead
Document object.
DocumentLibrary object.
DocumentLibrary object.
Item object.
DocumentId objects of the immediate children
of this container.
DocumentId objects of the immediate children
of this container.
Hierarchical.getParentId()
DocumentLibrary objects
that were created during the operation (either successfully or unsuccessfully)
DocumentLibrary objects visible
to the user of this Workspace.
String.
String.
DocumentLibrary with the specified name or title, or
null if a DocumentLibrary with that name or title
does not exist or the caller does not have access
String.
String.
DocumentType of the document associated with this CustomItemBean
DocumentType of the ContentComponent.
DocumentType representing this type.
Workflow.DraftCreationBehavior for this Workflow.
Workspace.getDraftIdsByPublishedId(com.ibm.workplace.wcm.api.DocumentId)
DocumentId of the draft document associated
with the supplied published/expired and project DocumentId.
DocumentIdIterator of the draft documents associated
with the supplied published/expired DocumentId
Document.getEditorAccessMembers() instead
Document.getMembersForAccess(Access)
Document.
String.
String.
Document document.
CustomWorkflowActionFactory that this CustomWorkflowAction is using
CustomWorkflowActionFactory that this CustomWorkflowAction is using
PresetFolderType type
DocuementType
Document document.
Document document.
Prototype for this authoring template.
ContentPrototype for this authoring template.
HierarchicalPrototype for this authoring template.
SiteAreaPrototype for this authoring template.
String.
String.
String.
DocumentId of this Document object.
Document with this
DocumentId.
DocumentLibrary object.
Document.getMembersForInheritedAccess(Access)
Document.getMembersForInheritedAccess(Access)
Document.getMembersForInheritedAccess(Access)
Item.
Document.getMembersForInheritedAccess(Access)
String representation of the UUID of the item to be resolved.
null if the content item cannot be loaded from the repository, for example, in case it does not exist
any longer.
String.
String.
Date the last time a syndication had occurred.
Syndicator.
DocumentLibrary of the object being rendered.
DocumentLibrary
DocumentId objects of the linked children
of this container.
DocumentIds this content is linked to.
Document.getUserAccessMembers() instead
Locale of this DocumentLibrary object.
Locale of this project.
Locale being used to render the current page.
Document.getMembersForAccess(Access)
Item.
Document object.
Document object.
ContentComponent object.
Document with this
DocumentId.
DocumentLibrary object.
Item object.
WCMApiObject.
Number.
Number.
NumberComponent.
NumberComponent.
Workflow.
OptionType of this option selection element.
Project object but have yet to approve it.
Document object is
stored.
Document object as a
string array.
ObjectID of the currently resolved Portal page that is to be displayed
when rendering the content identified by ContentPageResolutionResponse.getContentPath().
Hierarchical.getParentId()
Hierarchical.getParentId()
SiteArea that contains this
ContentLink.
DocumentId of the parent of this object.
Set of parent Identity
DocumentIds of this content.
WorkflowedDocument.
ContentPageResolutionResponse.setPresentationTemplatePath(String).
PresentationTemplate to be used
when rendering.
Document is in a Project.
Project from WCM repository by its DocumentId
Prototype type.
ProjectPrototype of this template.
DocumentId of the Published Item.
The item is a draft of published item if WorkflowedDocument.isDraftOfPublishedDocument() returns true.
DocumentId of the published or expired document associated
with the supplied draft DocumentId
PublishOption set on this object.
QueryService which is associated with this workspace.
Document.getContributorAccessMembers() instead
DocumentId of the Document object
being referred to by another Document.
Reference instances that represent all references to the
specified DocumentId.
Reference instances that represent all references from the
specified DocumentId.
DocumentId of the Document object
being referring to another Document.
TemplatedDocument object that will be rendered by this
RenderingContext.
SiteArea.
WebContentService.getRepository()
RenderingContext.
ResolutionService
that handles the content page resolution.
String representation of the HTML.
String representation of the HTML.
Principal[].
String[].
Principal[].
List that contains all the Selector in this DocumentQuery.
Site is not required in Web sites created
using the current version of IBM Web Content Manager. The method is retained for
compatibility with Web sites migrated from pre 7.0 versions of IBM Web Content Manager.
Use getAllSiteAreas() to get all level site areas.
getAllSiteAreas()
to get all level site areas.
while (iter.hasNext()) size = size + 1;
List of the Sort in this query.
Workspace of this Document object.
DocumentId objects of the
WorkflowStages in this Workflow.
State of this project.
SyndicationStatus of this
Subscriber.
SyndicationStatus of this
Syndicator.
Subscriber with the specified name, or
null if a Subscriber with that name
does not exist or the caller does not have access
Subscriber objects visible
to the user of the Workspace.
SyndicationResult for the last time the
syndication occurred.
Syndicator of the current update.
Syndicator with the specified name, or
null if a Syndicator with that name
does not exist or the caller does not have access
Syndicator objects visible
to the user of the Workspace.
Workspace object representing a sytem view of the repository.
TargetableContentComponent that has been set on this authoring template.
DocumentId of the Document to be opened by this directive
DocumentId of the PresentationTemplate mapped
to the AuthoringTemplate with the given DocumentId.
String.
String.
Document object.
DocumentLibrary object.
DocumentLibrary object.
DocumentLibrary.
DocumentLibrary.
Document with this
DocumentId, e.g.
Document with this
DocumentId.
Document.getMembersForAccess(Access) instead
UserProfile for the user of this
Workspace.
Document
VersioningService which is associated with this workspace.
setWcmWebAppPath(String), or the path from
the request.
WorkflowActions associated with the given project State.
WorkflowActions associated with the given project State.
WorkflowStage that this
Document document is in.
WorkflowedDocument.
Workspace object that represents a view of the
repository for a user with the specified credentials.
Workspace object representing a view of the repository
for the specified Principal.
Workspace object representing a view of the repository
for the current User accessing the system.
Writer that can be used to write the URL.
UserProfile has the specified access to the associated document.
Workspace has the specified access to specified document.
UserProfile has the specified access to specified document.
UserProfile has Approver access to this project.
Workspace associated with the current project has
Approver access to this project.
UserProfile has Approver access to this Document.
Workspace associated with the current document has
Approver access to this Document.
ContentComponent with a name specified by the argument exists in
this ContentComponentContainer.
SiteArea object has a
direct child or link to Content with the given DocumentId.
Workspace.hasManagerAccess(DocumentId documentId) instead
Workspace.hasManagerAccess(DocumentId documentId) instead
SiteArea object has a
direct child Content with the given DocumentId.
Document has a
draft document.
DocumentId exists.
DocumentId exists
Workspace.hasEditorAccess(DocumentId documentId) instead
Workspace.hasEditorAccess(DocumentId documentId) instead
UserProfile has the indicated role
in this library
UserProfile has the indicated role
against the specified resource type of this library
SiteArea object has a
content link to the Content with the given DocumentId.
Workspace.hasContributorAccess(DocumentId documentId) instead
Workspace.hasContributorAccess(DocumentId documentId) instead
DocumentQuery.
Document is in a Project.
DocumentId exists
Workspace.hasContributorAccess(DocumentId documentId) instead
Workspace.hasContributorAccess(DocumentId documentId) instead
SiteArea with the
given DocumentId.
AuthoringTemplate with the given DocumentId.
true if this Document has stored Version documents in the repository.
SiteAreas
or Folders.TemplatedDocument.HistoryLogEntry recording that the HistoryLog has entries removed.
HistoryLogEntry.getCode()HistoryLogIterator iterates over HistoryLogEntry
objects.HistorySelectors is a helper class to create history related Selector.HTMLComponent.
ImageComponent.
Workspace.createContent(authoringTemplateId,
parentSiteId, siblingId, position) instead
Workspace.createSiteArea(parentId, siblingId, position)
instead.
true if and only if the following conditions are met:
The user is not authenticated yet.
The filter chain has not determined a Portal page to show, that is, ContentPageResolutionResponse.getPageID() returns null.
The filter chain might return a Portal page for an authenticated user, that is, there are matching Portal pages but the anonymous user
is not authorised to access them.
DocumentType is an Authoring Template type.
DocumentType is a Content Component type.
Contributor access permissions will be inherited from the
parent of this Document.
DocumentLibrary has deletion prohibited.
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.
Document
represented by this DocumentId is a draft document.
Document object is a draft.
Editor access permissions will be inherited from the
parent of this Document.
DocumentLibrary is enabled
true if this Subscriber is enabled,
false if not.
true if this Syndicator is enabled,
false if not.
Document
represented by this DocumentId is a expired document.
Document has expired.
DocumentId or not.
Access level will be inherited from the
parent of the associated Item.
DocumentType is a Library Component type.
DocumentId provided is locked or not
Manager access permissions will be inherited from the
parent of this Document.
Workspace is a member of the
group with the specified name.
Document opened in the authoring interface has never been saved.
Document is new and unsaved.
Document opened in the authoring interface has never been saved.
Document or not.
Document represented by this DocumentId is 'equivalent' to
the DocumentType passed in.
DocumentType is 'equivalent' to the DocumentType passed in.
Document represented by this DocumentId is of the exact same type
of the DocumentType passed in.
DocumentType is of the exact same type
of the DocumentType passed in.
Workflow.
Document
represented by this DocumentId is a published document.
Document document is live
published document.
Document
represented by this DocumentId is a purged document.
true if the plugin will be selectable through
the Web Content Manager Authoring UI or false if the plugin is to be
hidden from users.
true if this OptionSelectionComponent has
been configured within the authoring template to be single select, false
if not.
true if this Workspace will act with
system credentials
Indicates this Workspace will perform operations with
system credentials.
User access permissions will be inherited from the
parent of this Document.
Document object is workflowed.
JSPComponent.
LibraryAuthoringToolsComponent.
LibraryDateComponent.
LibraryFileComponent.
LibraryHTMLComponent.
LibraryImageComponent.
LibraryJSPComponent.
LibraryLinkComponent
LibraryMenuComponent.
LibraryNavigatorComponent.
LibraryNumericComponent.
LibraryPageNavigationComponent.
LibraryPersonalizationComponent.
LibraryReferenceComponent.
LibraryRichTextComponent.
LibrarySearchComponent.
LibraryShortTextComponent.
LibraryStyleSheetComponent.
LibraryTaxonomyComponent.
LibraryTextComponent.
LibraryUserNameComponent.
LibraryUserSelectionComponent.
LinkComponent.
LinkOptions
when performing API link creation.DocumentId.
Document into deleted state.
String distinguished name of the last modifier that created this Version.
- MOVE -
Static variable in interface com.ibm.workplace.wcm.api.SaveOption
-
- move(DocumentId<? extends Document>, DocumentId<? extends Document>) -
Method in interface com.ibm.workplace.wcm.api.Workspace
- Moves a document and adds it under a new parent.
- move(Placeable, PlacementLocation, MoveOptions) -
Method in interface com.ibm.workplace.wcm.api.Workspace
- Moves the supplied
Placeable document to the target location
according to the rules specified by the moveOptions parameter.
- move(Document, ParentLocation, MoveOptions) -
Method in interface com.ibm.workplace.wcm.api.Workspace
- Moves the supplied document to the new parent according to the rules specified
by the
moveOptions parameter.
- moveCategory(DocumentId, DocumentId) -
Method in interface com.ibm.workplace.wcm.api.Workspace
- Deprecated. Use Workspace.move instead
- moveItemToFolder(Workspace, Folder, Item) -
Method in class com.ibm.workplace.wcm.api.WebContentLibraryService
- Deprecated. Use Workspace.move instead
- MoveOption - Interface in com.ibm.workplace.wcm.api
- An optional parameter when performing an API move.
- MoveOptions - Class in com.ibm.workplace.wcm.api
- A container for specifying multiple
MoveOptions
when performing an API move. - MoveOptions() -
Constructor for class com.ibm.workplace.wcm.api.MoveOptions
- Default constructor
- moveSiteFrameworkDocument(DocumentId, DocumentId, DocumentId, int) -
Method in interface com.ibm.workplace.wcm.api.Workspace
- Deprecated. use Workspace.move(Placeable, PlacementLocation, MoveOptions) instead.
- moveToLibrary(DocumentLibrary, DocumentId<? extends Document>) -
Method in interface com.ibm.workplace.wcm.api.Workspace
- This method moves non-hierarchical or root items to another library.
- MultipleDraftsExistException - Exception in com.ibm.workplace.wcm.api.exceptions
- Gets thrown when a draft in a project is marked for deletion while there exists other drafts
for the same published version.
- MultipleDraftsExistException(String) -
Constructor for exception com.ibm.workplace.wcm.api.exceptions.MultipleDraftsExistException
- Constructor
- MultipleDraftsExistException(String, String) -
Constructor for exception com.ibm.workplace.wcm.api.exceptions.MultipleDraftsExistException
- Constructs a new exception with the given message.
- MultipleDraftsExistException(String, Throwable, String) -
Constructor for exception com.ibm.workplace.wcm.api.exceptions.MultipleDraftsExistException
- Constructor that requires detail plus a cause exception
- MultipleDraftsExistException(Localized, String) -
Constructor for exception com.ibm.workplace.wcm.api.exceptions.MultipleDraftsExistException
- Constructor that requires a localized message
Iterator over the results in the next page
DocumentIterator.next() instead. Since this class has been generified, the two
methods are identical.
DocumentIdIterator.next(). Since this class has been generified, the two
methods are identical.
HistoryLogIterator.next() instead
NextStageDirectiveParams object is used to specify arguments or options to a 'NextStage' Directive.WorkflowedDocument.nextWorkflowStage(boolean, boolean, String)}
WorkflowedDocument.nextWorkflowStage(boolean, boolean, String)}
Document onject into the next stage in its workflow.
NoSaveOption represents the default save option that is used when no
options are specified.NumericComponent.
OptionSelectionComponent.
Iterator, provides additional paging methods
using the default iterator methods.Document.
Document that can be placed relative to other Documents.Placeable document.
PortalPage
Portal Page Object.PresentationTemplate
PreviousStageDirectiveParams object is used to specify arguments or options to a 'PreviousStage' Directive.Document
to its previous workflow stage when moving to the previous
workflow stage has been disabled within the workflow.WorkflowedDocument.previousWorkflowStage(boolean, String)
ProfileSelectors is a helper class to create profile related Selector.Project
Project objectHistoryLogEntry recording an approval being removed from a Project.
HistoryLogEntry recording a Project being approved.
HistoryLogEntry recording a Document being added to a Project.
HistoryLogEntry recording a Document being removed from a Project.
HistoryLogEntry recording a Project entering ACTIVE state.
HistoryLogEntry recording a Project entering PENDING state.
HistoryLogEntry recording a Project entering PUBLISHED_FAILED state.
HistoryLogEntry recording a Project entering PUBLISHED state.
HistoryLogEntry recording a Project entering PUBLISHING state.
HistoryLogEntry recording a Project entering REJECTED state.
HistoryLogEntry recording a Project entering REVIEW state.
HistoryLogEntry recording a Project entering SYNDICATING state.
HistoryLogEntry recording a Project changing state.
HistoryLogEntry recording a Project being rejected.
HistoryLogEntry recording a Project being submitted for Review.
HistoryLogEntry recording a Project being withdrawn from Review.
ProjectTemplateProjectStateSelector is a helper class to create project state related Selector.ProjectTemplate
Projects can be created.PublishAction
DocumentId.
QueryService.Query is scoped to parents, QueryDepth tells the
Query to return all descendants or children of the parent(s).QueryElement interface of the query, do not use directly.QueryService provides the ability to retrieve WCM Document
by DocumentQuery.QueryStructureException is thrown if the query is not legal or inappropriate.ActionResult this directive will change the form
to read mode.Subscriber.
Syndicator.
CopyOption is used to copy descendants recursively.ReferenceComponent.
LibraryComponent.Version Documents for this item.
Document.
Document object.
Editable object.
ContentComponent with the name specified by the
argument in this ContentComponentContainer.
Workspace.delete(DocumentId) instead.
Editable
object.
Editable.removeManagerAccessMembers(String[]) instead
Editable.removeEditorAccessMembers(String[]) instead
Editable
object.
Document from Project
Editable.removeUserAccessMembers(String[]) instead
Editable
object.
Access
to the associated Item.
Editable object.
RenderingContext.
Editable.removeContributorAccessMembers(String[]) instead
Workspace.delete(id) instead.
AuthoringTemplate with the given
DocumentId
Editable
object.
CopyOption is used to rename the
item being copied.RenderingContext that
is passed in.
LibraryComponent using the
specified RenderingContext.
RenderingPluginException is any error occurs while executing or looking up
a RenderingPlugin.Document
CopyOption is used to replace the
original creator of the source item being copied.Reference instances
with the new object represented by the specified DocumentId.
RescheduleDirectiveParams object is used to specify arguments or options to a 'Reschedule' Directive.Document object.
RestoreFailedException is thrown if the restore
Opreation fails to restore an item from a versionRestoreOption to be used in conjuction
with VersioningService.restore(Version, RestoreOption...)ResultTypes that are known to the API.QueryService to return DocumentId instead of Document
QueryService to return Document instead of DocumentId
RichTextComponent.
RollbackDirectiveParams object is used to specify arguments or options to a 'Rollback' Directive.SaveAndMoveOption saves and moves a document to the specified parent in
Workspace.save(Document object, DocumentId parent, int saveOptions) }.DocumentLibrary.
Project in the WCM repository.
ScheduledMoveAction
Access.APPROVER instead
Access.CONTRIBUTOR instead
Access.EDITOR instead
Access.MANAGER instead
Access.USER instead
Selectors is a factory class to create Selectors.ApprovalMode on this object.
ApprovalMode on this object.
TemplatedDocument.
OptionSelectionComponent.
CommentMode for this project.
CommentMode for this project.
ContentComponent with the name specified by the
argument in this ContentComponentContainer.
Contributor access permissions will be inherited from the
parent of this Document.
DocumentLibrary for this
Workspace.
DateComponent.
DateComponent.
DateComponent.
LibraryDateComponent.
Content for this Site or SiteArea if
the DocumentId argument is not null.
DocumentLibrary deletion prohibited status
DocumentLibrary
EditableItem object to the
specified String argument.
DocumentType of this folder.
Editor access permissions will be inherited from the
parent of this Document.
Document document.
DocumentLibrary enabled status (enable or disable)
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.
- setFactory(Sorts.SortFactory) -
Static method in class com.ibm.workplace.wcm.api.query.Sorts
- Sets the concrete factory
- setFieldValue(Object) -
Method in interface com.ibm.workplace.wcm.api.authoring.CustomItemBean
- Sets the value of the element associated with the CustomItemBean
- 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
-
- setInheritance(Access, boolean) -
Method in interface com.ibm.workplace.wcm.api.EditableSecurity
- Controls inheritance of access controls from the parent of the associated
Item.
- 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.ContentComponentContainer
- Sets the keywords for this
Content document.
- setLabels(String...) -
Method in interface com.ibm.workplace.wcm.api.Version
- Set the labels for this Version.
- 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.
- setLocale(Locale) -
Method in interface com.ibm.workplace.wcm.api.Project
- Sets the
Locale of this project object.
- setLockToVersion(boolean) -
Method in interface com.ibm.workplace.wcm.api.DocumentManagerComponent
- Deprecated. 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
- Deprecated. Sets the current lock state for the document,
if
locked is true then the document will be locked to the
current document version.
- setManagedExternally(boolean) -
Method in interface com.ibm.workplace.wcm.api.extensions.digitalasset.IDigitalAsset
- Set the current state of a DigitalAsset.
- 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.EditableItem
- Sets the name of this
EditableItem 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.
- setOptionType(OptionType) -
Method in interface com.ibm.workplace.wcm.api.OptionSelectionComponent
- Set the
OptionType for this OptionSelectionComponent
- setPageID(ObjectID) -
Method in interface com.ibm.workplace.wcm.api.extensions.resolution.ContentPageResolutionResponse
- Sets the
ObjectID of the Portal page that should be invoked to render the given content after the resolution process.
- setParentIds(Collection<Identity>, QueryDepth) -
Method in interface com.ibm.workplace.wcm.api.query.Query
- Instructs this query to find children of the parent documents.
- setParentQuery(Query, QueryDepth) -
Method in interface com.ibm.workplace.wcm.api.query.Query
- Instructs this query to find children of the parent documents.
- setPermanentDelete(boolean) -
Method in interface com.ibm.workplace.wcm.api.custom.DeleteDirectiveParams
- Specifies whether the Delete Directive should perform a permanent delete.
- setPermanentDelete(boolean) -
Method in class com.ibm.workplace.wcm.api.custom.WCM_DeleteDirectiveParams
- Specifies whether the Delete Directive should perform a permanent delete.
- 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.
- setPresentationTemplatePath(String) -
Method in interface com.ibm.workplace.wcm.api.extensions.resolution.ContentPageResolutionResponse
- Sets the path of the presentation template to be used when rendering the addressed content after the resolution process.
- setProject(String) -
Method in interface com.ibm.workplace.wcm.api.RenderingContext
- Set a
Project by name in this RenderingContext.
- setProject(Project) -
Method in interface com.ibm.workplace.wcm.api.RenderingContext
- Set a
Project within this RenderingContext.
- setPropagation(LibraryMemberRole, boolean) -
Method in interface com.ibm.workplace.wcm.api.DocumentLibraryACL
-
- setProperty(String, Object) -
Method in interface com.ibm.workplace.wcm.api.extensions.digitalasset.DigitalAssetMetaData
-
- setPublishDate(long) -
Method in interface com.ibm.workplace.wcm.api.Project
- Sets the date used by the 'Date' publish option
- setPublishOption(Project.PublishOptions) -
Method in interface com.ibm.workplace.wcm.api.Project
- Sets the publish option on this project
- setPublishOption(Project.PublishOptions) -
Method in interface com.ibm.workplace.wcm.api.ProjectPrototype
- Set the given
PublishOptions on this object.
- 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
- Deprecated. Use setRenderedContent(SiteArea)
- 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.
- setRenderingBehaviour(SiteFrameworkContainer.RenderingBehaviour) -
Method in interface com.ibm.workplace.wcm.api.SiteFrameworkContainer
- Sets the rendering behaviour of the current
SiteArea.
- 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.
- setRescheduleDate(Date) -
Method in interface com.ibm.workplace.wcm.api.custom.RescheduleDirectiveParams
- Specifies the date that the Reschedule Directive should reschedule the current workflow action
- setRescheduleDate(Date) -
Method in class com.ibm.workplace.wcm.api.custom.WCM_RescheduleDirectiveParams
- Specifies the date that the Reschedule Directive should reschedule the current workflow action
- setResourceManagementOption(IDigitalAsset.ResourceManagementOption) -
Method in interface com.ibm.workplace.wcm.api.extensions.digitalasset.IDigitalAsset
- Sets the managementOption for a given DigitalAsset
- setRichText(String) -
Method in interface com.ibm.workplace.wcm.api.LibraryRichTextComponent
- Sets value for this rich text component replacing any existing markup.
- setRichText(String) -
Method in interface com.ibm.workplace.wcm.api.RichTextComponent
- Sets value for this rich text component replacing any existing markup.
- 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.
- setRunEntryActions(boolean) -
Method in interface com.ibm.workplace.wcm.api.custom.NextStageDirectiveParams
- Specifies whether to run the entry actions on the destination stage.
- setRunEntryActions(boolean) -
Method in interface com.ibm.workplace.wcm.api.custom.PreviousStageDirectiveParams
- Specifies whether to run the entry actions on the destination stage.
- setRunEntryActions(boolean) -
Method in class com.ibm.workplace.wcm.api.custom.WCM_NextStageDirectiveParams
- Specifies whether to run the entry actions on the destination stage.
- setRunEntryActions(boolean) -
Method in class com.ibm.workplace.wcm.api.custom.WCM_PreviousStageDirectiveParams
- Specifies whether to run the entry actions on the destination stage.
- setRunExitActions(boolean) -
Method in interface com.ibm.workplace.wcm.api.custom.NextStageDirectiveParams
- Specifies whether to run the exit actions on the current stage before moving to the next stage.
- setRunExitActions(boolean) -
Method in class com.ibm.workplace.wcm.api.custom.WCM_NextStageDirectiveParams
- Specifies whether to run the exit actions on the current stage before moving to the next stage.
- 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.
- setStartPage(int) -
Method in interface com.ibm.workplace.wcm.api.PageOptions
- Sets the stage page
- 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
- Specifies the name of the Javascript Submit function
used to set the value of the element associated with the CustomItemBean
- setTargetComponent(TargetableContentComponent) -
Method in interface com.ibm.workplace.wcm.api.AbstractAuthoringTemplate
- Sets the
TargetableContentComponent as the target component for this AuthoringTemplate.
- 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.EditableItem
- Sets the title of this
EditableItem object to the
specified String argument.
- setTitleTextProviderKey(String) -
Method in interface com.ibm.workplace.wcm.api.DocumentLibrary
- Set the text provider key for the title of this
DocumentLibrary.
- setTitleTextProviderKey(String) -
Method in interface com.ibm.workplace.wcm.api.Editable
- Set the text provider key for the title of this item.
- setTitleTextProviderName(String) -
Method in interface com.ibm.workplace.wcm.api.DocumentLibrary
- Set the text provider name for the title of this
DocumentLibrary.
- setTitleTextProviderName(String) -
Method in interface com.ibm.workplace.wcm.api.Editable
- Set the text provider name for the title of this item.
- 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.
- setWorkflowActionsForState(ProjectStateSelectors.State, DocumentId...) -
Method in interface com.ibm.workplace.wcm.api.Project
- Set the given
WorkflowActions for the specified State of this Project.
- setWorkflowActionsForState(ProjectStateSelectors.State, DocumentId...) -
Method in interface com.ibm.workplace.wcm.api.ProjectPrototype
- Set the given
WorkflowActions for the specified State on this object.
- 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
- Deprecated. Since 7.0, Site is replaced by SiteArea.
- Site - Interface in com.ibm.workplace.wcm.api
- Deprecated. Use SiteArea instead
- 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. - SiteAreaPrototype - Interface in com.ibm.workplace.wcm.api
- An interface defining an object which is a site area prototype in the repository.
- SiteAreaTemplate -
Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
- The document type for
SiteAreaTemplate
- SiteAreaTemplate - Interface in com.ibm.workplace.wcm.api
- Represents a site area authoring template.
- 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. - SiteFrameworkContainer.RenderingBehaviour - Enum in com.ibm.workplace.wcm.api
- The possible rendering behaviours for a
SiteArea - Sort - Class in com.ibm.workplace.wcm.api.query
- Sort implementations are located in api.impl
this abstract class delegates the factory methods
to a protected interface to keep the API uncluttered
- SORT_KEY_CREATION_DATE -
Static variable in interface com.ibm.workplace.wcm.api.Workspace
- Content Search method sort key for creation date
- SORT_KEY_DESCRIPTION -
Static variable in interface com.ibm.workplace.wcm.api.Workspace
- Content Search method sort key for description
- SORT_KEY_EXPIRY_DATE -
Static variable in interface com.ibm.workplace.wcm.api.Workspace
- Content Search method sort key for expiry date
- SORT_KEY_GENERAL_DATE_ONE -
Static variable in interface com.ibm.workplace.wcm.api.Workspace
- Content Search method sort key for general date one
- SORT_KEY_GENERAL_DATE_TWO -
Static variable in interface com.ibm.workplace.wcm.api.Workspace
- Content Search method sort key for general date two
- SORT_KEY_LASTMODIFIED_DATE -
Static variable in interface com.ibm.workplace.wcm.api.Workspace
- Content Search method sort key for last modified date
- SORT_KEY_NAME -
Static variable in interface com.ibm.workplace.wcm.api.Workspace
- Content Search method sort key for name
- SORT_KEY_NONE -
Static variable in interface com.ibm.workplace.wcm.api.Workspace
- Content Search method sort key for no sorting
- SORT_KEY_PUBLISH_DATE -
Static variable in interface com.ibm.workplace.wcm.api.Workspace
- Content Search method sort key for publish date
- SORT_KEY_TITLE -
Static variable in interface com.ibm.workplace.wcm.api.Workspace
- Content Search method sort key for title
- SortDirection - Enum in com.ibm.workplace.wcm.api.query
- An enumeration representing the desired direction of sorting.
- Sorts - Class in com.ibm.workplace.wcm.api.query
- This class contains several static methods for helping creating
Sort object. - Sorts() -
Constructor for class com.ibm.workplace.wcm.api.query.Sorts
-
- stageEquals(Identity) -
Static method in class com.ibm.workplace.wcm.api.query.WorkflowSelectors
- Returns a selector representing workflow stage 'equals'.
- stageIn(Collection<? extends Identity>) -
Static method in class com.ibm.workplace.wcm.api.query.WorkflowSelectors
- Returns a selector representing workflow stage 'in'.
- 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.
- StartOption - Enum in com.ibm.workplace.wcm.api
- Represents the various start option configuration
on the navigator component.
- STATE_REVERT_TO_DRAFT -
Static variable in interface com.ibm.workplace.wcm.api.HistoryLogEntryCodes
- A
HistoryLogEntry recording a backward state transition to draft.
- STATE_REVERT_TO_PUBLISHED -
Static variable in interface com.ibm.workplace.wcm.api.HistoryLogEntryCodes
- A
HistoryLogEntry recording a backward state transition to published.
- STATE_TO_PENDING_PUBLISHED -
Static variable in interface com.ibm.workplace.wcm.api.HistoryLogEntryCodes
- A
HistoryLogEntry recording a forward transition to pending published.
- STATE_TO_PUBLISHED -
Static variable in interface com.ibm.workplace.wcm.api.HistoryLogEntryCodes
- A
HistoryLogEntry recording a forward state transition to published.
- stateEquals(ProjectStateSelectors.State) -
Static method in class com.ibm.workplace.wcm.api.query.ProjectStateSelectors
- Returns a selector representing project state 'equals'
- stateIn(Collection<ProjectStateSelectors.State>) -
Static method in class com.ibm.workplace.wcm.api.query.ProjectStateSelectors
- Returns a selector representing project state 'in'
- statusEquals(WorkflowSelectors.Status) -
Static method in class com.ibm.workplace.wcm.api.query.WorkflowSelectors
- Returns a selector representing workflow status 'equals'
- statusIn(Collection<WorkflowSelectors.Status>) -
Static method in class com.ibm.workplace.wcm.api.query.WorkflowSelectors
- Returns a selector representing workflow status 'in'
- 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.
- submitForReview() -
Method in interface com.ibm.workplace.wcm.api.Project
- Submits this project for review.
- Subscriber - Interface in com.ibm.workplace.wcm.api
- Represents a WCM Subscriber.
- SubscriberComplete - Interface in com.ibm.workplace.wcm.api.extensions.syndication
- Extensions that implement this interface
are processed in the subscriber
before the process complete message is sent to the syndicator.
- SubscriberEvent - Interface in com.ibm.workplace.wcm.api.extensions.syndication
- The event info passed into the SubscriberReady and SubscriberComplete extensions.
- SubscriberReady - Interface in com.ibm.workplace.wcm.api.extensions.syndication
- Extensions that implement this interface
are processed in the subscriber
after the subscriber ready message is received
from the syndicator and before a response is returned
to the syndicator.
- successMessage() -
Method in interface com.ibm.workplace.wcm.api.extensions.authoring.ActionResult
- Return a
Localized success message that will be shown in the authoring interface.
- 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. - SyndicationRuntimeException - Exception in com.ibm.workplace.wcm.api.exceptions
-
- SyndicationRuntimeException() -
Constructor for exception com.ibm.workplace.wcm.api.exceptions.SyndicationRuntimeException
- Constructor.
- SyndicationRuntimeException(String) -
Constructor for exception com.ibm.workplace.wcm.api.exceptions.SyndicationRuntimeException
- Constructs a new exception with the given message.
- SyndicationRuntimeException(Throwable) -
Constructor for exception com.ibm.workplace.wcm.api.exceptions.SyndicationRuntimeException
- Constructor to only be used by sub classes
- SyndicationRuntimeException(String, Throwable) -
Constructor for exception com.ibm.workplace.wcm.api.exceptions.SyndicationRuntimeException
- Constructor that requires detail plus a cause exception
- 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.
- SyndicatorComplete - Interface in com.ibm.workplace.wcm.api.extensions.syndication
- Extensions that implement this interface
are processed in the syndicator
after the process complete message is received from the subscriber.
- SyndicatorEvent - Interface in com.ibm.workplace.wcm.api.extensions.syndication
- The Event object passed into the SyndicatorStarted and SyndicatorComplete extensions
The SyndicatorEvent contains all the information that is needed by the extensions.
- SyndicatorStarted - Interface in com.ibm.workplace.wcm.api.extensions.syndication
- Extensions that implement this interface are processed in the syndicator
after the syndicator receives a successful subscriber ready message from the subscriber
and before the syndicator generates the package
ContentComponent that can be used to provide a Link
to a Content within a Menu, Navigator or by a Link Component.Taxonomy
Taxonomy in the repository.Document that can be templated using
an AuthoringTemplateTextComponent.
String representation of this
DocumentId.
String representation of this object.
Date returned from this DateComponent
will be formatted to only show the date.
Date returned from this LibraryDateComponent
will be formatted to only show the date.
TYPE_DOCUMENTMANAGER references a document in the Document Manager.
Number returned will be a double.
Number returned will be a double.
TYPE_EXISTINGLINK references an existing link component.
TYPE_EXTERNALURL references an external URL.
Number returned will be an integer.
Number returned will be an integer.
TYPE_MANAGEDCONTENT references content, file or image resources.
Date returned from this DateComponent
will be formatted to only show the time.
Date returned from this LibraryDateComponent
will be formatted to only show the time.
Date returned from this DateComponent
will be formatted to show the time and date.
Date returned from this LibraryDateComponent
will be formatted to show the time and date.
HistoryLogEntry without a HistoryLogEntryCode.
DocumentId.
Subscriber.
Syndicator.
Boolean.TRUE if the current page should be used as target
page.
Workspace to use distinguished names users.
useUserAccess(boolean userAccess)
UserProfile interface retrieves user related information.UserSelectionComponent.
VersionAction
DocumentLocalized warning message that will be shown in the authoring interface.
- 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_DeleteDirectiveParams - Class in com.ibm.workplace.wcm.api.custom
- The
DeleteDirectiveParams object is used to specify arguments or options to a 'Delete' Directive. - WCM_DeleteDirectiveParams() -
Constructor for class com.ibm.workplace.wcm.api.custom.WCM_DeleteDirectiveParams
-
- WCM_EmptyDirectiveParams - Class in com.ibm.workplace.wcm.api.custom
- An 'Empty' directive params object, used for directives that don't have any parameters
- WCM_EmptyDirectiveParams() -
Constructor for class com.ibm.workplace.wcm.api.custom.WCM_EmptyDirectiveParams
- Constructor
- WCM_ERROR_KEY -
Static variable in interface com.ibm.workplace.wcm.api.Workspace
- Key for
String error messages in the page context
- WCM_NextStageDirectiveParams - Class in com.ibm.workplace.wcm.api.custom
- The
NextStageDirectiveParams object is used to specify arguments or options to a 'NextStage' Directive. - WCM_NextStageDirectiveParams() -
Constructor for class com.ibm.workplace.wcm.api.custom.WCM_NextStageDirectiveParams
-
- WCM_PreviousStageDirectiveParams - Class in com.ibm.workplace.wcm.api.custom
- The
PreviousStageDirectiveParams object is used to specify arguments or options to a 'PreviousStage' Directive. - WCM_PreviousStageDirectiveParams() -
Constructor for class com.ibm.workplace.wcm.api.custom.WCM_PreviousStageDirectiveParams
-
- WCM_RENDERINGCONTEXT_KEY -
Static variable in interface com.ibm.workplace.wcm.api.Workspace
- Key for the
RenderingContext in the page context
- WCM_RescheduleDirectiveParams - Class in com.ibm.workplace.wcm.api.custom
- The
RescheduleDirectiveParams object is used to specify arguments or options to a 'Reschedule' Directive. - WCM_RescheduleDirectiveParams() -
Constructor for class com.ibm.workplace.wcm.api.custom.WCM_RescheduleDirectiveParams
- Constructor
- WCM_RollbackDirectiveParams - Class in com.ibm.workplace.wcm.api.custom
- The
RollbackDirectiveParams object is used to specify arguments or options to a 'Rollback' Directive. - WCM_RollbackDirectiveParams() -
Constructor for class com.ibm.workplace.wcm.api.custom.WCM_RollbackDirectiveParams
- Constructor
- WCM_WORKSPACE_KEY -
Static variable in interface com.ibm.workplace.wcm.api.Workspace
- Key for the
Workspace in the page context
- WCMApiObject - Interface in com.ibm.workplace.wcm.api
- Represents an object type in the WCM API.
- 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
-
- 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
- WCMException(Localized) -
Constructor for exception com.ibm.workplace.wcm.api.exceptions.WCMException
- Constructor that requires a localized message
- 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
-
- 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
-
- withdrawApproval() -
Method in interface com.ibm.workplace.wcm.api.Project
- Withdraws the approval of the current user from the project.
- withdrawFromReview() -
Method in interface com.ibm.workplace.wcm.api.Project
- Withdraws this project from the
ProjectStateSelectors.State.REVIEW state.
- 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.
- Workflow.DraftCreationBehavior - Enum in com.ibm.workplace.wcm.api
- The
Workflow.DraftCreationBehavior controls how items using the Workflow can create new drafts - WORKFLOW_APPROVED -
Static variable in interface com.ibm.workplace.wcm.api.HistoryLogEntryCodes
- A
HistoryLogEntry recording a Document being reviewed and approved.
- WORKFLOW_CHANGED -
Static variable in interface com.ibm.workplace.wcm.api.HistoryLogEntryCodes
- A
HistoryLogEntry recording a Workflow change on a Document.
- WORKFLOW_NEXT_STAGE -
Static variable in interface com.ibm.workplace.wcm.api.HistoryLogEntryCodes
- A
HistoryLogEntry recording a Document moving to another Workflow stage
The value of this HistoryLogEntryCode is 3100.
- WORKFLOW_REJECTED -
Static variable in interface com.ibm.workplace.wcm.api.HistoryLogEntryCodes
- A
HistoryLogEntry recording a Document being reviewed and rejected.
- WORKFLOW_REJECTED_STAGE_EXECUTED -
Static variable in interface com.ibm.workplace.wcm.api.HistoryLogEntryCodes
- A
HistoryLogEntry recording a Document being reviewed and rejected then executing a specified Workflow stage.
- WORKFLOW_RESTARTED -
Static variable in interface com.ibm.workplace.wcm.api.HistoryLogEntryCodes
- A
HistoryLogEntry recording a Workflow restart on a Document.
- WorkflowAction -
Static variable in interface com.ibm.workplace.wcm.api.DocumentTypes
- The document type for
WorkflowAction
- WorkflowAction - Interface in com.ibm.workplace.wcm.api
- Represents a workflow action.
- WorkflowedDocument - Interface in com.ibm.workplace.wcm.api
- WorkflowedDocument Interface
Represents a WCM API object that supports workflow
methods
WorkflowedDocument description
- workflowEquals(Identity) -
Static method in class com.ibm.workplace.wcm.api.query.WorkflowSelectors
- Returns a selector representing workflow 'equals'.
- WorkflowException - Exception in com.ibm.workplace.wcm.api.exceptions
- Base class for all workflowable WCM classes
- WorkflowException() -
Constructor for exception com.ibm.workplace.wcm.api.exceptions.WorkflowException
- Constructor
- WorkflowException(Throwable) -
Constructor for exception com.ibm.workplace.wcm.api.exceptions.WorkflowException
- Constructor
- WorkflowException(String) -
Constructor for exception com.ibm.workplace.wcm.api.exceptions.WorkflowException
- Constructor
- WorkflowException(String, Throwable) -
Constructor for exception com.ibm.workplace.wcm.api.exceptions.WorkflowException
- Constructor
- workflowIn(Collection<? extends Identity>) -
Static method in class com.ibm.workplace.wcm.api.query.WorkflowSelectors
- Returns a selector representing workflow 'in'.
- 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
- WorkflowSelectors - Class in com.ibm.workplace.wcm.api.query
WorkflowSelectors is a helper class to create workflow related Selector.- WorkflowSelectors() -
Constructor for class com.ibm.workplace.wcm.api.query.WorkflowSelectors
-
- WorkflowSelectors.Status - Enum in com.ibm.workplace.wcm.api.query
- Workflow status
- 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.
- WorkflowStage.ACTION_GROUP - Enum in com.ibm.workplace.wcm.api
- The list of possible workflow action groups
- 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.
- 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.
- 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
- writeURL(ContentUrlGenerationRequest, ContentUrlGenerationResponse, ContentUrlGenerationFilterChain) -
Method in interface com.ibm.workplace.wcm.api.extensions.url.ContentUrlGenerationFilter
- Write the content URL for a given content.
- writeURL(ContentUrlGenerationRequest, ContentUrlGenerationResponse) -
Method in interface com.ibm.workplace.wcm.api.extensions.url.ContentUrlGenerationFilterChain
- Calls the writeURL method of the next content URL generation filter in
the URL generation chain.
- 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
|
||||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||