|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WcmProjectService
WcmProjectService enables access to the WCM API through Portal services.
Here is an example of how to retrieve the WcmProjectService
:
try { // Construct and inital Context InitialContext ctx = new InitialContext(); // Retrieve WcmProjectService using JNDI name WcmProjectService service = (WcmProjectService) ctx.lookup("portal:service/wcm/WcmProjectService"); } catch (NamingException ne) { System.out.print("Naming Exception: " + ne); }
Field Summary | |
---|---|
static java.lang.String |
JNDI_NAME
JNDI name of this service |
Method Summary | |
---|---|
Document |
addItemToProject(Workspace workspace,
Project project,
WorkflowedDocument workflowedDocument)
Add a Document into the given Project . |
void |
cancelDeletion(Workspace workspace,
Project project,
Document document)
Clear deletion marking from a Document on a Project |
Project |
createProject(Workspace workspace)
Create a new Project object. |
Project |
createProject(Workspace workspace,
DocumentId projectTemplateDocumentId)
Create a Project using the specified ProjectTemplate . |
ProjectTemplate |
createProjectTemplate(Workspace workspace)
Creates a new ProjectTemplate . |
ProjectTemplate |
createProjectTemplate(Workspace workspace,
Project project)
Creates a new ProjectTemplate taking the basic settings and properties of the
supplied Project . |
void |
deleteProject(Workspace workspace,
Project project)
Delete Project object from WCM repository. |
ResultIterator<Project> |
findProjectsByName(Workspace workspace,
java.lang.String name)
Obtain existing Project (s) from WCM repository by their name. |
ResultIterator<Project> |
findProjectsByState(Workspace workspace,
ProjectStateSelectors.State projectState)
Obtain a Project from WCM repository with its project state. |
ResultIterator<Project> |
findProjectsByTitle(Workspace workspace,
java.lang.String title)
Obtain existing Project (s) from WCM repository by their title. |
Project |
getProjectById(Workspace workspace,
DocumentId projectDocumentId)
Obtain a Project from WCM repository by its DocumentId |
void |
markItemForDeletion(Workspace workspace,
Project project,
Document document)
Set a Document into deleted state. |
LocalizedMessageContainer |
markItemForDeletion(Workspace workspace,
Project project,
Document document,
boolean checkExternalReferences)
Set a Document into deleted state. |
void |
removeItemFromProject(Workspace workspace,
Project project,
Document document)
Remove a Document from Project |
void |
saveProject(Workspace workspace,
Project project)
Add or update a Project in the WCM repository. |
Field Detail |
---|
static final java.lang.String JNDI_NAME
Method Detail |
---|
ProjectTemplate createProjectTemplate(Workspace workspace) throws com.ibm.workplace.wcm.api.exceptions.DocumentCreationException, com.ibm.workplace.wcm.api.exceptions.AuthorizationException
ProjectTemplate
.
A typical usage of this method is as follows:
Workspace workspace = WCM_API.getRepository().getWorkspace(username, password); InitialContext ctx = new InitialContext(); Workspace workspace = (WcmProjectService) ctx.lookup("portal:service/wcm/WcmProjectService"); ProjectTemplate projectTemplate = projectService.createProjectTemplate(workspace); projectTemplate.setName(name); ProjectPrototype prototype = projectTemplate.getPrototype(); prototype.setPublishOptions(PublishOptions.MANUAL); prototype.setApprovalMode(ApprovalMode.REQUIRE_ALL_APPROVALS); prototype.setCommentMode(CommentMode.ENABLED); prototype.setWorkflowActionsForState(State.REVIEW, actionIds); prototype.setWorkflowActionsForState(State.REJECTED, actionIds); workspace.save(projectTemplate);
workspace
- workspace
ProjectTemplate
object.
com.ibm.workplace.wcm.api.exceptions.DocumentCreationException
- if the object cannot be created.
com.ibm.workplace.wcm.api.exceptions.AuthorizationException
- if the user does not have minimum Editor access.ProjectTemplate createProjectTemplate(Workspace workspace, Project project) throws com.ibm.workplace.wcm.api.exceptions.DocumentCreationException, com.ibm.workplace.wcm.api.exceptions.AuthorizationException
ProjectTemplate
taking the basic settings and properties of the
supplied Project
. The publish settings, approval and action properties of the
Project
will be copied over to the new ProjectTemplate
.
workspace
- workspaceproject
- The project to base the new template off.
ProjectTemplate
object.
com.ibm.workplace.wcm.api.exceptions.DocumentCreationException
- if the object cannot be created.
com.ibm.workplace.wcm.api.exceptions.AuthorizationException
- if the user does not have minimum Editor access.Project createProject(Workspace workspace) throws com.ibm.workplace.wcm.api.exceptions.AuthorizationException, com.ibm.workplace.wcm.api.exceptions.DocumentCreationException
Project
object. The default project template attributes will be used.
workspace
- workspace
Project
com.ibm.workplace.wcm.api.exceptions.AuthorizationException
- if the current user does not have permission
com.ibm.workplace.wcm.api.exceptions.DocumentCreationException
- if the item could not be createdProject createProject(Workspace workspace, DocumentId projectTemplateDocumentId) throws com.ibm.workplace.wcm.api.exceptions.DocumentCreationException, com.ibm.workplace.wcm.api.exceptions.AuthorizationException
Project
using the specified ProjectTemplate
.
The created Project
will inherit all attributes
defined on the ProjectPrototype
of the given ProjectTemplate
.
workspace
- workspaceprojectTemplateDocumentId
- the document id of a ProjectTemplate
.
Project
instance created from the given ProjectTemplate
.
java.lang.IllegalArgumentException
- if the given id is null
or is not a ProjectTemplate
com.ibm.workplace.wcm.api.exceptions.DocumentCreationException
- if the project can not be created or
the specified ProjectTemplate
does not exist.
com.ibm.workplace.wcm.api.exceptions.AuthorizationException
- if the current user does not have sufficient access.void saveProject(Workspace workspace, Project project) throws com.ibm.workplace.wcm.api.exceptions.AuthorizationException, com.ibm.workplace.wcm.api.exceptions.DuplicateChildException, com.ibm.workplace.wcm.api.exceptions.DocumentSaveException, com.ibm.workplace.wcm.api.exceptions.ProjectException
Project
in the WCM repository.
workspace
- workspaceproject
- Project
object to save
com.ibm.workplace.wcm.api.exceptions.AuthorizationException
- if the current user does not have permission
com.ibm.workplace.wcm.api.exceptions.DuplicateChildException
- if another item with the same name already exists
com.ibm.workplace.wcm.api.exceptions.DocumentSaveException
- if an error occurs while saving the item
com.ibm.workplace.wcm.api.exceptions.ProjectException
- if an internal error occursvoid deleteProject(Workspace workspace, Project project) throws com.ibm.workplace.wcm.api.exceptions.AuthorizationException, com.ibm.workplace.wcm.api.exceptions.DocumentNotFoundException, com.ibm.workplace.wcm.api.exceptions.DocumentDeleteException, com.ibm.workplace.wcm.api.exceptions.DocumentDeleteReferentialIntegrityException, com.ibm.workplace.wcm.api.exceptions.ProjectException
Project
object from WCM repository.
workspace
- workspaceproject
- Project
to delete
com.ibm.workplace.wcm.api.exceptions.AuthorizationException
- if the current user does not have permission
com.ibm.workplace.wcm.api.exceptions.DocumentNotFoundException
- if the item could not be found
com.ibm.workplace.wcm.api.exceptions.DocumentDeleteException
- if the item could not be deleted
com.ibm.workplace.wcm.api.exceptions.DocumentDeleteReferentialIntegrityException
- if the item cannot be deleted because another item refers to it
com.ibm.workplace.wcm.api.exceptions.ProjectException
- if an internal error occursDocument addItemToProject(Workspace workspace, Project project, WorkflowedDocument workflowedDocument) throws com.ibm.workplace.wcm.api.exceptions.AuthorizationException, com.ibm.workplace.wcm.api.exceptions.IllegalDocumentTypeException, com.ibm.workplace.wcm.api.exceptions.DocumentIsLockedException, com.ibm.workplace.wcm.api.exceptions.MaximumProjectItemsReachedException, com.ibm.workplace.wcm.api.exceptions.ProjectException
Document
into the given Project
.
If a new and unsaved Item is passed to this method then the add to Project will only committed after a Workspace.save() is called on the Item.
workspace
- workspaceproject
- Project
to which the Document
is added.workflowedDocument
- WorkflowedDocument
to add to Project
Document
actually added into the Project
com.ibm.workplace.wcm.api.exceptions.AuthorizationException
- if the current user does not have permission
com.ibm.workplace.wcm.api.exceptions.IllegalDocumentTypeException
- if the document of this type cannot be added to a project
com.ibm.workplace.wcm.api.exceptions.DocumentIsLockedException
- the item is locked by another user and cannot be added to a project by this user
com.ibm.workplace.wcm.api.exceptions.MaximumProjectItemsReachedException
- if no more items can be added to the project
com.ibm.workplace.wcm.api.exceptions.ProjectException
- if an internal error has occurred
FirstStageContainsPublishActionException
- if the workflowed document has a workflow with the first stage having a published action
java.lang.IllegalArgumentException
- if the specified WorkflowedDocument
or Project
is nullvoid removeItemFromProject(Workspace workspace, Project project, Document document) throws com.ibm.workplace.wcm.api.exceptions.AuthorizationException, com.ibm.workplace.wcm.api.exceptions.DocumentIsLockedException, com.ibm.workplace.wcm.api.exceptions.ProjectException
Document
from Project
workspace
- workspaceproject
- Project
from which the Document
is removed.document
- Document
to be removed from Project
.
com.ibm.workplace.wcm.api.exceptions.AuthorizationException
- if the current user does not have permission
com.ibm.workplace.wcm.api.exceptions.DocumentIsLockedException
- the item is locked by another user and cannot be removed from a project by this user
com.ibm.workplace.wcm.api.exceptions.ProjectException
- if an internal error has occurred
java.lang.IllegalArgumentException
- if the specified Document
or Project
is nullvoid markItemForDeletion(Workspace workspace, Project project, Document document) throws com.ibm.workplace.wcm.api.exceptions.AuthorizationException, com.ibm.workplace.wcm.api.exceptions.DocumentNotFoundException, com.ibm.workplace.wcm.api.exceptions.DocumentRetrievalException, com.ibm.workplace.wcm.api.exceptions.DocumentDeleteException, com.ibm.workplace.wcm.api.exceptions.DocumentDeleteReferentialIntegrityException, com.ibm.workplace.wcm.api.exceptions.ProjectException
Document
into deleted state.
workspace
- workspaceproject
- Project
in which a item resides in.document
- Document
to be marked as deleted.
com.ibm.workplace.wcm.api.exceptions.AuthorizationException
- if the current user does not have permission
com.ibm.workplace.wcm.api.exceptions.DocumentNotFoundException
- if the item could not be found
com.ibm.workplace.wcm.api.exceptions.DocumentRetrievalException
- if an error occurs while locating the item
com.ibm.workplace.wcm.api.exceptions.DocumentDeleteException
- if the item could not be deleted
com.ibm.workplace.wcm.api.exceptions.DocumentDeleteReferentialIntegrityException
- if the item cannot be deleted because another item refers to it
com.ibm.workplace.wcm.api.exceptions.ProjectException
- if an internal error occursLocalizedMessageContainer markItemForDeletion(Workspace workspace, Project project, Document document, boolean checkExternalReferences) throws com.ibm.workplace.wcm.api.exceptions.AuthorizationException, com.ibm.workplace.wcm.api.exceptions.DocumentNotFoundException, com.ibm.workplace.wcm.api.exceptions.DocumentRetrievalException, com.ibm.workplace.wcm.api.exceptions.DocumentDeleteException, com.ibm.workplace.wcm.api.exceptions.DocumentDeleteReferentialIntegrityException, com.ibm.workplace.wcm.api.exceptions.ProjectException
Document
into deleted state.
workspace
- workspaceproject
- Project
in which a item resides in.document
- Document
to be marked as deleted.checkExternalReferences
- indicates whether to check for invalid references external to the project
com.ibm.workplace.wcm.api.exceptions.AuthorizationException
- if the current user does not have permission
com.ibm.workplace.wcm.api.exceptions.DocumentNotFoundException
- if the item could not be found
com.ibm.workplace.wcm.api.exceptions.DocumentRetrievalException
- if an error occurs while locating the item
com.ibm.workplace.wcm.api.exceptions.DocumentDeleteException
- if the item could not be deleted
com.ibm.workplace.wcm.api.exceptions.DocumentDeleteReferentialIntegrityException
- if the item cannot be deleted because another item refers to it
com.ibm.workplace.wcm.api.exceptions.ProjectException
- if an internal error occursvoid cancelDeletion(Workspace workspace, Project project, Document document) throws com.ibm.workplace.wcm.api.exceptions.AuthorizationException, com.ibm.workplace.wcm.api.exceptions.ProjectException
Document
on a Project
- Parameters:
workspace
- workspaceproject
- Project
in which a item resides in.document
- Document
to be cancelled from deletion marking.
- Throws:
com.ibm.workplace.wcm.api.exceptions.AuthorizationException
- if the current user does not have permission
com.ibm.workplace.wcm.api.exceptions.ProjectException
- if an internal error has occurred- Since:
- 7.0
ResultIterator<Project> findProjectsByName(Workspace workspace, java.lang.String name) throws com.ibm.workplace.wcm.api.exceptions.QueryServiceException
Project
(s) from WCM repository by their name.
workspace
- workspacename
- Project
name to be retrieved.
Project
object(s) with the given name
com.ibm.workplace.wcm.api.exceptions.QueryServiceException
- if an error occurs doing the queryResultIterator<Project> findProjectsByTitle(Workspace workspace, java.lang.String title) throws com.ibm.workplace.wcm.api.exceptions.QueryServiceException
Project
(s) from WCM repository by their title.
workspace
- workspacetitle
- Project
title to be retrieved.
Project
object(s) with the given title
com.ibm.workplace.wcm.api.exceptions.QueryServiceException
- if an error occurs doing the queryProject getProjectById(Workspace workspace, DocumentId projectDocumentId) throws com.ibm.workplace.wcm.api.exceptions.AuthorizationException, com.ibm.workplace.wcm.api.exceptions.DocumentRetrievalException
Project
from WCM repository by its DocumentId
workspace
- workspaceprojectDocumentId
- Id of Project
to be retrieved.
Project
object
com.ibm.workplace.wcm.api.exceptions.AuthorizationException
- if the current user does not have permission
com.ibm.workplace.wcm.api.exceptions.DocumentRetrievalException
- if an error occurs while locating the itemResultIterator<Project> findProjectsByState(Workspace workspace, ProjectStateSelectors.State projectState) throws com.ibm.workplace.wcm.api.exceptions.QueryServiceException
Project
from WCM repository with its project state.
workspace
- workspaceprojectState
- project state defined by ProjectStateSelectors.State
com.ibm.workplace.wcm.api.exceptions.QueryServiceException
- if an error occurs doing the query
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |