|
Copyright © 2000, 2008, 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 WorkflowOpsV1
WorkflowOps is a Ticket interface for Workflow CRUD operations. This 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 as well as the status associated with each action.
Nested Class Summary | |
---|---|
static class |
WorkflowOpsV1.MethodName
|
Method Summary | |
---|---|
Workflow |
addWorkflow(String name,
String comment,
byte[] data)
Add a new workflow document to the system. |
void |
deleteWorkflow(ID id)
Delete the specified workflow document from the system. |
Workflow[] |
getAllWorkflows(QueryCriteria queryCriteria)
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()
Returns the default workflow for the given repository. |
Set<String> |
getNativeFilterableProperties()
Returns a set of property names which the repository can filter natively (within the repository instead of the federated API) for paging purposes. |
Set<String> |
getNativeSortableProperties()
Returns a set of property names which the repository can sort natively (within the repository instead of the federated API) for paging purposes. |
ID[] |
getNodeIDsForWorkflow(ID workflowId,
QueryCriteria queryCriteria)
Returns the Node IDs associated with the given workflow. |
ID[] |
getTypeIDsForWorkflow(ID workflowId,
QueryCriteria queryCriteria)
Returns the Type IDs associated with the given workflow. |
byte[] |
getWorkflowDocument(ID workflowId)
Return the document associated with the workflow. |
Workflow |
getWorkflowForNode(ID nodeId)
Returns the workflow document associated with the node. |
Workflow |
getWorkflowForType(ID typeId)
Returns the workflow document associated with the type. |
Workflow |
getWorkflowWithId(ID id)
Return a specific workflow document with the given id |
Workflow |
getWorkflowWithName(String name)
Return a specific workflow document with the given name |
Workflow |
setDefaultWorkflow(byte[] data)
Allows a user to set a default workflow for the entire repository. |
void |
setNodeWorkflow(ID nodeId,
ID workflowId)
Sets the specific workflow document to the given node. |
void |
setTypeWorkflow(ID typeId,
ID workflowId)
Sets the specific workflow document to the given type. |
Workflow |
updateWorkflowDocument(ID id,
byte[] data)
Updates the workflow document data. |
Workflow |
updateWorkflowMetaData(ID id,
String name,
String comment)
Update the workflow document meta-data. |
Method Detail |
---|
Workflow addWorkflow(String name, String comment, byte[] data) throws RepositoryException
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
id
- 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.Workflow[] getAllWorkflows(QueryCriteria queryCriteria) throws RepositoryException
queryCriteria
- The query criteria for this operation.
RepositoryException
- If workflows cannot be retrieved due to some other issue.Workflow getWorkflowWithId(ID id) throws RepositoryException
id
- The ID of the workflow
NoSuchWorkflowException
- If the workflow document does not exist.
RepositoryException
- If some other error happens.Workflow getWorkflowWithName(String name) throws RepositoryException
name
- The name of the workflow
NoSuchWorkflowException
- If the workflow document does not exist.
RepositoryException
- If some other error happens.Workflow getDefaultWorkflow() throws RepositoryException
RepositoryException
- If there is another exception in the repository.Workflow setDefaultWorkflow(byte[] data) throws RepositoryException
data
- The workflow data
RepositoryException
- If there is another exception in the repository.Workflow updateWorkflowMetaData(ID id, String name, String comment) throws RepositoryException
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
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
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.void setTypeWorkflow(ID typeId, ID workflowId) throws RepositoryException
typeId
- The TypeIdworkflowId
- 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. This can also be thrown
if a node already has a workflow associated with it.Workflow getWorkflowForNode(ID nodeId) throws RepositoryException
nodeId
- The node ID object.
RepositoryException
- if the operation does not succeed.Workflow getWorkflowForType(ID typeId) throws RepositoryException
typeId
- The type ID object.
RepositoryException
- if the operation does not succeed.ID[] getNodeIDsForWorkflow(ID workflowId, QueryCriteria queryCriteria) throws RepositoryException
workflowId
- The Workflow ID objectqueryCriteria
- The query criteria for this operation
RepositoryException
- If the operation does not succeed.ID[] getTypeIDsForWorkflow(ID workflowId, QueryCriteria queryCriteria) throws RepositoryException
workflowId
- The Workflow ID objectqueryCriteria
- The query criteria for this operation
RepositoryException
- If the operation does not succeed.byte[] getWorkflowDocument(ID workflowId) throws RepositoryException
workflowId
- The ID of the workflow
NoSuchWorkflowException
- if workflow does not exist.
RepositoryException
Set<String> getNativeSortableProperties() throws RepositoryException
RepositoryException
- If the operation does not succeed.Set<String> getNativeFilterableProperties() throws RepositoryException
RepositoryException
- If the operation does not succeed.
|
Copyright © 2000, 2008, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |