IEDMS_TaskService interface

No description yet.

public interface IEDMS_TaskService

Namespace: DXP · Assembly: Altium.SDK.Interfaces

Methods

Method	Returns	Description
AddAssignmentRule	bool
AddAssignmentRules	bool
AddComment	bool
AddTask	bool
AddTaskBase	bool
AddTaskBaseExt	bool
ApproveTask	bool
CancelTask	bool
CreateSearchParams	IEDMS_TaskSearchParams
CreateTaskBase	IEDMS_TaskBase
DeleteAssignmentRule	bool
DeleteAssignmentRules	bool
GetAllowedAssigns	bool
GetAssignmentRules	bool
GetAttachmentsList	bool
GetBeginUploadAttachmentURL	string
GetCustomStates	bool
GetDownloadAttachmentURL	string
GetLifecycleTasks	bool
GetPartRequestTasks	bool
GetPossibleActions	bool
GetTaskStream	bool
GetUploadAttachmentURL	string
LifecycleTasksIsExists	bool
RejectTask	bool
SetCustomStates	bool
UpdateAssignmentRule	bool
UpdateAssignmentRules	bool
UpdateTaskBase	bool
UpdateTaskBaseExt	bool

AddAssignmentRule

No description yet.

bool AddAssignmentRule(IEDMS_TaskAssignmentRule argRule, out string argErrorMsg);
bool AddAssignmentRule(object argRule, out string argErrorMsg);

Parameter	Type	Passing
argRule	IEDMS_TaskAssignmentRule	value
argErrorMsg	string	out

Returns: bool

The first overload is an extension method of IEDMS_TaskServiceHelper (using DXP;) with typed parameters; the second is declared by the interface.

AddAssignmentRules

No description yet.

bool AddAssignmentRules(IEDMS_TaskAssignmentRuleList argRules, out string argErrorMsg);
bool AddAssignmentRules(object argRules, out string argErrorMsg);

Parameter	Type	Passing
argRules	IEDMS_TaskAssignmentRuleList	value
argErrorMsg	string	out

Returns: bool

The first overload is an extension method of IEDMS_TaskServiceHelper (using DXP;) with typed parameters; the second is declared by the interface.

AddComment

No description yet.

bool AddComment(string argTaskGUID, string argMessage, out string argErrorMsg);

Parameter	Type	Passing
argTaskGUID	string	value
argMessage	string	value
argErrorMsg	string	out

Returns: bool

AddTask

No description yet.

bool AddTask(string argRevisionGUID, string argTransitionGuid, string argDescription, out string argErrorMsg);

Parameter	Type	Passing
argRevisionGUID	string	value
argTransitionGuid	string	value
argDescription	string	value
argErrorMsg	string	out

Returns: bool

AddTaskBase

No description yet.

bool AddTaskBase(IEDMS_TaskBase argTaskBase, out string argErrorMsg);
bool AddTaskBase(object argTaskBase, out string argErrorMsg);

Parameter	Type	Passing
argTaskBase	IEDMS_TaskBase	value
argErrorMsg	string	out

Returns: bool

The first overload is an extension method of IEDMS_TaskServiceHelper (using DXP;) with typed parameters; the second is declared by the interface.

AddTaskBaseExt

No description yet.

bool AddTaskBaseExt(IEDMS_TaskBase argTaskBaseSource, out IEDMS_TaskExt argTaskBaseExtResult, out string argErrorMsg);
bool AddTaskBaseExt(object argTaskBaseSource, out IEDMS_TaskExt argTaskBaseExtResult, out string argErrorMsg);

Parameter	Type	Passing
argTaskBaseSource	IEDMS_TaskBase	value
argTaskBaseExtResult	IEDMS_TaskExt	out
argErrorMsg	string	out

Returns: bool

The first overload is an extension method of IEDMS_TaskServiceHelper (using DXP;) with typed parameters; the second is declared by the interface.

ApproveTask

No description yet.

bool ApproveTask(string argTaskGUID, string argDescription, out string argErrorMsg);

Parameter	Type	Passing
argTaskGUID	string	value
argDescription	string	value
argErrorMsg	string	out

Returns: bool

CancelTask

No description yet.

bool CancelTask(string argTaskGUID, string argDescription, out string argErrorMsg);

Parameter	Type	Passing
argTaskGUID	string	value
argDescription	string	value
argErrorMsg	string	out

Returns: bool

CreateSearchParams

No description yet.

IEDMS_TaskSearchParams CreateSearchParams();

Returns: IEDMS_TaskSearchParams

Extension method of IEDMS_TaskServiceHelper (using DXP;).

Examples: Extension_PartRequest

CreateTaskBase

No description yet.

IEDMS_TaskBase CreateTaskBase();

Returns: IEDMS_TaskBase

Extension method of IEDMS_TaskServiceHelper (using DXP;).

DeleteAssignmentRule

No description yet.

bool DeleteAssignmentRule(string argRuleGUID, out string argErrorMsg);

Parameter	Type	Passing
argRuleGUID	string	value
argErrorMsg	string	out

Returns: bool

DeleteAssignmentRules

No description yet.

bool DeleteAssignmentRules(string argRulesGUIDs, out string argErrorMsg);

Parameter	Type	Passing
argRulesGUIDs	string	value
argErrorMsg	string	out

Returns: bool

GetAllowedAssigns

No description yet.

bool GetAllowedAssigns(string argTaskGUID, TTaskType argTaskType, out IEDMS_TaskAllowedAssigns argAllowedAssigns, out string argErrorMsg);
bool GetAllowedAssigns(string argTaskGUID, int argTaskType, out IEDMS_TaskAllowedAssigns argAllowedAssigns, out string argErrorMsg);

Parameter	Type	Passing
argTaskGUID	string	value
argTaskType	TTaskType	value
argAllowedAssigns	IEDMS_TaskAllowedAssigns	out
argErrorMsg	string	out

Returns: bool

The first overload is an extension method of IEDMS_TaskServiceHelper (using DXP;) with typed parameters; the second is declared by the interface.

GetAssignmentRules

No description yet.

bool GetAssignmentRules(TTaskType argTaskType, string argObjectGUID, out IEDMS_TaskAssignmentRuleList argRules, out string argErrorMsg);
bool GetAssignmentRules(int argTaskType, string argObjectGUID, out IEDMS_TaskAssignmentRuleList argRules, out string argErrorMsg);

Parameter	Type	Passing
argTaskType	TTaskType	value
argObjectGUID	string	value
argRules	IEDMS_TaskAssignmentRuleList	out
argErrorMsg	string	out

Returns: bool

The first overload is an extension method of IEDMS_TaskServiceHelper (using DXP;) with typed parameters; the second is declared by the interface.

GetAttachmentsList

No description yet.

bool GetAttachmentsList(string argTaskGUID, out IEDMS_DictionaryWideString argFileList, out string argErrorMsg);

Parameter	Type	Passing
argTaskGUID	string	value
argFileList	IEDMS_DictionaryWideString	out
argErrorMsg	string	out

Returns: bool

GetBeginUploadAttachmentURL

No description yet.

string GetBeginUploadAttachmentURL();

Returns: string

GetCustomStates

No description yet.

bool GetCustomStates(out IEDMS_TaskStateList argTaskStateList, out string argErrorMsg);

Parameter	Type	Passing
argTaskStateList	IEDMS_TaskStateList	out
argErrorMsg	string	out

Returns: bool

GetDownloadAttachmentURL

No description yet.

string GetDownloadAttachmentURL(string argAtachGuid);

Parameter	Type	Passing
argAtachGuid	string	value

Returns: string

GetLifecycleTasks

No description yet.

bool GetLifecycleTasks(out IInterfaceList argTasksItemExtList, out string argErrorMsg, ref IEDMS_TaskSearchParams argSearchParams, bool argIncludeStream);
bool GetLifecycleTasks(out IInterfaceList argTasksItemExtList, out string argErrorMsg, ref object argSearchParams, bool argIncludeStream);

Parameter	Type	Passing
argTasksItemExtList	IInterfaceList	out
argErrorMsg	string	out
argSearchParams	IEDMS_TaskSearchParams	ref
argIncludeStream	bool	value

Returns: bool

The first overload is an extension method of IEDMS_TaskServiceHelper (using DXP;) with typed parameters; the second is declared by the interface.

GetPartRequestTasks

No description yet.

bool GetPartRequestTasks(out IInterfaceList argTasksItemExtList, out string argErrorMsg, ref IEDMS_TaskSearchParams argSearchParams);
bool GetPartRequestTasks(out IInterfaceList argTasksItemExtList, out string argErrorMsg, ref object argSearchParams);

Parameter	Type	Passing
argTasksItemExtList	IInterfaceList	out
argErrorMsg	string	out
argSearchParams	IEDMS_TaskSearchParams	ref

Returns: bool

The first overload is an extension method of IEDMS_TaskServiceHelper (using DXP;) with typed parameters; the second is declared by the interface.

Examples: Extension_PartRequest

GetPossibleActions

No description yet.

bool GetPossibleActions(string argObjectGUID, TTaskType argTaskType, out IEDMS_TaskUserActionList argTaskUserActionList, out string argErrorMsg);
bool GetPossibleActions(string argObjectGUID, int argTaskType, out IEDMS_TaskUserActionList argTaskUserActionList, out string argErrorMsg);

Parameter	Type	Passing
argObjectGUID	string	value
argTaskType	TTaskType	value
argTaskUserActionList	IEDMS_TaskUserActionList	out
argErrorMsg	string	out

Returns: bool

The first overload is an extension method of IEDMS_TaskServiceHelper (using DXP;) with typed parameters; the second is declared by the interface.

GetTaskStream

No description yet.

bool GetTaskStream(string argTaskGUID, out IEDMS_TaskStreamList argTaskStreamList, out string argErrorMsg);

Parameter	Type	Passing
argTaskGUID	string	value
argTaskStreamList	IEDMS_TaskStreamList	out
argErrorMsg	string	out

Returns: bool

GetUploadAttachmentURL

No description yet.

string GetUploadAttachmentURL();

Returns: string

LifecycleTasksIsExists

No description yet.

bool LifecycleTasksIsExists(out string argErrorMsg, out int argTasksCount);

Parameter	Type	Passing
argErrorMsg	string	out
argTasksCount	int	out

Returns: bool

RejectTask

No description yet.

bool RejectTask(string argTaskGUID, string argDescription, out string argErrorMsg);

Parameter	Type	Passing
argTaskGUID	string	value
argDescription	string	value
argErrorMsg	string	out

Returns: bool

SetCustomStates

No description yet.

bool SetCustomStates(IEDMS_TaskStateList argCustomStates, out string argErrorMsg);
bool SetCustomStates(object argCustomStates, out string argErrorMsg);

Parameter	Type	Passing
argCustomStates	IEDMS_TaskStateList	value
argErrorMsg	string	out

Returns: bool

The first overload is an extension method of IEDMS_TaskServiceHelper (using DXP;) with typed parameters; the second is declared by the interface.

UpdateAssignmentRule

No description yet.

bool UpdateAssignmentRule(IEDMS_TaskAssignmentRule argRule, out string argErrorMsg);
bool UpdateAssignmentRule(object argRule, out string argErrorMsg);

Parameter	Type	Passing
argRule	IEDMS_TaskAssignmentRule	value
argErrorMsg	string	out

Returns: bool

The first overload is an extension method of IEDMS_TaskServiceHelper (using DXP;) with typed parameters; the second is declared by the interface.

UpdateAssignmentRules

No description yet.

bool UpdateAssignmentRules(IEDMS_TaskAssignmentRuleList argRules, out string argErrorMsg);
bool UpdateAssignmentRules(object argRules, out string argErrorMsg);

Parameter	Type	Passing
argRules	IEDMS_TaskAssignmentRuleList	value
argErrorMsg	string	out

Returns: bool

The first overload is an extension method of IEDMS_TaskServiceHelper (using DXP;) with typed parameters; the second is declared by the interface.

UpdateTaskBase

No description yet.

bool UpdateTaskBase(IEDMS_TaskBase argTaskBase, out string argErrorMsg);
bool UpdateTaskBase(object argTaskBase, out string argErrorMsg);

Parameter	Type	Passing
argTaskBase	IEDMS_TaskBase	value
argErrorMsg	string	out

Returns: bool

The first overload is an extension method of IEDMS_TaskServiceHelper (using DXP;) with typed parameters; the second is declared by the interface.

UpdateTaskBaseExt

No description yet.

bool UpdateTaskBaseExt(IEDMS_TaskBase argTaskBaseSource, out IEDMS_TaskExt argTaskBaseExtResult, out string argErrorMsg);
bool UpdateTaskBaseExt(object argTaskBaseSource, out IEDMS_TaskExt argTaskBaseExtResult, out string argErrorMsg);

Parameter	Type	Passing
argTaskBaseSource	IEDMS_TaskBase	value
argTaskBaseExtResult	IEDMS_TaskExt	out
argErrorMsg	string	out

Returns: bool

The first overload is an extension method of IEDMS_TaskServiceHelper (using DXP;) with typed parameters; the second is declared by the interface.

Returned by

IEDMS_DXPServerManager.GetTaskService

Examples

Used in the SDK examples: Extension_PartRequest.