Deprecated API

Contents

• Deprecated Interfaces
• Deprecated Classes
• Deprecated Fields
• Deprecated Methods

Deprecated Interfaces

com.ibm.workplace.wcm.api.ContentTemplate
Use AuthoringTemplate

com.ibm.workplace.wcm.api.DocumentManagerComponent
Document Manager is deprecated since 7.0

com.ibm.workplace.wcm.api.LibraryDocumentManagerComponent
LibraryDocumentManagerComponent is deprecated since 7.0

com.ibm.workplace.wcm.api.Site
Use SiteArea instead

com.ibm.workplace.wcm.api.WCMServiceHome
Replaced by WebContentService

Deprecated Classes

com.ibm.workplace.wcm.api.WCMApiService
Replaced by WebContentService

Deprecated Fields

com.ibm.workplace.wcm.api.DocumentTypes.ContentTemplate
Use AuthoringTemplate

com.ibm.workplace.wcm.api.DocumentTypes.DocumentManagerComponent
Document Manager is deprecated since 7.0

com.ibm.workplace.wcm.api.DocumentTypes.LibraryDocumentManagerComponent
Document Manager is deprecated since 7.0

com.ibm.workplace.wcm.api.HistoryLogEntryCodes.PROJECT_CHANGED_STATE
use PROJECT_ENTERED_{state} instead.

com.ibm.workplace.wcm.api.Workspace.ROLE_APPROVER
From 8.0 onwards, use the QueryService to query for items.

com.ibm.workplace.wcm.api.Workspace.ROLE_AUTHOR
From 8.0 onwards, use the QueryService to query for items.

com.ibm.workplace.wcm.api.Workspace.ROLE_OWNER
From 8.0 onwards, use the QueryService to query for items.

com.ibm.workplace.wcm.api.Workspace.SECURITY_APPROVER_ACCESS
use Access.APPROVER instead

com.ibm.workplace.wcm.api.Workspace.SECURITY_CONTRIBUTOR_ACCESS
use Access.CONTRIBUTOR instead

com.ibm.workplace.wcm.api.Workspace.SECURITY_DELETE_ACCESS
Use manager access

com.ibm.workplace.wcm.api.Workspace.SECURITY_EDIT_ACCESS
Use editor access

com.ibm.workplace.wcm.api.Workspace.SECURITY_EDITOR_ACCESS
use Access.EDITOR instead

com.ibm.workplace.wcm.api.Workspace.SECURITY_MANAGER_ACCESS
use Access.MANAGER instead

com.ibm.workplace.wcm.api.Workspace.SECURITY_READ_ACCESS
Use contributor access

com.ibm.workplace.wcm.api.Workspace.SECURITY_USER_ACCESS
use Access.USER instead

com.ibm.workplace.wcm.api.DocumentTypes.Site
Since 7.0, Site is replaced by SiteArea.

Deprecated Methods

com.ibm.workplace.wcm.api.SiteArea.addContent(DocumentId)
use Workspace.createContent(authoringTemplateId, parentSiteId, siblingId, position) instead

com.ibm.workplace.wcm.api.Editable.addDeleteAccessMembers(String[])
Use Editable.addManagerAccessMembers(String[]) instead

com.ibm.workplace.wcm.api.Editable.addEditAccessMembers(String[])
Use Editable.addEditorAccessMembers(String[]) instead

com.ibm.workplace.wcm.api.WebContentLibraryService.addItemToFolder(Workspace, Folder, Item)
Use Folder.addDocument instead

com.ibm.workplace.wcm.api.Editable.addLiveAccessMembers(String[])
Use Editable.addUserAccessMembers(String[]) instead

com.ibm.workplace.wcm.api.Editable.addReadAccessMembers(String[])
Use Editable.addContributorAccessMembers(String[]) instead

com.ibm.workplace.wcm.api.SiteFrameworkContainer.addSiteArea(DocumentId)
use Workspace.createSiteArea(parentId, siblingId, position) instead.

com.ibm.workplace.wcm.api.query.Selectors.authoringTemplateEquals(AuthoringTemplate)
Use authoringTemplateEquals(Identity)

com.ibm.workplace.wcm.api.query.Selectors.authoringTemplateIn(AuthoringTemplate...)
Use authoringTemplateIn(Identity...)

com.ibm.workplace.wcm.api.query.Selectors.authoringTemplateIn(Collection)
Use authoringTemplateInId(Collection)

com.ibm.workplace.wcm.api.Content.cancelDraft()
use cancelDraftDocument() instead.

com.ibm.workplace.wcm.api.Workspace.copyCategory(DocumentId, DocumentId)
use Workspace.copy(Document, ParentLocation, CopyOptions) instead.

com.ibm.workplace.wcm.api.Workspace.copySiteFrameworkDocument(DocumentId, DocumentId, DocumentId, int)
use Workspace.copy(Placeable, PlacementLocation, CopyOptions) instead.

com.ibm.workplace.wcm.api.Workspace.createContent(DocumentId)
use createContent(contentTemplateId, parentSiteAreaId, siblingId, position) instead.

com.ibm.workplace.wcm.api.Workspace.createContentTemplate()
Use createAuthoringTemplate()

com.ibm.workplace.wcm.api.Workspace.createDocumentManagerComponent()
LibraryDocumentManagerComponent is deprecated since 7.0

com.ibm.workplace.wcm.api.Content.createDraft()
use createDraftDocument() instead.

com.ibm.workplace.wcm.api.WebContentLibraryService.createFolder(Workspace, Folder)
Use Workspace.createFolder instead

com.ibm.workplace.wcm.api.Workspace.createSite()
use createSiteArea() instead.

com.ibm.workplace.wcm.api.WebContentLibraryService.deleteFolder(Workspace, Item)
Use Workspace.purge instead

com.ibm.workplace.wcm.api.Workspace.findComponentByName(String)
From 8.0 onwards, use the QueryService to query for items. For example: QueryService queryService = getQueryService(); Query query = createQuery(LibraryComponent.class).addSelector(Selectors.nameLike(name)); queryService.execute(query);

com.ibm.workplace.wcm.api.Workspace.findContentByAuthoringTemplate(DocumentId)
From 8.0 onwards, use the QueryService to query for items. For example: QueryService queryService = getQueryService(); Query query = createQuery(Content.class).addSelector(Selectors.authoringTemplateIn(id)); queryService.execute(query);

com.ibm.workplace.wcm.api.Workspace.findContentByAuthoringTemplate(DocumentId, int)
From 8.0 onwards, use the QueryService to query for items. For example: QueryService queryService = getQueryService(); Query query = createQuery(Content.class).addSelector(Selectors.authoringTemplateIn(id), WorkflowSelectors.statusEquals(workflowStatus)); queryService.execute(query);

com.ibm.workplace.wcm.api.Workspace.findContentByCategory(DocumentId)
From 8.0 onwards, use the QueryService to query for items. For example: QueryService queryService = getQueryService(); Query query = createQuery(Content.class).addSelector(ProfileSelectors.categoriesContains(id)); queryService.execute(query);

com.ibm.workplace.wcm.api.Workspace.findContentByCategory(DocumentId, int)
From 8.0 onwards, use the QueryService to query for items. For example: QueryService queryService = getQueryService(); Query query = createQuery(Content.class).addSelector(ProfileSelectors.categoriesContains(id), WorkflowSelectors.statusEquals(workflowStatus)); queryService.execute(query);

com.ibm.workplace.wcm.api.Workspace.findContentByWorkflowStage(DocumentId)
From 8.0 onwards, use the QueryService to query for items. For example: QueryService queryService = getQueryService(); Query query = createQuery(Content.class).addSelector(WorkflowSelectors.stageEquals(id)); queryService.execute(query);

com.ibm.workplace.wcm.api.Workspace.findContentByWorkflowStage(DocumentId[])
From 8.0 onwards, use the QueryService to query for items. For example: QueryService queryService = getQueryService(); Query query = createQuery(Content.class).addSelector(WorkflowSelectors.stageContains(ids)); queryService.execute(query);

com.ibm.workplace.wcm.api.Workspace.findContentByWorkflowStage(DocumentId[], String[], int)
From 8.0 onwards, use the QueryService to query for items. For example: QueryService queryService = getQueryService(); [for userRoles=ROLE_AUTHOR] Query query = createQuery(Content.class).addSelector(WorkflowSelectors.stageIn(workflowStages), Selectors.authorsContain(users)); [for userRoles=ROLE_OWNER] Query query = createQuery(Content.class).addSelector(WorkflowSelectors.stageIn(workflowStages), Selectors.ownersContain(users)); [for userRoles=ROLE_APPROVER] Query query = createQuery(Content.class).addSelector(WorkflowSelectors.stageIn(workflowStages), WorkflowSelectors.statusEquals(Status.DRAFT), WorkflowSelectors.approversContains(users)); WorkflowSelectors.approversContains queryService.execute(query);

