|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ContentWorkflowControl
Control to represent interface to workflow methods in content mgmt system.
Method Summary | |
---|---|
com.bea.content.virtual.workflow.Workflow |
addWorkflow(com.bea.content.ContentContext context,
String repositoryName,
String name,
String comment,
byte[] data)
Add a new workflow document to the system. |
com.bea.p13n.pagination.SortableFilterablePagedResult<com.bea.content.virtual.workflow.Workflow> |
getAllAssociableWorkflows(com.bea.content.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. |
com.bea.content.virtual.workflow.Workflow[] |
getAllWorkflows(com.bea.content.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. |
com.bea.p13n.pagination.SortableFilterablePagedResult<com.bea.content.virtual.workflow.Workflow> |
getAllWorkflows(com.bea.content.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. |
com.bea.content.virtual.workflow.Workflow |
getDefaultWorkflow(com.bea.content.ContentContext context,
String repositoryName)
Returns the default workflow for the given repository. |
com.bea.content.Node[] |
getNodesForWorkflow(com.bea.content.ContentContext context,
com.bea.content.ID workflowId)
Returns the Nodes associated with the given workflow. |
com.bea.p13n.pagination.SortableFilterablePagedResult<com.bea.content.Node> |
getNodesForWorkflow(com.bea.content.ContentContext context,
com.bea.content.ID workflowId,
int pageSize)
Returns the Nodes associated with the given workflow. |
List<String> |
getStatusOptions(com.bea.content.Node node,
com.bea.content.virtual.version.Version version,
com.bea.content.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(com.bea.content.Node node,
com.bea.content.virtual.version.Version version,
com.bea.content.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(com.bea.content.ContentContext context,
com.bea.content.ID workflowId)
Allow users to download the byte[] representing the document of the workflow. |
com.bea.content.ObjectClass[] |
getTypesForWorkflow(com.bea.content.ContentContext context,
com.bea.content.ID workflowId)
Returns the Types associated with the given workflow. |
com.bea.p13n.pagination.SortableFilterablePagedResult<com.bea.content.ObjectClass> |
getTypesForWorkflow(com.bea.content.ContentContext context,
com.bea.content.ID workflowId,
int pageSize)
Returns the Types associated with the given workflow. |
com.bea.content.virtual.workflow.Workflow |
getWorkflow(com.bea.content.ContentContext context,
com.bea.content.ID id)
Return a specific workflow document with the given id |
com.bea.content.virtual.workflow.Workflow |
getWorkflow(com.bea.content.ContentContext context,
String repositoryName,
String name)
Return a specific workflow document with the given name |
com.bea.content.virtual.workflow.Workflow |
getWorkflowForNode(com.bea.content.ContentContext context,
com.bea.content.ID nodeId)
Returns the workflow document associated with the node. |
com.bea.content.virtual.workflow.Workflow |
getWorkflowForType(com.bea.content.ContentContext context,
com.bea.content.ID typeId)
Get the workflow for the type. |
com.bea.content.virtual.workflow.Workflow |
getWorkflowOrDefaultWorkflowForNode(com.bea.content.ContentContext contentContext,
com.bea.content.Node node)
If the given node has a workflow expicitly assigned to it, it is returned. |
boolean |
hasAssociateCapability(com.bea.content.ContentContext context,
String repositoryName,
com.bea.content.virtual.workflow.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(com.bea.content.ContentContext context,
String repositoryName,
com.bea.content.virtual.workflow.Workflow workflow)
Check to see if the given workflow hasCreateCapability |
boolean |
hasDeleteCapability(com.bea.content.ContentContext context,
String repositoryName,
com.bea.content.virtual.workflow.Workflow workflow)
Check to see if the given workflow hasDeleteCapability for the current user. |
boolean |
hasUpdateCapability(com.bea.content.ContentContext context,
String repositoryName,
com.bea.content.virtual.workflow.Workflow workflow)
Check to see if the given workflow hasUpdateCapability for the current user. |
boolean |
hasViewCapability(com.bea.content.ContentContext context,
String repositoryName,
com.bea.content.virtual.workflow.Workflow workflow)
Check to see if the given workflow hasViewCapability for the current user. |
void |
remove(com.bea.content.ContentContext context,
com.bea.content.ID id)
Delete the specified workflow document from the system. |
void |
save(com.bea.content.ContentContext context,
com.bea.content.ID id,
byte[] data)
Updates the workflow document data. |
void |
save(com.bea.content.ContentContext context,
com.bea.content.ID id,
String name,
String comment)
Update the workflow document meta-data. |
void |
setDefaultWorkflow(com.bea.content.ContentContext context,
String repositoryName,
byte[] data)
Sets a default workflow for the repository |
void |
setNodeWorkflow(com.bea.content.ContentContext context,
com.bea.content.ID nodeId,
com.bea.content.ID workflowId)
Sets the specific workflow document to the given node. |
void |
setTypeWorkflow(com.bea.content.ContentContext context,
com.bea.content.ID typeId,
com.bea.content.ID workflowId)
Sets the specific workflow document to the given type. |
Method Detail |
---|
com.bea.content.virtual.workflow.Workflow addWorkflow(com.bea.content.ContentContext context, String repositoryName, String name, String comment, byte[] data) throws com.bea.content.WorkflowExistsException, com.bea.content.DefaultWorkflowException, com.bea.content.RepositoryException
context
- The ContentContext objectname
- Name of the workflowcomment
- The comment associated with the workflow.data
- Byte Array of the file representing workflow data.
com.bea.content.WorkflowExistsException
- If the workflow with the specified name already exists.
com.bea.content.DefaultWorkflowException
- If user tried to add a default workflow in the system.
com.bea.content.RepositoryException
- If the workflow was not added due to other problem.void remove(com.bea.content.ContentContext context, com.bea.content.ID id) throws com.bea.content.DefaultWorkflowException, com.bea.content.RepositoryException
context
- The ContentContext objectid
- The ID associated with the workflow object
com.bea.content.DefaultWorkflowException
- If user tried to delete the default workflow.
com.bea.content.RepositoryException
- If the workflow was not deleted due to some other problem.com.bea.content.virtual.workflow.Workflow[] getAllWorkflows(com.bea.content.ContentContext context, String repositoryName) throws com.bea.content.RepositoryException
context
- The ContentContext objectrepositoryName
- The name of the repository.
com.bea.content.RepositoryException
- If workflows cannot be retrieved due to some other issue.com.bea.p13n.pagination.SortableFilterablePagedResult<com.bea.content.virtual.workflow.Workflow> getAllWorkflows(com.bea.content.ContentContext context, String repositoryName, int pageSize) throws com.bea.content.RepositoryException
context
- The ContentContext objectrepositoryName
- The name of the repository.pageSize
- the number of items per page in the PagedResult
com.bea.content.RepositoryException
- If there is another exception in the repository.com.bea.p13n.pagination.SortableFilterablePagedResult<com.bea.content.virtual.workflow.Workflow> getAllAssociableWorkflows(com.bea.content.ContentContext context, String repositoryName, int pageSize) throws com.bea.content.RepositoryException
context
- The ContentContext objectrepositoryName
- The name of the repository.pageSize
- the number of items per page in the PagedResult
com.bea.content.RepositoryException
- If workflows cannot be retrieved due to some other issue.com.bea.content.virtual.workflow.Workflow getWorkflow(com.bea.content.ContentContext context, com.bea.content.ID id) throws com.bea.content.NoSuchWorkflowException, com.bea.content.RepositoryException
context
- The ContentContext objectid
- The ID of the workflow
com.bea.content.NoSuchWorkflowException
- If the workflow document does not exist.
com.bea.content.RepositoryException
- If some other error happens.com.bea.content.virtual.workflow.Workflow getWorkflow(com.bea.content.ContentContext context, String repositoryName, String name) throws com.bea.content.NoSuchWorkflowException, com.bea.content.RepositoryException
context
- The ContentContext objectrepositoryName
- The name of the repositoryname
- The name of the workflow
com.bea.content.NoSuchWorkflowException
- If the workflow document does not exist.
com.bea.content.RepositoryException
- If some other error happens.com.bea.content.virtual.workflow.Workflow getDefaultWorkflow(com.bea.content.ContentContext context, String repositoryName) throws com.bea.content.RepositoryException
context
- The ContentContext objectrepositoryName
- The name of the repository
com.bea.content.RepositoryException
- If there is another exception in the repository.void setDefaultWorkflow(com.bea.content.ContentContext context, String repositoryName, byte[] data) throws com.bea.content.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
com.bea.content.RepositoryException
void save(com.bea.content.ContentContext context, com.bea.content.ID id, String name, String comment) throws com.bea.content.RepositoryException
context
- The ContentContext objectid
- The id of the workflowname
- The new name of the workflowcomment
- The new comment for the workflow.
com.bea.content.RepositoryException
- If the the update of the metadata fails for some reasonvoid save(com.bea.content.ContentContext context, com.bea.content.ID id, byte[] data) throws com.bea.content.RepositoryException
context
- The ContentContext objectid
- The ID of the workflowdata
- The data associated with the workflow
com.bea.content.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(com.bea.content.ContentContext context, com.bea.content.ID nodeId, com.bea.content.ID workflowId) throws com.bea.content.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.
com.bea.content.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(com.bea.content.ContentContext context, com.bea.content.ID typeId, com.bea.content.ID workflowId) throws com.bea.content.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.
com.bea.content.RepositoryException
- If the operation fails for some reason.com.bea.content.virtual.workflow.Workflow getWorkflowForNode(com.bea.content.ContentContext context, com.bea.content.ID nodeId) throws com.bea.content.AuthorizationException, com.bea.content.RepositoryException
context
- The ContentContext objectnodeId
- The node ID object.
com.bea.content.RepositoryException
- if the operation does not succeed.
com.bea.content.AuthorizationException
com.bea.content.virtual.workflow.Workflow getWorkflowForType(com.bea.content.ContentContext context, com.bea.content.ID typeId) throws com.bea.content.AuthorizationException, com.bea.content.RepositoryException
context
- The ContentContext objecttypeId
- The type ID object.
com.bea.content.AuthorizationException
com.bea.content.RepositoryException
com.bea.content.Node[] getNodesForWorkflow(com.bea.content.ContentContext context, com.bea.content.ID workflowId) throws com.bea.content.RepositoryException
context
- The ContentContext objectworkflowId
- The Workflow ID object
com.bea.content.RepositoryException
- If the opoeration does not succeed.com.bea.p13n.pagination.SortableFilterablePagedResult<com.bea.content.Node> getNodesForWorkflow(com.bea.content.ContentContext context, com.bea.content.ID workflowId, int pageSize) throws com.bea.content.RepositoryException
context
- The ContentContext objectworkflowId
- The Workflow ID objectpageSize
- number of items per page in the PagedResult
com.bea.content.RepositoryException
com.bea.content.ObjectClass[] getTypesForWorkflow(com.bea.content.ContentContext context, com.bea.content.ID workflowId) throws com.bea.content.RepositoryException
context
- The ContentContext objectworkflowId
- The Workflow ID object
com.bea.content.RepositoryException
- If the opoeration does not succeed.com.bea.p13n.pagination.SortableFilterablePagedResult<com.bea.content.ObjectClass> getTypesForWorkflow(com.bea.content.ContentContext context, com.bea.content.ID workflowId, int pageSize) throws com.bea.content.RepositoryException
context
- The ContentContext objectworkflowId
- The Workflow ID objectpageSize
- number of items per page in the PagedResult
com.bea.content.RepositoryException
byte[] getStream(com.bea.content.ContentContext context, com.bea.content.ID workflowId) throws com.bea.content.RepositoryException
context
- workflowId
-
com.bea.content.RepositoryException
boolean hasCreateCapability(com.bea.content.ContentContext context, String repositoryName, com.bea.content.virtual.workflow.Workflow workflow) throws com.bea.content.AuthorizationException
context
- The ContentContext objectrepositoryName
- The name of the repository.workflow
- The workflow. Null checks at the root
com.bea.content.AuthorizationException
boolean hasDeleteCapability(com.bea.content.ContentContext context, String repositoryName, com.bea.content.virtual.workflow.Workflow workflow) throws com.bea.content.AuthorizationException
context
- The ContentContext objectrepositoryName
- The name of the reposihey btory.workflow
- The workflow. Null checks at the root
com.bea.content.AuthorizationException
boolean hasViewCapability(com.bea.content.ContentContext context, String repositoryName, com.bea.content.virtual.workflow.Workflow workflow) throws com.bea.content.AuthorizationException
context
- The ContentContext objectrepositoryName
- The name of the repository.workflow
- The workflow. Null checks at the root
com.bea.content.AuthorizationException
boolean hasUpdateCapability(com.bea.content.ContentContext context, String repositoryName, com.bea.content.virtual.workflow.Workflow workflow) throws com.bea.content.AuthorizationException
context
- The ContentContext objectrepositoryName
- The name of the repository.workflow
- The workflow. Null checks at the root
com.bea.content.AuthorizationException
boolean hasAssociateCapability(com.bea.content.ContentContext context, String repositoryName, com.bea.content.virtual.workflow.Workflow workflow) throws com.bea.content.AuthorizationException
context
- The ContentContext objectrepositoryName
- The name of the repository.workflow
- The workflow. Null checks at the root
com.bea.content.AuthorizationException
List<String> getStatusOptions(com.bea.content.Node node, com.bea.content.virtual.version.Version version, com.bea.content.ContentContext contentContext) throws com.bea.content.RepositoryException
node
- version
- contentContext
-
com.bea.content.RepositoryException
Map<Integer,String> getStatusOptionsMap(com.bea.content.Node node, com.bea.content.virtual.version.Version version, com.bea.content.ContentContext contentContext) throws com.bea.content.RepositoryException
node
- version
- contentContext
-
com.bea.content.RepositoryException
com.bea.content.virtual.workflow.Workflow getWorkflowOrDefaultWorkflowForNode(com.bea.content.ContentContext contentContext, com.bea.content.Node node) throws com.bea.content.RepositoryException
contentContext
- node
-
com.bea.content.RepositoryException
|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |