|
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 |
@ControlInterface public interface ContentWorkflowControl
Control to represent interface to workflow methods in content mgmt system.
Method Summary | |
---|---|
Workflow |
addWorkflow(ContentContext context,
String repositoryName,
String name,
String comment,
byte[] data)
Add a new workflow document to the system. |
SortableFilterablePagedResult<Workflow> |
getAllAssociableWorkflows(ContentContext context,
String repositoryName,
int pageSize)
Returns all the workflows in the specified repository [Including the Default Workflow document] to which the user has can_associate capability. |
Workflow[] |
getAllWorkflows(ContentContext context,
String repositoryName)
Returns all the workflows in the specified repository [Including the Default Lifecycle document] Please note that these workflow documents are lightweight objects and do not contain the actual workflow data. |
SortableFilterablePagedResult<Workflow> |
getAllWorkflows(ContentContext context,
String repositoryName,
int pageSize)
Returns all the workflows in the specified repository [Including the Default Lifecycle 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. |
Node[] |
getNodesForWorkflow(ContentContext context,
ID workflowId)
Returns the Nodes associated with the given workflow. |
SortableFilterablePagedResult<Node> |
getNodesForWorkflow(ContentContext context,
ID workflowId,
int pageSize)
Returns the Nodes associated with the given workflow. |
List<String> |
getStatusOptions(Node node,
Version version,
ContentContext contentContext)
Gets a list of valid workflow statuses that the given node version can transition to, considering the current workflow status |
Map<Integer,String> |
getStatusOptionsMap(Node node,
Version version,
ContentContext contentContext)
Gets a list of valid workflow statuses (with corresponding int value) that the given node version can transition to, considering the current workflow status |
byte[] |
getStream(ContentContext context,
ID workflowId)
Allow users to download the byte[] representing the document of the workflow. |
ObjectClass[] |
getTypesForWorkflow(ContentContext context,
ID workflowId)
Returns the Types associated with the given workflow. |
SortableFilterablePagedResult<ObjectClass> |
getTypesForWorkflow(ContentContext context,
ID workflowId,
int pageSize)
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 |
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. |
Workflow |
getWorkflowOrDefaultWorkflowForNode(ContentContext contentContext,
Node node)
Returns the workflow document associated with the node. |
boolean |
hasAssociateCapability(ContentContext context,
String repositoryName,
Workflow workflow)
Check to see if the given workflow has CAN_ASSOCIATE capability for it to be associated with a node for the current user. |
boolean |
hasCreateCapability(ContentContext context,
String repositoryName,
Workflow workflow)
Check to see if the given workflow hasCreateCapability |
boolean |
hasDeleteCapability(ContentContext context,
String repositoryName,
Workflow workflow)
Check to see if the given workflow hasDeleteCapability for the current user. |
boolean |
hasUpdateCapability(ContentContext context,
String repositoryName,
Workflow workflow)
Check to see if the given workflow hasUpdateCapability for the current user. |
boolean |
hasViewCapability(ContentContext context,
String repositoryName,
Workflow workflow)
Check to see if the given workflow hasViewCapability for the current user. |
void |
remove(ContentContext context,
ID id)
Delete the specified workflow document from the system. |
void |
save(ContentContext context,
ID id,
byte[] data)
Updates the workflow document data. |
void |
save(ContentContext context,
ID id,
String name,
String comment)
Update the workflow document meta-data. |
void |
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.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.SortableFilterablePagedResult<Workflow> getAllWorkflows(ContentContext context, String repositoryName, int pageSize) throws RepositoryException
context
- The ContentContext objectrepositoryName
- The name of the repository.pageSize
- the number of items per page in the PagedResult
RepositoryException
- If there is another exception in the repository.SortableFilterablePagedResult<Workflow> getAllAssociableWorkflows(ContentContext context, String repositoryName, int pageSize) throws RepositoryException
context
- The ContentContext objectrepositoryName
- The name of the repository.pageSize
- the number of items per page in the PagedResult
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.void 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
void 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 reasonvoid 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 the ID 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(ContentContext context, ID typeId, ID workflowId) throws RepositoryException
context
- The ContentContext objecttypeId
- The Type IDworkflowId
- The workflowId. The UID in the ID 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
Node[] getNodesForWorkflow(ContentContext context, ID workflowId) throws RepositoryException
context
- The ContentContext objectworkflowId
- The Workflow ID object
RepositoryException
- If the opoeration does not succeed.SortableFilterablePagedResult<Node> getNodesForWorkflow(ContentContext context, ID workflowId, int pageSize) throws RepositoryException
context
- The ContentContext objectworkflowId
- The Workflow ID objectpageSize
- number of items per page in the PagedResult
RepositoryException
ObjectClass[] getTypesForWorkflow(ContentContext context, ID workflowId) throws RepositoryException
context
- The ContentContext objectworkflowId
- The Workflow ID object
RepositoryException
- If the opoeration does not succeed.SortableFilterablePagedResult<ObjectClass> getTypesForWorkflow(ContentContext context, ID workflowId, int pageSize) throws RepositoryException
context
- The ContentContext objectworkflowId
- The Workflow ID objectpageSize
- number of items per page in the PagedResult
RepositoryException
byte[] getStream(ContentContext context, ID workflowId) throws RepositoryException
context
- workflowId
-
RepositoryException
boolean hasCreateCapability(ContentContext context, String repositoryName, Workflow workflow) throws AuthorizationException
context
- The ContentContext objectrepositoryName
- The name of the repository.workflow
- The workflow. Null checks at the root
AuthorizationException
boolean hasDeleteCapability(ContentContext context, String repositoryName, Workflow workflow) throws AuthorizationException
context
- The ContentContext objectrepositoryName
- The name of the reposihey btory.workflow
- The workflow. Null checks at the root
AuthorizationException
boolean hasViewCapability(ContentContext context, String repositoryName, Workflow workflow) throws AuthorizationException
context
- The ContentContext objectrepositoryName
- The name of the repository.workflow
- The workflow. Null checks at the root
AuthorizationException
boolean hasUpdateCapability(ContentContext context, String repositoryName, Workflow workflow) throws AuthorizationException
context
- The ContentContext objectrepositoryName
- The name of the repository.workflow
- The workflow. Null checks at the root
AuthorizationException
boolean hasAssociateCapability(ContentContext context, String repositoryName, Workflow workflow) throws AuthorizationException
context
- The ContentContext objectrepositoryName
- The name of the repository.workflow
- The workflow. Null checks at the root
AuthorizationException
List<String> getStatusOptions(Node node, Version version, ContentContext contentContext) throws RepositoryException
node
- version
- contentContext
-
RepositoryException
Map<Integer,String> getStatusOptionsMap(Node node, Version version, ContentContext contentContext) throws RepositoryException
node
- version
- contentContext
-
RepositoryException
Workflow getWorkflowOrDefaultWorkflowForNode(ContentContext contentContext, Node node) throws RepositoryException
contentContext
- node
-
RepositoryException
|
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 |