DocumentTypeVariantService Class Reference

Provides methods to manage Document Variants and Activity Variants. More...

Public Member Functions
ActivityVariantIdentity	AddActivityVariant (string sessionId, string documentTypeId, string documentVariantName, string activityVariantName, VariantFieldSummaryCollection variantFields)
	Creates a new activity variant for the specified document variant. More...
VariantIdentity	AddDocumentTypeVariant (string sessionId, string documentTypeId, string documentVariantName, string description, DateTime?validFrom, VariantFieldSummaryCollection variantFields)
	Creates a new document variant for the specified document type. More...
void	DeleteActivityVariant (string sessionId, string documentTypeId, string documentVariantName, string activityVariantName)
	Deletes an activity variant from the specified document variant. More...
void	DeleteDocumentTypeVariant (string sessionId, string documentTypeId, string documentVariantName, double version)
	Deletes a document variant from the specified document type. More...
ActivityVariantInfo	GetActivityVariant (string sessionId, string documentTypeId, string documentVariantName, string activityVariantName)
	Gets an Activity Variant. This returns all variant fields, indicating any that are hidden. More...
VariantFieldIdentityCollection	GetDocumentTypeFields (string sessionId, string docTypeId)
	Gets the available document type fields for a document type. More...
DocumentVariantInfo	GetDocumentTypeVariant (string sessionId, string documentTypeId, string documentVariantName)
	Gets a document variant. This returns all variant fields, indicating any that are hidden. More...
VariantFieldIdentityCollection	GetVisibleDocumentTypeFieldsForVariant (string sessionId, string docTypeId, string documentVariantName, double variantVersion)
	Gets the available document type fields for variant. More...
void	UpdateActivityVariant (string sessionId, string documentTypeId, string documentVariantName, string activityVariantName, string newActivityVariantName, VariantFieldSummaryCollection variantFields)
	Updates one or more activity variants for the specified document type. More...
void	UpdateDocumentTypeVariant (string sessionId, string documentTypeId, string documentVariantName, string newDocumentVariantName, string description, DateTime?validFrom, VariantFieldSummaryCollection variantFields)
	Updates one or more document variants for the specified document type. More...

Description

Provides methods to manage Document Variants and Activity Variants.

Member Functions

ActivityVariantIdentity AddActivityVariant	(	string	sessionId,
		string	documentTypeId,
		string	documentVariantName,
		string	activityVariantName,
		VariantFieldSummaryCollection	variantFields
	)

Creates a new activity variant for the specified document variant.

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.
documentTypeId	Id of the document type that we create the variant for. Cannot be null.
documentVariantName	The name of the document variant. Cannot be null.
activityVariantName	The name of the activity variant. Cannot be null.
variantFields	A VariantFieldIdentityCollection object. Specifies the Names of the document fields that are ignored by this activity variant. An exception will be raised if this is null. Name Type Comment Required Name String Contains the name of field Yes Ignored Boolean Indicates weather we should ignore field Yes

Returns

Returns a ActivityVariantIdentity object which contains a unique identifier for the newly created activity variant

Security

Resource must have at least Read Write access permission on CaptureDesign ACL.

VariantIdentity AddDocumentTypeVariant	(	string	sessionId,
		string	documentTypeId,
		string	documentVariantName,
		string	description,
		DateTime?	validFrom,
		VariantFieldSummaryCollection	variantFields
	)

Creates a new document variant for the specified document type.

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.
documentTypeId	Id of the document type that we create the variant for. Cannot be null.
documentVariantName	The name of the document variant. Cannot be null.
description	The Variant Description. This is optional and can be null.
validFrom	The date upon which the variant will become active. If set to null, the variant is immediately active.
variantFields	A VariantFieldIdentityCollection object. Specifies the Names of the document fields that are ignored by this document variant. An exception will be raised if this is null. Name Type Comment Required Name String Contains the name of field Yes Ignored Boolean Indicates weather we should ignore field Yes

Returns

Returns a VariantIdentity object which contains a unique identifier for the newly created document variant

Security

Resource must have at least Read Write access permission on CaptureDesign ACL.

void DeleteActivityVariant	(	string	sessionId,
		string	documentTypeId,
		string	documentVariantName,
		string	activityVariantName
	)

Deletes an activity variant from the specified document variant.

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.
documentTypeId	Id of the document type that we create the variant for. Cannot be null.
documentVariantName	The name of the document variant. Cannot be null.
activityVariantName	The name of the activity variant. Cannot be null.

Security

Resource must have at least Read Write access permission on CaptureDesign ACL.

void DeleteDocumentTypeVariant	(	string	sessionId,
		string	documentTypeId,
		string	documentVariantName,
		double	version
	)

Deletes a document variant from the specified document type.

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.
documentTypeId	Id of the document type that we create the variant for. Cannot be null.
documentVariantName	The name of the document variant. Cannot be null.
version	The document variant version.

Remarks

If a Version greater than 0 is passed, then that version of the variant and older are deleted.
If a Version of 0 is passed, then all versions of the variant are deleted.

Security

Resource must have at least Read Write access permission on CaptureDesign ACL.

ActivityVariantInfo GetActivityVariant	(	string	sessionId,
		string	documentTypeId,
		string	documentVariantName,
		string	activityVariantName
	)

Gets an Activity Variant. This returns all variant fields, indicating any that are hidden.

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.
documentTypeId	Id of the document type that we create the variant for. Cannot be null.
documentVariantName	The name of the document variant. Cannot be null.
activityVariantName	The name of the activity variant. Cannot be null.

Returns

Returns a ActivityVariantInfo object which contains info for an activity variant

Security

Resource must have at least Read access permission on CaptureDesign ACL.

VariantFieldIdentityCollection GetDocumentTypeFields	(	string	sessionId,
		string	docTypeId
	)

Gets the available document type fields for a document type.

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.
docTypeId	Id of the document type that we create the variant for. Cannot be null.

Returns

Returns a VariantFieldIdentityCollection object. This contains the document fields that are currently visible in the document variant.

Name	Type	Comment	Required
Name	String	Contains the name of field	Yes

Security

Resource must have at least Read access permission on CaptureDesign ACL.

DocumentVariantInfo GetDocumentTypeVariant	(	string	sessionId,
		string	documentTypeId,
		string	documentVariantName
	)

Gets a document variant. This returns all variant fields, indicating any that are hidden.

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.
documentTypeId	Id of the document type that we create the variant for. Cannot be null.
documentVariantName	The name of the document variant. Cannot be null.

Returns

Returns a DocumentVariantInfo object which contains info for a document variant

Security

Resource must have at least Read access permission on CaptureDesign ACL.

VariantFieldIdentityCollection GetVisibleDocumentTypeFieldsForVariant	(	string	sessionId,
		string	docTypeId,
		string	documentVariantName,
		double	variantVersion
	)

Gets the available document type fields for variant.

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.
docTypeId	Id of the document type that we create the variant for. Cannot be null.
documentVariantName	The name of the document variant. Cannot be null.
variantVersion	The document variant version.

Returns

Returns a VariantFieldIdentityCollection object. This contains the document fields that are currently visible in the document variant.

Name	Type	Comment	Required
Name	String	Contains the name of field	Yes

Remarks

If a Version greater than 0 is passed, then the fields retrieved apply to that version of the document variant.
If a Version of 0 is passed, then the fields retrieved apply to the latest version of the document variant.

Security

Resource must have at least Read access permission on CaptureDesign ACL.

void UpdateActivityVariant	(	string	sessionId,
		string	documentTypeId,
		string	documentVariantName,
		string	activityVariantName,
		string	newActivityVariantName,
		VariantFieldSummaryCollection	variantFields
	)

Updates one or more activity variants for the specified document type.

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.
documentTypeId	Id of the document type that we create the variant for. Cannot be null.
documentVariantName	The name of the document variant. Can be null.
activityVariantName	The name of the activity variant. Can be null.
newActivityVariantName	The New Activity Variant Name. Can be null.
variantFields	A VariantFieldIdentityCollection object. Specifies the Names of the document fields that are ignored by this document variant. An exception will be raised if this is null. Name Type Comment Required Name String Contains the name of field Yes Ignored Boolean Indicates weather we should ignore field Yes

Remarks

If documentVariantName is null, then the update applies to all variants for the specified document type.
If activityVariantName is null, then the update applies to all activity variants for the included document variants.
The newActivityVariantName is only applied if updating named activity variants.
It should be noted that the visibleFields passed to this API are always applied to the variant(s) before applying any ignoredFields.

Security

Resource must have at least Read Write access permission on CaptureDesign ACL.

void UpdateDocumentTypeVariant	(	string	sessionId,
		string	documentTypeId,
		string	documentVariantName,
		string	newDocumentVariantName,
		string	description,
		DateTime?	validFrom,
		VariantFieldSummaryCollection	variantFields
	)

Updates one or more document variants for the specified document type.

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.
documentTypeId	Id of the document type that we create the variant for. Cannot be null.
documentVariantName	The name of the document variant. Can be null.
newDocumentVariantName	The new name of the document variant. Can be null.
description	The Variant Description. This is optional and can be null.
validFrom	The date upon which the variant will become active. If set to null, the variant is immediately active.
variantFields	A VariantFieldSummaryCollection object. Specifies the document fields that should be made visible in the variant. Name Type Comment Required Name String Contains the name of field Yes Ignored Boolean Indicates weather we should ignore field Yes

Remarks

If documentVariantName is null, then the update applies to all variants for the specified document type.
The newDocumentVariantName is only applied if updating named document variants.
It should be noted that the visibleFields passed to this API are always applied to the variant(s) before applying any ignoredFields.

Security

Resource must have at least Read Write access permission on CaptureDesign ACL.