|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ISCSWorkflowAPI
The command API implementation of the workflow commands.
This implementation can be accessed directly via the ICommandFacade
class, using the API
name workflow, with the following syntax:
ISCSWorkflowAPI commandAPI = (ISCSWorkflowAPI)m_commandFacade.getCommandAPI ("workflow", m_commandFacade.getCommandTypeForName ("active"));
Field Summary | |
---|---|
static java.lang.String |
API_CATEGORY
Category for this Command API |
Method Summary | |
---|---|
ISCSWorkflow |
_createWorkflow()
Create a new workflow object. |
ISCSWorkflowID |
_createWorkflowID(java.lang.String workflowID)
Create a new workflow ID |
ISCSWorkflowStep |
_createWorkflowStep()
Create a new workflow step object. |
ISCSWorkflowStepID |
_createWorkflowStepID(java.lang.String workflowStepID)
Create a new workflow step ID |
ISCSWorkflowApproveRejectResponse |
approveWorkflow(ISCSContext SCSContext,
ISCSDocumentID documentID)
Approves a given workflow. |
ISCSWorkflowApproveRejectResponse |
approveWorkflow(ISCSRequestModifier requestModifier,
ISCSContext SCSContext,
ISCSDocumentID documentID)
Approves a given workflow. |
ISCSWorkflowActionResponse |
cancelWorkflow(ISCSContext SCSContext,
java.lang.String workflowName)
Cancels a basic workflow. |
ISCSWorkflowActionResponse |
cancelWorkflow(ISCSRequestModifier requestModifier,
ISCSContext SCSContext,
java.lang.String workflowName)
Cancels a basic workflow. |
ISCSWorkflowResponse |
getActiveWorkflows(ISCSContext SCSContext)
Retrieve a list of the active workflows in the content server. |
ISCSWorkflowResponse |
getActiveWorkflows(ISCSRequestModifier requestModifier,
ISCSContext SCSContext)
Retrieve a list of the active workflows in the content server. |
ISCSWorkflowDocumentRevisionsResponse |
getDocumentRevisions(ISCSContext SCSContext,
java.lang.String workflowName)
Returns a list of content item revisions that are in a specific workflow |
ISCSWorkflowDocumentRevisionsResponse |
getDocumentRevisions(ISCSRequestModifier requestModifier,
ISCSContext SCSContext,
java.lang.String workflowName)
Returns a list of content item revisions that are in a specific workflow |
ICISAPIObjectFactory |
getObjectFactory()
Retrieve the object factory associated with this API |
ISCSWorkflowQueryResponse |
getWorkflow(ISCSContext SCSContext,
java.lang.String workflowName)
Service that returns information about a specific workflow. |
ISCSWorkflowQueryResponse |
getWorkflow(ISCSRequestModifier requestModifier,
ISCSContext SCSContext,
java.lang.String workflowName)
Service that returns information about a specific workflow. |
ISCSWorkflowDocumentsResponse |
getWorkflowDocuments(ISCSContext SCSContext,
java.lang.String workflowName)
Returns a list of content item revisions that are in a specific workflow |
ISCSWorkflowDocumentsResponse |
getWorkflowDocuments(ISCSRequestModifier requestModifier,
ISCSContext SCSContext,
java.lang.String workflowName)
Returns a list of content item revisions that are in a specific workflow |
ISCSWorkflowQueueResponse |
getWorkflowQueueForUser(ISCSContext SCSContext)
Retrieve the workflow queue for the current user. |
ISCSWorkflowQueueResponse |
getWorkflowQueueForUser(ISCSRequestModifier requestModifier,
ISCSContext SCSContext)
Retrieve the workflow queue for the current user. |
ISCSWorkflowStepInfoResponse |
getWorkflowStepInfo(ISCSContext SCSContext,
java.lang.String workflowName,
ISCSWorkflowStepID workflowStepID,
ISCSDocumentID documentID)
Retrieve detailed information about a given workflow step. |
ISCSWorkflowStepInfoResponse |
getWorkflowStepInfo(ISCSRequestModifier requestModifier,
ISCSContext SCSContext,
java.lang.String workflowName,
ISCSWorkflowStepID workflowStepID,
ISCSDocumentID documentID)
Retrieve detailed information about a given workflow step. |
ISCSWorkflowStepInfoResponse |
getWorkflowStepInfoByName(ISCSContext SCSContext,
java.lang.String workflowName,
java.lang.String stepName,
ISCSContentID contentID)
Retrieve detailed information about a given workflow step. |
ISCSWorkflowStepInfoResponse |
getWorkflowStepInfoByName(ISCSRequestModifier requestModifier,
ISCSContext SCSContext,
java.lang.String workflowName,
java.lang.String stepName,
ISCSContentID contentID)
Retrieve detailed information about a given workflow step. |
ISCSWorkflowTemplateResponse |
getWorkflowTemplate(ISCSContext SCSContext,
java.lang.String templateName)
Returns the description of a specific workflow template. |
ISCSWorkflowTemplateResponse |
getWorkflowTemplate(ISCSRequestModifier requestModifier,
ISCSContext SCSContext,
java.lang.String templateName)
Returns the description of a specific workflow template. |
ISCSWorkflowTemplatesResponse |
getWorkflowTemplates(ISCSContext SCSContext)
Returns a list of all workflow templates and their descriptions. |
ISCSWorkflowTemplatesResponse |
getWorkflowTemplates(ISCSRequestModifier requestModifier,
ISCSContext SCSContext)
Returns a list of all workflow templates and their descriptions. |
ISCSWorkflowApproveRejectResponse |
rejectWorkflow(ISCSContext SCSContext,
ISCSDocumentID documentID,
java.lang.String message)
Reject a workflow and send an email message to the appropiate parties. |
ISCSWorkflowApproveRejectResponse |
rejectWorkflow(ISCSRequestModifier requestModifier,
ISCSContext SCSContext,
ISCSDocumentID documentID,
java.lang.String message)
Reject a workflow and send an email message to the appropiate parties. |
ISCSWorkflowStartResponse |
startWorkflow(ISCSContext SCSContext,
java.lang.String workflowName,
java.lang.String securityGroup)
Start a basic workflow. |
ISCSWorkflowStartResponse |
startWorkflow(ISCSRequestModifier requestModifier,
ISCSContext SCSContext,
java.lang.String workflowName,
java.lang.String securityGroup)
Start a basic workflow. |
Field Detail |
---|
static final java.lang.String API_CATEGORY
Method Detail |
---|
ICISAPIObjectFactory getObjectFactory()
ISCSWorkflowResponse getActiveWorkflows(ISCSContext SCSContext) throws CommandException
SCSContext
- the context object representing the current user
CommandException
ISCSWorkflowResponse getActiveWorkflows(ISCSRequestModifier requestModifier, ISCSContext SCSContext) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current user
CommandException
ISCSWorkflowQueryResponse getWorkflow(ISCSContext SCSContext, java.lang.String workflowName) throws CommandException
SCSContext
- the context object representing the current userworkflowName
- the name of the workflow
CommandException
ISCSWorkflowQueryResponse getWorkflow(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String workflowName) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current userworkflowName
- the name of the workflow
CommandException
ISCSWorkflowApproveRejectResponse approveWorkflow(ISCSContext SCSContext, ISCSDocumentID documentID) throws CommandException
SCSContext
- the context object representing the current userdocumentID
- the document ID
CommandException
ISCSWorkflowApproveRejectResponse approveWorkflow(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSDocumentID documentID) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current userdocumentID
- the document ID
CommandException
ISCSWorkflowActionResponse cancelWorkflow(ISCSContext SCSContext, java.lang.String workflowName) throws CommandException
SCSContext
- the context object representing the current userworkflowName
- the workflow name
CommandException
ISCSWorkflowActionResponse cancelWorkflow(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String workflowName) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current userworkflowName
- the workflow name
CommandException
ISCSWorkflowDocumentRevisionsResponse getDocumentRevisions(ISCSContext SCSContext, java.lang.String workflowName) throws CommandException
SCSContext
- the context object representing the current userworkflowName
- the workflow name
CommandException
ISCSWorkflowDocumentRevisionsResponse getDocumentRevisions(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String workflowName) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current userworkflowName
- the workflow name
CommandException
ISCSWorkflowTemplateResponse getWorkflowTemplate(ISCSContext SCSContext, java.lang.String templateName) throws CommandException
SCSContext
- the context object representing the current usertemplateName
- the template name
CommandException
ISCSWorkflowTemplateResponse getWorkflowTemplate(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String templateName) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current usertemplateName
- the template name
CommandException
ISCSWorkflowTemplatesResponse getWorkflowTemplates(ISCSContext SCSContext) throws CommandException
SCSContext
- the context object representing the current user
CommandException
ISCSWorkflowTemplatesResponse getWorkflowTemplates(ISCSRequestModifier requestModifier, ISCSContext SCSContext) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current user
CommandException
ISCSWorkflowDocumentsResponse getWorkflowDocuments(ISCSContext SCSContext, java.lang.String workflowName) throws CommandException
SCSContext
- the context object representing the current userworkflowName
- the workflow name
CommandException
ISCSWorkflowDocumentsResponse getWorkflowDocuments(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String workflowName) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current userworkflowName
- the workflow name
CommandException
ISCSWorkflowQueueResponse getWorkflowQueueForUser(ISCSContext SCSContext) throws CommandException
IDataResultSet
named "workflowInQueue" in the returned IDataBinder
object.
SCSContext
- the context object representing the current user
CommandException
ISCSWorkflowQueueResponse getWorkflowQueueForUser(ISCSRequestModifier requestModifier, ISCSContext SCSContext) throws CommandException
IDataResultSet
named "workflowInQueue" in the returned IDataBinder
object.
requestModifier
- modify the requestSCSContext
- the context object representing the current user
CommandException
ISCSWorkflowApproveRejectResponse rejectWorkflow(ISCSContext SCSContext, ISCSDocumentID documentID, java.lang.String message) throws CommandException
SCSContext
- the context object representing the current userdocumentID
- the document IDmessage
- the rejection message
CommandException
ISCSWorkflowApproveRejectResponse rejectWorkflow(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSDocumentID documentID, java.lang.String message) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current userdocumentID
- the document IDmessage
- the rejection message
CommandException
ISCSWorkflowStartResponse startWorkflow(ISCSContext SCSContext, java.lang.String workflowName, java.lang.String securityGroup) throws CommandException
SCSContext
- the context object representing the current userworkflowName
- the name of the workflowsecurityGroup
- the security group (i.e. Public, Secure, etc.)
CommandException
ISCSWorkflowStartResponse startWorkflow(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String workflowName, java.lang.String securityGroup) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current userworkflowName
- the name of the workflowsecurityGroup
- the security group (i.e. Public, Secure, etc.)
CommandException
ISCSWorkflowStepInfoResponse getWorkflowStepInfo(ISCSContext SCSContext, java.lang.String workflowName, ISCSWorkflowStepID workflowStepID, ISCSDocumentID documentID) throws CommandException
SCSContext
- the context object representing the current userworkflowName
- the workflow nameworkflowStepID
- the workflow step IDdocumentID
- the document ID
CommandException
ISCSWorkflowStepInfoResponse getWorkflowStepInfo(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String workflowName, ISCSWorkflowStepID workflowStepID, ISCSDocumentID documentID) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current userworkflowName
- the workflow nameworkflowStepID
- the workflow step IDdocumentID
- the document ID
CommandException
ISCSWorkflowStepInfoResponse getWorkflowStepInfoByName(ISCSContext SCSContext, java.lang.String workflowName, java.lang.String stepName, ISCSContentID contentID) throws CommandException
SCSContext
- the context object representing the current userworkflowName
- the workflow namestepName
- the workflow step namecontentID
- the content ID
CommandException
ISCSWorkflowStepInfoResponse getWorkflowStepInfoByName(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String workflowName, java.lang.String stepName, ISCSContentID contentID) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current userworkflowName
- the workflow namestepName
- the workflow step namecontentID
- the content ID
CommandException
ISCSWorkflow _createWorkflow()
ISCSWorkflowStep _createWorkflowStep()
ISCSWorkflowID _createWorkflowID(java.lang.String workflowID)
ISCSWorkflowStepID _createWorkflowStepID(java.lang.String workflowStepID)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |