DocumentSetService Class Reference

Provides methods for adding document, updating the document status and evaluationg document, of a document set. More...

Public Member Functions
void	AddDocument (string sessionId, JobIdentity jobIdentity, CaseIdentity caseIdentity, DocumentIdentity2 documentIdentity, bool useSource, string source, bool useStatus, short status)
	Use the AddDocument method to add a document to the document set with the status (Received, Waiting, Validated, Verified, Rejected, or Accepted) at runtime. By default, document will be added with the status 'Received'. More...
void	AddDocuments (string sessionId, JobIdentity jobIdentity, CaseIdentity caseIdentity, DocumentIdentity2Collection documentIdentityCollection, FolderIdentity folderIdentity, bool useSource, string source, bool useStatus, short status)
	Use the AddDocuments method to add documents to the document set with the status (Received, Waiting, Validated, Verified, Rejected, or Accepted) at runtime. By default, documents will be added with the status 'Received'. More...
bool	EvaluateDocumentRule (string sessionId, JobIdentity jobIdentity, CaseIdentity caseIdentity, DocumentTypeIdentity documentTypeIdentity)
	Use the EvaluateDocumentRule method to evaluate particular rule of the document set, of the jobid/case ref, with the specific document type. The rule will only consider documents that are in an Accepted state. More...
JobDocumentTypeRuleResultCollection	EvaluateDocumentSet (string sessionId, JobIdentity jobIdentity, CaseIdentity caseIdentity)
	Use the EvaluateDocumentSet method to evaluate all the rules of the document set, of the jobid/case ref. The rule will only consider documents that are in an Accepted state. More...
void	UpdateDocumentStatus (string sessionId, JobIdentity jobIdentity, CaseIdentity caseIdentity, DocumentIdentity2Collection documentIdentityCollection, FolderIdentity folderIdentity, DocumentTypeIdentity documentTypeIdentity, short status)
	Use the UpdateDocumentStatus method to update the state of documents in a document set at runtime. More...

Description

Provides methods for adding document, updating the document status and evaluationg document, of a document set.

Member Functions

void AddDocument	(	string	sessionId,
		JobIdentity	jobIdentity,
		CaseIdentity	caseIdentity,
		DocumentIdentity2	documentIdentity,
		bool	useSource,
		string	source,
		bool	useStatus,
		short	status
	)

Use the AddDocument method to add a document to the document set with the status (Received, Waiting, Validated, Verified, Rejected, or Accepted) at runtime. By default, document will be added with the status 'Received'.

Parameters

sessionId	A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
jobIdentity	A JobIdentity identity object that is used to identify the job whose properties are to be retrieved. Name Type Comment Required Id String The job id Yes
caseIdentity	A CaseIdentity identity object that is used to identify the case in which the fragment instance should be created. Name Type Comment Required CaseId String The case id (i.e. job id) of the associated case Yes/No. Either CaseId or CaseReference needs to be supplied CaseReference String The case reference of the associated case Yes/No. Either CaseId or CaseReference needs to be supplied
documentIdentity	A DocumentIdentity2 object. Specify the ID of the document associated with the above job ID. If document ID is invalid or not passed, an exception will be raised. Name Type Comment Required DocumentId String The Document ID Yes
useSource	If set to true, the source specified will be set for the document.
source	Specifies the source of the document added to the document set.
useStatus	If set to true, the status specified will be set for the document.
status	The possible status can be: Enumeration Status 0 Received 1 Waiting 2 Validated. 3 Verified. 4 Rejected. 5 Accepted.

Security

No restrictions apply.

void AddDocuments	(	string	sessionId,
		JobIdentity	jobIdentity,
		CaseIdentity	caseIdentity,
		DocumentIdentity2Collection	documentIdentityCollection,
		FolderIdentity	folderIdentity,
		bool	useSource,
		string	source,
		bool	useStatus,
		short	status
	)

Use the AddDocuments method to add documents to the document set with the status (Received, Waiting, Validated, Verified, Rejected, or Accepted) at runtime. By default, documents will be added with the status 'Received'.

Parameters

sessionId	A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
jobIdentity	A JobIdentity identity object that is used to identify the job whose properties are to be retrieved. Name Type Comment Required Id String The job id Yes
caseIdentity	A CaseIdentity identity object that is used to identify the case in which the fragment instance should be created. Name Type Comment Required CaseId String The case id (i.e. job id) of the associated case Yes/No. Either CaseId or CaseReference needs to be supplied CaseReference String The case reference of the associated case Yes/No. Either CaseId or CaseReference needs to be supplied
documentIdentityCollection	A DocumentIdentity2Collection object. Specify the IDs of the documents associated with the above job ID. If document ID is invalid, an exception will be raised. documentIdentityCollection or folderIdentity can be passed. If both are passed, documentIdentitycollection is taken as priority. Name Type Comment Required DocumentId String The Document ID Yes
folderIdentity	A FolderIdentity object. Specify the folder ID to add all the documents of the folder to the document set. Name Type Comment Required FolderId String The Document ID Yes
useSource	If set to true, the source specified will be set for the document.
source	Specifies the source of the document added to the document set.
useStatus	If set to true, the status specified will be set for the document.
status	The possible status can be: Enumeration Status 0 Received 1 Waiting 2 Validated. 3 Verified. 4 Rejected. 5 Accepted.

Security

No restrictions apply.

bool EvaluateDocumentRule	(	string	sessionId,
		JobIdentity	jobIdentity,
		CaseIdentity	caseIdentity,
		DocumentTypeIdentity	documentTypeIdentity
	)

Use the EvaluateDocumentRule method to evaluate particular rule of the document set, of the jobid/case ref, with the specific document type. The rule will only consider documents that are in an Accepted state.

Parameters

sessionId	A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
jobIdentity	A JobIdentity identity object that is used to identify the job whose properties are to be retrieved. Name Type Comment Required Id String The job id Yes
caseIdentity	A CaseIdentity identity object that is used to identify the case in which the fragment instance should be created. Name Type Comment Required CaseId String The case id (i.e. job id) of the associated case Yes/No. Either CaseId or CaseReference needs to be supplied CaseReference String The case reference of the associated case Yes/No. Either CaseId or CaseReference needs to be supplied
documentTypeIdentity	A DocumentTypeIdentity object. Specify the documentTypeIdentity to update documents of a specific document type in the document set. Name Type Comment Required Id String The Document ID Yes Version Double Version Number of document No Name String Name of Document Yes

Returns

returns True if the document passing validation rule otherwise it will return false.

Security

No restrictions apply.

JobDocumentTypeRuleResultCollection EvaluateDocumentSet	(	string	sessionId,
		JobIdentity	jobIdentity,
		CaseIdentity	caseIdentity
	)

Use the EvaluateDocumentSet method to evaluate all the rules of the document set, of the jobid/case ref. The rule will only consider documents that are in an Accepted state.

Parameters

sessionId	A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
jobIdentity	A JobIdentity identity object that is used to identify the job whose properties are to be retrieved. Name Type Comment Required Id String The job id Yes
caseIdentity	A CaseIdentity identity object that is used to identify the case in which the fragment instance should be created. Name Type Comment Required CaseId String The case id (i.e. job id) of the associated case Yes/No. Either CaseId or CaseReference needs to be supplied CaseReference String The case reference of the associated case Yes/No. Either CaseId or CaseReference needs to be supplied

Returns

A JobDocumentTypeRuleResultCollection This will rerun all document rules and retrun true if all rules pass otherwise it will return false.

Name	Type	Comment	Required
DocumentTypeID	String	The Id Of the document Type	Yes/No
Result	Boolean	All rules passed for document set?	Yes/No

Security

No restrictions apply.

void UpdateDocumentStatus	(	string	sessionId,
		JobIdentity	jobIdentity,
		CaseIdentity	caseIdentity,
		DocumentIdentity2Collection	documentIdentityCollection,
		FolderIdentity	folderIdentity,
		DocumentTypeIdentity	documentTypeIdentity,
		short	status
	)

Use the UpdateDocumentStatus method to update the state of documents in a document set at runtime.

Parameters

sessionId	A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised.
jobIdentity	A JobIdentity identity object that is used to identify the job whose properties are to be retrieved. Name Type Comment Required Id String The job id Yes
caseIdentity	A CaseIdentity identity object that is used to identify the case in which the fragment instance should be created. Name Type Comment Required CaseId String The case id (i.e. job id) of the associated case Yes/No. Either CaseId or CaseReference needs to be supplied CaseReference String The case reference of the associated case Yes/No. Either CaseId or CaseReference needs to be supplied
documentIdentityCollection	A DocumentIdentity2Collection object. Specify the IDs of the documents associated with the above job ID. If document ID is invalid, an exception will be raised. documentIdentityCollection or folderIdentity can be passed. If both are passed, documentIdentitycollection is taken as priority. Name Type Comment Required DocumentId String The Document ID Yes
folderIdentity	A FolderIdentity object. Specify the folder ID to add all the documents of the folder to the document set. Name Type Comment Required FolderId String The Document ID Yes
documentTypeIdentity	A DocumentTypeIdentity object. Specify the documentTypeIdentity to update documents of a specific document type in the document set. Name Type Comment Required Id String The Document ID Yes Version Double Version Number of document No Name String Name of Document Yes
status	The possible status can be: Enumeration Status 0 Received 1 Waiting 2 Validated. 3 Verified. 4 Rejected. 5 Accepted.

Security

No restrictions apply.