Skip navigation links

com.stellent.cis.client.api.scs.workflow
Interface ISCSWorkflowAPI

All Superinterfaces:

ICommandAPI

public interface ISCSWorkflowAPI

extends ICommandAPI

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

API_CATEGORY

static final java.lang.String API_CATEGORY

Category for this Command API

See Also:

Constant Field Values

Method Detail

getObjectFactory

ICISAPIObjectFactory getObjectFactory()

Retrieve the object factory associated with this API

getActiveWorkflows

ISCSWorkflowResponse getActiveWorkflows(ISCSContext SCSContext)
                                        throws CommandException

Retrieve a list of the active workflows in the content server.

Parameters:

SCSContext - the context object representing the current user

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_ACTIVE_WORKFLOWS"

getActiveWorkflows

ISCSWorkflowResponse getActiveWorkflows(ISCSRequestModifier requestModifier,
                                        ISCSContext SCSContext)
                                        throws CommandException

Retrieve a list of the active workflows in the content server.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_ACTIVE_WORKFLOWS"

getWorkflow

ISCSWorkflowQueryResponse getWorkflow(ISCSContext SCSContext,
                                      java.lang.String workflowName)
                                      throws CommandException

Service that returns information about a specific workflow.

Parameters:

SCSContext - the context object representing the current user

workflowName - the name of the workflow

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_WORKFLOW"

getWorkflow

ISCSWorkflowQueryResponse getWorkflow(ISCSRequestModifier requestModifier,
                                      ISCSContext SCSContext,
                                      java.lang.String workflowName)
                                      throws CommandException

Service that returns information about a specific workflow.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

workflowName - the name of the workflow

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_WORKFLOW"

approveWorkflow

ISCSWorkflowApproveRejectResponse approveWorkflow(ISCSContext SCSContext,
                                                  ISCSDocumentID documentID)
                                                  throws CommandException

Approves a given workflow. Marks status as "APPROVE" for the current workflow stage.

Parameters:

SCSContext - the context object representing the current user

documentID - the document ID

Throws:

CommandException

See Also:

"Content Server Documentation for: WORKFLOW_APPROVE"

approveWorkflow

ISCSWorkflowApproveRejectResponse approveWorkflow(ISCSRequestModifier requestModifier,
                                                  ISCSContext SCSContext,
                                                  ISCSDocumentID documentID)
                                                  throws CommandException

Approves a given workflow. Marks status as "APPROVE" for the current workflow stage.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

documentID - the document ID

Throws:

CommandException

See Also:

"Content Server Documentation for: WORKFLOW_APPROVE"

cancelWorkflow

ISCSWorkflowActionResponse cancelWorkflow(ISCSContext SCSContext,
                                          java.lang.String workflowName)
                                          throws CommandException

Cancels a basic workflow.

Parameters:

SCSContext - the context object representing the current user

workflowName - the workflow name

Throws:

CommandException

See Also:

"Content Server Documentation for: WORKFLOW_CANCEL"

cancelWorkflow

ISCSWorkflowActionResponse cancelWorkflow(ISCSRequestModifier requestModifier,
                                          ISCSContext SCSContext,
                                          java.lang.String workflowName)
                                          throws CommandException

Cancels a basic workflow.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

workflowName - the workflow name

Throws:

CommandException

See Also:

"Content Server Documentation for: WORKFLOW_CANCEL"

getDocumentRevisions

ISCSWorkflowDocumentRevisionsResponse getDocumentRevisions(ISCSContext SCSContext,
                                                           java.lang.String workflowName)
                                                           throws CommandException

Returns a list of content item revisions that are in a specific workflow

Parameters:

SCSContext - the context object representing the current user

workflowName - the workflow name

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_WORKFLOWDOCREVISIONS"

getDocumentRevisions

ISCSWorkflowDocumentRevisionsResponse getDocumentRevisions(ISCSRequestModifier requestModifier,
                                                           ISCSContext SCSContext,
                                                           java.lang.String workflowName)
                                                           throws CommandException

Returns a list of content item revisions that are in a specific workflow

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

workflowName - the workflow name

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_WORKFLOWDOCREVISIONS"

getWorkflowTemplate

ISCSWorkflowTemplateResponse getWorkflowTemplate(ISCSContext SCSContext,
                                                 java.lang.String templateName)
                                                 throws CommandException

Returns the description of a specific workflow template.

Parameters:

SCSContext - the context object representing the current user

templateName - the template name

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_WF_TEMPLATE"

getWorkflowTemplate

ISCSWorkflowTemplateResponse getWorkflowTemplate(ISCSRequestModifier requestModifier,
                                                 ISCSContext SCSContext,
                                                 java.lang.String templateName)
                                                 throws CommandException

Returns the description of a specific workflow template.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

templateName - the template name

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_WF_TEMPLATE"

getWorkflowTemplates

ISCSWorkflowTemplatesResponse getWorkflowTemplates(ISCSContext SCSContext)
                                                   throws CommandException

Returns a list of all workflow templates and their descriptions.

Parameters:

SCSContext - the context object representing the current user

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_WF_TEMPLATES"

getWorkflowTemplates

ISCSWorkflowTemplatesResponse getWorkflowTemplates(ISCSRequestModifier requestModifier,
                                                   ISCSContext SCSContext)
                                                   throws CommandException

Returns a list of all workflow templates and their descriptions.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_WF_TEMPLATES"

getWorkflowDocuments

ISCSWorkflowDocumentsResponse getWorkflowDocuments(ISCSContext SCSContext,
                                                   java.lang.String workflowName)
                                                   throws CommandException

Returns a list of content item revisions that are in a specific workflow

Parameters:

SCSContext - the context object representing the current user

workflowName - the workflow name

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_WORKFLOWDOCUMENTS"

getWorkflowDocuments

ISCSWorkflowDocumentsResponse getWorkflowDocuments(ISCSRequestModifier requestModifier,
                                                   ISCSContext SCSContext,
                                                   java.lang.String workflowName)
                                                   throws CommandException

Returns a list of content item revisions that are in a specific workflow

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

workflowName - the workflow name

Throws:

CommandException

See Also:

"Content Server Documentation for: GET_WORKFLOWDOCUMENTS"

getWorkflowQueueForUser

ISCSWorkflowQueueResponse getWorkflowQueueForUser(ISCSContext SCSContext)
                                                  throws CommandException

Retrieve the workflow queue for the current user. The workflow queue is located in the IDataResultSet named "workflowInQueue" in the returned IDataBinder object.

Parameters:

SCSContext - the context object representing the current user

Throws:

CommandException

See Also:

"Content Server Documentation for: PING_SERVER"

getWorkflowQueueForUser

ISCSWorkflowQueueResponse getWorkflowQueueForUser(ISCSRequestModifier requestModifier,
                                                  ISCSContext SCSContext)
                                                  throws CommandException

Retrieve the workflow queue for the current user. The workflow queue is located in the IDataResultSet named "workflowInQueue" in the returned IDataBinder object.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

Throws:

CommandException

See Also:

"Content Server Documentation for: PING_SERVER"

rejectWorkflow

ISCSWorkflowApproveRejectResponse rejectWorkflow(ISCSContext SCSContext,
                                                 ISCSDocumentID documentID,
                                                 java.lang.String message)
                                                 throws CommandException

Reject a workflow and send an email message to the appropiate parties.

Parameters:

SCSContext - the context object representing the current user

documentID - the document ID

message - the rejection message

Throws:

CommandException

See Also:

"Content Server Documentation for: WORKFLOW_REJECT"

rejectWorkflow

ISCSWorkflowApproveRejectResponse rejectWorkflow(ISCSRequestModifier requestModifier,
                                                 ISCSContext SCSContext,
                                                 ISCSDocumentID documentID,
                                                 java.lang.String message)
                                                 throws CommandException

Reject a workflow and send an email message to the appropiate parties.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

documentID - the document ID

message - the rejection message

Throws:

CommandException

See Also:

"Content Server Documentation for: WORKFLOW_REJECT"

startWorkflow

ISCSWorkflowStartResponse startWorkflow(ISCSContext SCSContext,
                                        java.lang.String workflowName,
                                        java.lang.String securityGroup)
                                        throws CommandException

Start a basic workflow.

Parameters:

SCSContext - the context object representing the current user

workflowName - the name of the workflow

securityGroup - the security group (i.e. Public, Secure, etc.)

Throws:

CommandException

See Also:

"Content Server Documentation for: WORKFLOW_START"

startWorkflow

ISCSWorkflowStartResponse startWorkflow(ISCSRequestModifier requestModifier,
                                        ISCSContext SCSContext,
                                        java.lang.String workflowName,
                                        java.lang.String securityGroup)
                                        throws CommandException

Start a basic workflow.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

workflowName - the name of the workflow

securityGroup - the security group (i.e. Public, Secure, etc.)

Throws:

CommandException

See Also:

"Content Server Documentation for: WORKFLOW_START"

getWorkflowStepInfo

ISCSWorkflowStepInfoResponse getWorkflowStepInfo(ISCSContext SCSContext,
                                                 java.lang.String workflowName,
                                                 ISCSWorkflowStepID workflowStepID,
                                                 ISCSDocumentID documentID)
                                                 throws CommandException

Retrieve detailed information about a given workflow step.

Parameters:

SCSContext - the context object representing the current user

workflowName - the workflow name

workflowStepID - the workflow step ID

documentID - the document ID

Throws:

CommandException

See Also:

"Content Server Documentation for: "GET_WORKFLOW_INFO"

getWorkflowStepInfo

ISCSWorkflowStepInfoResponse getWorkflowStepInfo(ISCSRequestModifier requestModifier,
                                                 ISCSContext SCSContext,
                                                 java.lang.String workflowName,
                                                 ISCSWorkflowStepID workflowStepID,
                                                 ISCSDocumentID documentID)
                                                 throws CommandException

Retrieve detailed information about a given workflow step.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

workflowName - the workflow name

workflowStepID - the workflow step ID

documentID - the document ID

Throws:

CommandException

See Also:

"Content Server Documentation for: "GET_WORKFLOW_INFO"

getWorkflowStepInfoByName

ISCSWorkflowStepInfoResponse getWorkflowStepInfoByName(ISCSContext SCSContext,
                                                       java.lang.String workflowName,
                                                       java.lang.String stepName,
                                                       ISCSContentID contentID)
                                                       throws CommandException

Retrieve detailed information about a given workflow step.

Parameters:

SCSContext - the context object representing the current user

workflowName - the workflow name

stepName - the workflow step name

contentID - the content ID

Throws:

CommandException

See Also:

"Content Server Documentation for: "GET_WORKFLOW_INFO"

getWorkflowStepInfoByName

ISCSWorkflowStepInfoResponse getWorkflowStepInfoByName(ISCSRequestModifier requestModifier,
                                                       ISCSContext SCSContext,
                                                       java.lang.String workflowName,
                                                       java.lang.String stepName,
                                                       ISCSContentID contentID)
                                                       throws CommandException

Retrieve detailed information about a given workflow step.

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

workflowName - the workflow name

stepName - the workflow step name

contentID - the content ID

Throws:

CommandException

See Also:

"Content Server Documentation for: "GET_WORKFLOW_INFO"

_createWorkflow

ISCSWorkflow _createWorkflow()

Create a new workflow object.

Returns:

a new workflow object

_createWorkflowStep

ISCSWorkflowStep _createWorkflowStep()

Create a new workflow step object.

Returns:

a new workflow step object

_createWorkflowID

ISCSWorkflowID _createWorkflowID(java.lang.String workflowID)

Create a new workflow ID

Returns:

the workflow ID associated with the given workflow ID string

_createWorkflowStepID

ISCSWorkflowStepID _createWorkflowStepID(java.lang.String workflowStepID)

Create a new workflow step ID

Returns:

the workflow step ID associated with the given workflow step ID string

Skip navigation links