com.ibm.workplace.wcm.api.Workspace.findContentModifiedBetween(Date, Date)
From 8.0 onwards, use the QueryService to query for items. For example: QueryService queryService = getQueryService(); Query query = createQuery(Content.class).addSelector(HistorySelectors.modifiedSince(startDate), HistorySelectors.modifiedBefore(endDate)); queryService.execute(query);

com.ibm.workplace.wcm.api.Workspace.findContentModifiedBetween(Date, Date, int)
From 8.0 onwards, use the QueryService to query for items. For example: QueryService queryService = getQueryService(); Query query = createQuery(Content.class).addSelector(HistorySelectors.modifiedSince(startDate), HistorySelectors.modifiedBefore(endDate), WorkflowSelectors.statusEquals(workflowStatus)); queryService.execute(query);

com.ibm.workplace.wcm.api.Workspace.findContentModifiedSince(Date)
From 8.0 onwards, use the QueryService to query for items. For example: QueryService queryService = getQueryService(); Query query = createQuery(Content.class).addSelector(HistorySelectors.modifiedSince(modifiedDate)); queryService.execute(query);

com.ibm.workplace.wcm.api.Workspace.findContentModifiedSince(Date, int)
From 8.0 onwards, use the QueryService to query for items. For example: QueryService queryService = getQueryService(); Query query = createQuery(Content.class).addSelectors(HistorySelectors.modifiedSince(modifiedDate), WorkflowSelectors.statusEquals(workflowStatus)); queryService.execute(query);

com.ibm.workplace.wcm.api.Workspace.findDocumentsByWorkflowStage(DocumentId[])
From 8.0 onwards, use the QueryService to query for items. For example: QueryService queryService = getQueryService(); Query query = createQuery().addSelector(WorkflowSelectors.stageIn(ids)); queryService.execute(query);

com.ibm.workplace.wcm.api.Workspace.findDocumentsByWorkflowStage(DocumentId[], String[], int)
From 8.0 onwards, use the QueryService to query for items. For example: QueryService queryService = getQueryService(); [for userRoles=ROLE_AUTHOR] Query query = createQuery().addSelector(WorkflowSelectors.stageIn(workflowStages), Selectors.authorsContain(users)); [for userRoles=ROLE_OWNER] Query query = createQuery().addSelector(WorkflowSelectors.stageIn(workflowStages), Selectors.ownersContain(users)); [for userRoles=ROLE_APPROVER] Query query = createQuery().addSelector(WorkflowSelectors.stageIn(workflowStages), WorkflowSelectors.statusEquals(Status.DRAFT), WorkflowSelectors.approversContains(users)); WorkflowSelectors.approversContains queryService.execute(query);

com.ibm.workplace.wcm.api.Workspace.findDocumentsModifiedBetween(Date, Date)
From 8.0 onwards, use the QueryService to query for items. For example: QueryService queryService = getQueryService(); Query query = createQuery().addSelector(HistorySelectors.modifiedSince(startDate), HistorySelectors.modifiedBefore(endDate)); queryService.execute(query);

com.ibm.workplace.wcm.api.Workspace.findDocumentsModifiedBetween(Date, Date, int)
From 8.0 onwards, use the QueryService to query for items. For example: QueryService queryService = getQueryService(); Query query = createQuery().addSelector(HistorySelectors.modifiedSince(startDate), HistorySelectors.modifiedBefore(endDate), WorkflowSelectors.statusEquals(workflowStatus)); queryService.execute(query);

com.ibm.workplace.wcm.api.Workspace.findDocumentsModifiedSince(Date)
From 8.0 onwards, use the QueryService to query for items. For example: QueryService queryService = getQueryService(); Query query = createQuery().addSelector(HistorySelectors.modifiedSince(startDate)); queryService.execute(query);

com.ibm.workplace.wcm.api.Workspace.findDocumentsModifiedSince(Date, int)
From 8.0 onwards, use the QueryService to query for items. For example: QueryService queryService = getQueryService(); Query query = createQuery().addSelector(HistorySelectors.modifiedSince(startDate), WorkflowSelectors.statusEquals(workflowStatus)); queryService.execute(query);

com.ibm.workplace.wcm.api.Document.getContributorAccessMembers()
use Document.getMembersForAccess(Access)

com.ibm.workplace.wcm.api.ContentComponentIterator.getCount()
Please use the following code instead. while (iter.hasNext()) count = count + 1;

com.ibm.workplace.wcm.api.Document.getDeleteAccessMembers()
Use Document.getManagerAccessMembers() instead

com.ibm.workplace.wcm.api.Content.getDirectParent()
Since 8.0, use Hierarchical.getParentId()

com.ibm.workplace.wcm.api.Workspace.getDraftIdByPublishedId(DocumentId)
Use Workspace.getDraftIdsByPublishedId(com.ibm.workplace.wcm.api.DocumentId)

com.ibm.workplace.wcm.api.Document.getEditAccessMembers()
Use Document.getEditorAccessMembers() instead

com.ibm.workplace.wcm.api.Document.getEditorAccessMembers()
use Document.getMembersForAccess(Access)

com.ibm.workplace.wcm.api.LibraryFileComponent.getFile()
- use getFileStream() instead

com.ibm.workplace.wcm.api.WebContentLibraryService.getFolderById(Workspace, Identity)
Use Workspace.getById instead

com.ibm.workplace.wcm.api.LibraryImageComponent.getImage()
use getImageStream() instead

com.ibm.workplace.wcm.api.Document.getInheritedContributorAccessMembers()
use Document.getMembersForInheritedAccess(Access)

com.ibm.workplace.wcm.api.Document.getInheritedEditorAccessMembers()
use Document.getMembersForInheritedAccess(Access)

com.ibm.workplace.wcm.api.Document.getInheritedManagerAccessMembers()
use Document.getMembersForInheritedAccess(Access)

com.ibm.workplace.wcm.api.Document.getInheritedUserAccessMembers()
use Document.getMembersForInheritedAccess(Access)

com.ibm.workplace.wcm.api.Document.getLiveAccessMembers()
Use Document.getUserAccessMembers() instead

com.ibm.workplace.wcm.api.Document.getManagerAccessMembers()
use Document.getMembersForAccess(Access)

com.ibm.workplace.wcm.api.Workspace.getMemberNames()
Use the PUMA API

com.ibm.workplace.wcm.api.Workspace.getMemberNames(String)
Use the PUMA API

com.ibm.workplace.wcm.api.Category.getParent()
Since 8.0, use Hierarchical.getParentId()

com.ibm.workplace.wcm.api.SiteFrameworkContainer.getParent()
Since 8.0, use Hierarchical.getParentId()

com.ibm.workplace.wcm.api.WebContentLibraryService.getPresetFolder(Workspace, DocumentLibrary, PresetFolderType)
Use DocumentLibrary.getPresetFolder instead

com.ibm.workplace.wcm.api.AbstractAuthoringTemplate.getPrototype()
Use getGenericPrototype() instead. Since 8.0, the prototype can be of any Prototype type.

com.ibm.workplace.wcm.api.Document.getReadAccessMembers()
Use Document.getContributorAccessMembers() instead

com.ibm.workplace.wcm.api.WCMServiceHome.getRepository()
Replaced by WebContentService.getRepository()

com.ibm.workplace.wcm.api.RenderingContext.getSite()
No replacement. 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.

com.ibm.workplace.wcm.api.RenderingContext.getSiteAreas()
No replacement. 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.

com.ibm.workplace.wcm.api.query.ResultIterator.getSize()
The value returned may not be accurate for large iterators. Please use the following code instead. while (iter.hasNext()) size = size + 1;

com.ibm.workplace.wcm.api.Document.getUserAccessMembers()
use Document.getMembersForAccess(Access) instead

com.ibm.workplace.wcm.api.Document.hasDeleteAccess()
This method is deprecated from version 6.0. Calls to This method will be deprecated in the future. Calls to 'Delete' access methods have the same effect as 'Manager' access method calls. Use Workspace.hasManagerAccess(DocumentId documentId) instead

com.ibm.workplace.wcm.api.Document.hasDeleteAccess(UserProfile)
This method is deprecated from version 6.0. Calls to This method will be deprecated in the future. Calls to 'Delete' access methods have the same effect as 'Manager' access method calls. Use Workspace.hasManagerAccess(DocumentId documentId) instead

com.ibm.workplace.wcm.api.Document.hasEditAccess()
This method is deprecated from version 6.0. Calls to This method will be deprecated in the future. Calls to 'Edit' access methods have the same effect as 'Editor' access method calls. Use Workspace.hasEditorAccess(DocumentId documentId) instead

com.ibm.workplace.wcm.api.Document.hasEditAccess(UserProfile)
This method is deprecated from version 6.0. Calls to This method will be deprecated in the future. Calls to 'Edit' access methods have the same effect as 'Editor' access method calls. Use Workspace.hasEditorAccess(DocumentId documentId) instead

com.ibm.workplace.wcm.api.Document.hasLiveAccess()
This method is deprecated from version 6.0. Calls to 'Live' access methods have the same effect as 'Contributor' access method calls. Use Workspace.hasContributorAccess(DocumentId documentId) instead

com.ibm.workplace.wcm.api.Document.hasLiveAccess(UserProfile)
This method is deprecated from version 6.0. Calls to 'Live' access methods have the same effect as 'Contributor' access method calls. Use Workspace.hasContributorAccess(DocumentId documentId) instead

com.ibm.workplace.wcm.api.Document.hasReadAccess()
This method is deprecated from version 6.0. Calls to 'Live' access methods have the same effect as 'Contributor' access method calls. Use Workspace.hasContributorAccess(DocumentId documentId) instead

com.ibm.workplace.wcm.api.Document.hasReadAccess(UserProfile)
This method is deprecated from version 6.0. Calls to 'Live' access methods have the same effect as 'Contributor' access method calls. Use Workspace.hasContributorAccess(DocumentId documentId) instead

com.ibm.workplace.wcm.api.SiteArea.insertContent(DocumentId, DocumentId)
use Workspace.createContent(authoringTemplateId, parentSiteId, siblingId, position) instead

com.ibm.workplace.wcm.api.SiteFrameworkContainer.insertSiteArea(DocumentId, DocumentId)
use Workspace.createSiteArea(parentId, siblingId, position) instead.

com.ibm.workplace.wcm.api.Workspace.moveCategory(DocumentId, DocumentId)
Use Workspace.move instead

com.ibm.workplace.wcm.api.WebContentLibraryService.moveItemToFolder(Workspace, Folder, Item)
Use Workspace.move instead

com.ibm.workplace.wcm.api.Workspace.moveSiteFrameworkDocument(DocumentId, DocumentId, DocumentId, int)
use Workspace.move(Placeable, PlacementLocation, MoveOptions) instead.

com.ibm.workplace.wcm.api.DocumentIterator.nextDocument()
use DocumentIterator.next() instead. Since this class has been generified, the two methods are identical.

com.ibm.workplace.wcm.api.DocumentIdIterator.nextId()
Use DocumentIdIterator.next(). Since this class has been generified, the two methods are identical.

com.ibm.workplace.wcm.api.HistoryLogIterator.nextLogEntry()
use HistoryLogIterator.next() instead

com.ibm.workplace.wcm.api.WorkflowedDocument.nextWorkflowStage()
use WorkflowedDocument.nextWorkflowStage(boolean, boolean, String)}

com.ibm.workplace.wcm.api.WorkflowedDocument.nextWorkflowStage(boolean, boolean)
use WorkflowedDocument.nextWorkflowStage(boolean, boolean, String)}

com.ibm.workplace.wcm.api.WorkflowedDocument.previousWorkflowStage(boolean)
use WorkflowedDocument.previousWorkflowStage(boolean, String)

com.ibm.workplace.wcm.api.SiteArea.removeContent(DocumentId)
use Workspace.delete(DocumentId) instead.

com.ibm.workplace.wcm.api.Editable.removeDeleteAccessMembers(String[])
Use Editable.removeManagerAccessMembers(String[]) instead

com.ibm.workplace.wcm.api.Editable.removeEditAccessMembers(String[])
Use Editable.removeEditorAccessMembers(String[]) instead

com.ibm.workplace.wcm.api.Editable.removeLiveAccessMembers(String[])
Use Editable.removeUserAccessMembers(String[]) instead

com.ibm.workplace.wcm.api.Editable.removeReadAccessMembers(String[])
Use Editable.removeContributorAccessMembers(String[]) instead

com.ibm.workplace.wcm.api.SiteFrameworkContainer.removeSiteArea(DocumentId)
use Workspace.delete(id) instead.

com.ibm.workplace.wcm.api.WebContentLibraryService.saveFolder(Workspace, Folder)
Use Workspace.save instead

com.ibm.workplace.wcm.api.HTMLComponent.setHTML(String, EmbeddedImageMap)
This method is deprecated from version 6.0. Use HTMLComponent.setHTML(String) instead.

com.ibm.workplace.wcm.api.LibraryHTMLComponent.setHTML(String, EmbeddedImageMap)
This method is deprecated from version 6.0. Use LibraryHTMLComponent.setHTML(String) instead.

com.ibm.workplace.wcm.api.RenderingContext.setRenderedContent(Site)
Use setRenderedContent(SiteArea)

com.ibm.workplace.wcm.api.RichTextComponent.setRichText(String, EmbeddedImageMap)
This method is deprecated from version 6.0. Use RichTextComponent.setRichText(String) instead.

com.ibm.workplace.wcm.api.Workspace.useLiveAccess(boolean)
use useUserAccess(boolean userAccess)