|
Copyright © 2000, 2009, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IWorkflowManager
Interface to associate and manage Workflows for a repository, while honoring DA constraints placed on them.
Methods returning an ISortableFilterablePagedList
may perform sorting and filtering. See the documentation
in com.bea.content.paging
and Workflow
.
Note: new methods may be added to this interface periodically -- therefore, this not a good CM extension point. The recommended extension point is at the Service Provider Interface, in package com.bea.content.spi
Method Summary | |
---|---|
Workflow |
addWorkflow(ContentContext context,
String repositoryName,
String name,
String comment,
byte[] data)
Add a new workflow document to the system. |
ISortableFilterablePagedList<Workflow> |
getAllAssociableWorkflows(ContentContext context,
String repositoryName)
Returns all the workflows in the specified repository [Including the Default Workflow document] to which the user has ASSOCIATION capability. |
ISortableFilterablePagedList<Workflow> |
getAllWorkflows(ContentContext context,
String repositoryName)
Returns all the workflows in the specified repository [Including the Default Workflow document] Please note that these workflow documents are lightweight objects and do not contain the actual workflow data. |
Workflow |
getDefaultWorkflow(ContentContext context,
String repositoryName)
Returns the default workflow for the given repository. |
ISortableFilterablePagedList<Node> |
getNodesForWorkflow(ContentContext context,
ID workflowId)
Returns the Nodes associated with the given workflow. |
byte[] |
getStream(ContentContext context,
ID workflowId)
Allow users to download the byte[] representing the document of the workflow. |
ISortableFilterablePagedList<ObjectClass> |
getTypesForWorkflow(ContentContext context,
ID workflowId)
Returns the Types associated with the given workflow. |
Workflow |
getWorkflow(ContentContext context,
ID id)
Return a specific workflow document with the given id. |
Workflow |
getWorkflow(ContentContext context,
String repositoryName,
String name)
Return a specific workflow document with the given name The user needs to have VIEW or ASSOCIATE capability on the workflow. |
Workflow |
getWorkflowForNode(ContentContext context,
ID nodeId)
Returns the workflow document associated with the node. |
Workflow |
getWorkflowForType(ContentContext context,
ID typeId)
Get the workflow for the type. |
boolean |
hasCapability(ContentContext context,
String repositoryName,
Workflow workflow,
WorkflowCapability capability)
Check to see if the caller has the specified security capability on a node |
void |
remove(ContentContext context,
ID id)
Delete the specified workflow document from the system. |
Workflow |
save(ContentContext context,
ID id,
byte[] data)
Updates the workflow document data. |
Workflow |
save(ContentContext context,
ID id,
String name,
String comment)
Update the workflow document meta-data. |
Workflow |
setDefaultWorkflow(ContentContext context,
String repositoryName,
byte[] data)
Sets a default workflow for the repository |
void |
setNodeWorkflow(ContentContext context,
ID nodeId,
ID workflowId)
Sets the specific workflow document to the given node. |
void |
setTypeWorkflow(ContentContext context,
ID typeId,
ID workflowId)
Sets the specific workflow document to the given type. |
Method Detail |
---|
Workflow addWorkflow(ContentContext context, String repositoryName, String name, String comment, byte[] data) throws WorkflowExistsException, DefaultWorkflowException, RepositoryException
context
- The ContentContext objectname
- 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 remove(ContentContext context, ID id) throws DefaultWorkflowException, WorkflowInUseException, RepositoryException
context
- The ContentContext objectid
- The ID associated with the workflow object
DefaultWorkflowException
- If user tried to delete the default workflow.
WorkflowInUseException
- If the user tried to delete a workflow which was in use.
RepositoryException
- If the workflow was not deleted due to some other problem.ISortableFilterablePagedList<Workflow> getAllWorkflows(ContentContext context, String repositoryName) throws RepositoryException
context
- The ContentContext objectrepositoryName
- The name of the repository.
RepositoryException
- If workflows cannot be retrieved due to some other issue.ISortableFilterablePagedList<Workflow> getAllAssociableWorkflows(ContentContext context, String repositoryName) throws RepositoryException
context
- The ContentContext objectrepositoryName
- The name of the repository.
RepositoryException
- If workflows cannot be retrieved due to some other issue.Workflow getWorkflow(ContentContext context, ID id) throws NoSuchWorkflowException, RepositoryException
context
- The ContentContext objectid
- The ID of the workflow
NoSuchWorkflowException
- If the workflow document does not exist.
RepositoryException
- If some other error happens.Workflow getWorkflow(ContentContext context, String repositoryName, String name) throws NoSuchWorkflowException, RepositoryException
context
- The ContentContext objectrepositoryName
- 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(ContentContext context, String repositoryName) throws RepositoryException
context
- The ContentContext objectrepositoryName
- The name of the repository
RepositoryException
- If there is another exception in the repository.Workflow setDefaultWorkflow(ContentContext context, String repositoryName, byte[] data) throws RepositoryException
context
- The ContentContext objectrepositoryName
- The name of the repositorydata
- The data for the workflow xml document. The document should conform to the workflow schema
RepositoryException
Workflow save(ContentContext context, ID id, String name, String comment) throws RepositoryException
context
- The ContentContext objectid
- 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 save(ContentContext context, ID id, byte[] data) throws RepositoryException
context
- The ContentContext objectid
- 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(ContentContext context, ID nodeId, ID workflowId) throws RepositoryException
context
- The ContentContext objectnodeId
- 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.void setTypeWorkflow(ContentContext context, ID typeId, ID workflowId) throws RepositoryException
context
- The ContentContext objecttypeId
- 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(ContentContext context, ID nodeId) throws AuthorizationException, RepositoryException
context
- The ContentContext objectnodeId
- The node ID object.
RepositoryException
- if the operation does not succeed.
AuthorizationException
Workflow getWorkflowForType(ContentContext context, ID typeId) throws AuthorizationException, RepositoryException
context
- The ContentContext objecttypeId
- The type ID object.
AuthorizationException
RepositoryException
ISortableFilterablePagedList<Node> getNodesForWorkflow(ContentContext context, ID workflowId) throws RepositoryException
context
- The ContentContext objectworkflowId
- The Workflow ID object
RepositoryException
- If the opoeration does not succeed.ISortableFilterablePagedList<ObjectClass> getTypesForWorkflow(ContentContext context, ID workflowId) throws RepositoryException
context
- The ContentContext objectworkflowId
- The Workflow ID object
RepositoryException
- If the opoeration does not succeed.byte[] getStream(ContentContext context, ID workflowId) throws RepositoryException
context
- workflowId
-
RepositoryException
boolean hasCapability(ContentContext context, String repositoryName, Workflow workflow, WorkflowCapability capability) throws AuthorizationException
context
- The ContentContext objectrepositoryName
- The name of the repositoryworkflow
- The workflow.capability
- The capability to check for.
AuthorizationException
|
Copyright © 2000, 2009, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |