|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
IWorkflowManager
public interface WorkflowOps
The WorkflowOps interface contains methods to manage workflows for a given repository. A Workflow represents the workflow a node goes through from it's starting point (DRAFT) to the end point (PUBLISHED) by default. This interface allows users to customize the workflow actions associated with the node.
Method Detail |
---|
Workflow addWorkflow(String repositoryName, String name, String comment, byte[] data) throws WorkflowExistsException, DefaultWorkflowException, RepositoryException
IWorkflowManager.addWorkflow(com.bea.content.ContentContext, String, String, String, byte[])
name
- Name of the workflowcomment
- The comment associated with the workflow.data
- Byte Array of the file representing workflow data.
WorkflowExistsException
- If the workflow with the specified name already exists.
DefaultWorkflowException
- If user tried to add a default workflow in the system.
RepositoryException
- If the workflow was not added due to other problem.void deleteWorkflow(ID id) throws RepositoryException
IWorkflowManager.remove(com.bea.content.ContentContext, com.bea.content.ID)
id
- The ID associated with the workflow object
DefaultWorkflowException
- If user tried to delete the default workflow.
RepositoryException
- If the workflow was not deleted due to some other problem.Workflow[] getAllWorkflows(String repositoryName, QueryCriteria queryCriteria) throws RepositoryException
IWorkflowManager.getAllWorkflows(com.bea.content.ContentContext, String)
getWorkflow(com.bea.content.ID)
method to get the real data.
repositoryName
- The name of the repository.queryCriteria
- The query criteria for this operation.
RepositoryException
- If workflows cannot be retrieved due to some other issue.Workflow getWorkflow(ID id) throws NoSuchWorkflowException, RepositoryException
IWorkflowManager.getWorkflow(com.bea.content.ContentContext, com.bea.content.ID)
id
- The ID of the workflow
NoSuchWorkflowException
- If the workflow document does not exist.
RepositoryException
- If some other error happens.Workflow getWorkflow(String repositoryName, String name) throws NoSuchWorkflowException, RepositoryException
IWorkflowManager.getWorkflow(com.bea.content.ContentContext, String, String)
repositoryName
- The name of the repositoryname
- the name of the workflow
NoSuchWorkflowException
- If the workflow document does not exist.
RepositoryException
- If some other error happens.Workflow getDefaultWorkflow(String repositoryName) throws RepositoryException
IWorkflowManager.getDefaultWorkflow(com.bea.content.ContentContext, String)
repositoryName
- The name of the repository
RepositoryException
- If there is another exception in the repository.Workflow setDefaultWorkflow(String repositoryName, byte[] data) throws RepositoryException
IWorkflowManager.setDefaultWorkflow(com.bea.content.ContentContext, String, byte[])
repositoryName
- The name of the repositorydata
- The data for the workflow
RepositoryException
- If there is another exception in the repository.Workflow updateWorkflowMetaData(ID id, String name, String comment) throws RepositoryException
IWorkflowManager.save(com.bea.content.ContentContext, com.bea.content.ID, String, String)
id
- The id of the workflowname
- The new name of the workflowcomment
- The new comment for the workflow.
RepositoryException
- If the the update of the metadata fails for some reasonWorkflow updateWorkflowDocument(ID id, byte[] data) throws RepositoryException
IWorkflowManager.save(com.bea.content.ContentContext, com.bea.content.ID, byte[])
id
- The ID of the workflowdata
- The data associated with the workflow
RepositoryException
- If the update of the workflow does not work, or if the workflow is in use
by another node in the system.void setNodeWorkflow(ID nodeId, ID workflowId) throws RepositoryException
IWorkflowManager.setNodeWorkflow(com.bea.content.ContentContext, com.bea.content.ID, com.bea.content.ID)
nodeId
- The NodeIdworkflowId
- The workflowId. The UID in this variable can be set to null to remove the
workflow from the node.
RepositoryException
- If the operation fails for some reason. This can also be thrown
if a node already has a workflow associated with it.void setTypeWorkflow(ID typeId, ID workflowId) throws RepositoryException
IWorkflowManager.setTypeWorkflow(com.bea.content.ContentContext, com.bea.content.ID, com.bea.content.ID)
typeId
- The Type IDworkflowId
- The workflowId. The UID in this variable can be set to null to remove the
workflow from the type.
RepositoryException
- If the operation fails for some reason.Workflow getWorkflowForNode(ID nodeId) throws RepositoryException
IWorkflowManager.getWorkflowForNode(com.bea.content.ContentContext, com.bea.content.ID)
nodeId
- The node ID object.
RepositoryException
- if the operation does not succeed.Workflow getWorkflowForType(ID typeId) throws RepositoryException
IWorkflowManager.getWorkflowForType(com.bea.content.ContentContext, com.bea.content.ID)
typeId
- The type ID object.
RepositoryException
- if the operation does not succeed.Node[] getNodesForWorkflow(ID workflowId, QueryCriteria queryCriteria) throws RepositoryException
IWorkflowManager.getNodesForWorkflow(com.bea.content.ContentContext, com.bea.content.ID)
workflowId
- The Workflow ID objectqueryCriteria
- The query criteria for this operation
RepositoryException
- If the opoeration does not succeed.ObjectClass[] getTypesForWorkflow(ID workflowId, QueryCriteria queryCriteria) throws RepositoryException
IWorkflowManager.getTypesForWorkflow(com.bea.content.ContentContext, com.bea.content.ID)
workflowId
- The Workflow ID objectqueryCriteria
- The query criteria for this operation
RepositoryException
- If the opoeration does not succeed.byte[] getWorkflowDocument(ID workflowId) throws RepositoryException
IWorkflowManager.getStream(com.bea.content.ContentContext, com.bea.content.ID)
workflowId
- The id of the workflow
RepositoryException
- If the operation does not succeed.Set<String> getNativeSortableProperties(String repositoryName) throws RepositoryException
repositoryName
- The name of the repository.
RepositoryException
- If the operation does not succeed.Set<String> getNativeFilterableProperties(String repositoryName) throws RepositoryException
repositoryName
- The name of the repository.
RepositoryException
- If the operation does not succeed.
|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |