Interface IPdmWorkflow
Gives access to the PDM workflow.
Namespace: TopSolid.Kernel.Automating
Assembly: cs.temp.dll.dll
Syntax
[AvailableSinceVersion(7, 7, 201, 140)]
public interface IPdmWorkflowRemarks
This interface is available since v7.7.201.140.
Methods
ApproveAction(PdmMajorRevisionId, String, List<String>)
Approves the last pending workflow action of a major revision.
Declaration
[AvailableSinceVersion(7, 14, 248, 0)]
void ApproveAction(PdmMajorRevisionId inMajorRevisionId, string inComment, List<string> inEmailAddresses)Parameters
| Type | Name | Description |
|---|---|---|
| PdmMajorRevisionId | inMajorRevisionId | Major revision to approve action on. |
| System.String | inComment | Comment. |
| List<System.String> | inEmailAddresses | Additional e-mail addresses to notify. |
Remarks
This method is available since v7.14.248.000.
CancelAction(PdmMajorRevisionId)
Cancels a workflow action of a major revision.
Declaration
[AvailableSinceVersion(7, 14, 248, 0)]
void CancelAction(PdmMajorRevisionId inMajorRevisionId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmMajorRevisionId | inMajorRevisionId | Major revision to cancel action on. |
Remarks
This method is available since v7.14.248.000.
GetPendingRequests()
Gets major revision identifiers where there is a pending request to treat.
Declaration
[AvailableSinceVersion(7, 14, 248, 0)]
List<PdmMajorRevisionId> GetPendingRequests()Returns
| Type | Description |
|---|---|
| List<PdmMajorRevisionId> | Major revision identifiers where there is a pending request to treat. |
Remarks
This method is available since v7.14.248.000.
GetPossibleActions(PdmMajorRevisionId, out List<PdmObjectId>, out List<String>)
Get all workflow actions possible of a major revision.
Declaration
[AvailableSinceVersion(7, 7, 201, 140)]
void GetPossibleActions(PdmMajorRevisionId inMajorRevisionId, out List<PdmObjectId> outActionIds, out List<string> outActionNames)Parameters
| Type | Name | Description |
|---|---|---|
| PdmMajorRevisionId | inMajorRevisionId | Major revision to analyze. |
| List<PdmObjectId> | outActionIds | Workflow action identifiers. |
| List<System.String> | outActionNames | Workflow action names. |
Remarks
This method is available since v7.7.201.140.
GetWorkflowActionStates(PdmMajorRevisionId, out List<PdmObjectId>, out List<WorkflowActionState>)
Get workflow action states of given major revision corresponding to returned workflow action identifiers.
Declaration
[AvailableSinceVersion(7, 14, 248, 0)]
void GetWorkflowActionStates(PdmMajorRevisionId inMajorRevisionId, out List<PdmObjectId> outWorkflowActionIds, out List<WorkflowActionState> outWorkflowActionStates)Parameters
| Type | Name | Description |
|---|---|---|
| PdmMajorRevisionId | inMajorRevisionId | Major revision identifier. |
| List<PdmObjectId> | outWorkflowActionIds | Workflow action identifiers. |
| List<WorkflowActionState> | outWorkflowActionStates | Workflow action states. |
Remarks
This method is available since v7.14.248.000.
HasWorkflow(PdmObjectId)
Tells if a project has a workflow set.
Declaration
[AvailableSinceVersion(7, 7, 201, 140)]
bool HasWorkflow(PdmObjectId inProjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inProjectId | Project identifier to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The project has a workflow. |
Remarks
This method is available since v7.7.201.140.
RefuseAction(PdmMajorRevisionId, String, List<String>)
Refuses the last pending workflow action of a major revision.
Declaration
[AvailableSinceVersion(7, 14, 248, 0)]
void RefuseAction(PdmMajorRevisionId inMajorRevisionId, string inComment, List<string> inEmailAddresses)Parameters
| Type | Name | Description |
|---|---|---|
| PdmMajorRevisionId | inMajorRevisionId | Major revision to refuse action on. |
| System.String | inComment | Comment. |
| List<System.String> | inEmailAddresses | Additional e-mail addresses to notify. |
Remarks
This method is available since v7.14.248.000.
StartAction(PdmMajorRevisionId, PdmObjectId)
Starts a workflow action of a major revision.
Declaration
[AvailableSinceVersion(7, 7, 201, 140)]
void StartAction(PdmMajorRevisionId inMajorRevisionId, PdmObjectId inWorkflowActionId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmMajorRevisionId | inMajorRevisionId | Major revision to start action on. |
| PdmObjectId | inWorkflowActionId | Workflow action to start. |
Remarks
This method is available since v7.7.201.140.