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... | |
Provides methods to manage Document Variants and Activity Variants.
ActivityVariantIdentity AddActivityVariant | ( | string | sessionId, |
string | documentTypeId, | ||
string | documentVariantName, | ||
string | activityVariantName, | ||
VariantFieldSummaryCollection | variantFields | ||
) |
Creates a new activity variant for the specified document variant.
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.
|
VariantIdentity AddDocumentTypeVariant | ( | string | sessionId, |
string | documentTypeId, | ||
string | documentVariantName, | ||
string | description, | ||
DateTime? | validFrom, | ||
VariantFieldSummaryCollection | variantFields | ||
) |
Creates a new document variant for the specified document type.
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.
|
void DeleteActivityVariant | ( | string | sessionId, |
string | documentTypeId, | ||
string | documentVariantName, | ||
string | activityVariantName | ||
) |
Deletes an activity variant from the specified document variant.
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. |
void DeleteDocumentTypeVariant | ( | string | sessionId, |
string | documentTypeId, | ||
string | documentVariantName, | ||
double | version | ||
) |
Deletes a document variant from the specified document type.
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. |
ActivityVariantInfo GetActivityVariant | ( | string | sessionId, |
string | documentTypeId, | ||
string | documentVariantName, | ||
string | activityVariantName | ||
) |
Gets an Activity Variant. This returns all variant fields, indicating any that are hidden.
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. |
VariantFieldIdentityCollection GetDocumentTypeFields | ( | string | sessionId, |
string | docTypeId | ||
) |
Gets the available document type fields for a document type.
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. |
Name | Type | Comment | Required |
---|---|---|---|
Name | String | Contains the name of field | Yes |
DocumentVariantInfo GetDocumentTypeVariant | ( | string | sessionId, |
string | documentTypeId, | ||
string | documentVariantName | ||
) |
Gets a document variant. This returns all variant fields, indicating any that are hidden.
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. |
VariantFieldIdentityCollection GetVisibleDocumentTypeFieldsForVariant | ( | string | sessionId, |
string | docTypeId, | ||
string | documentVariantName, | ||
double | variantVersion | ||
) |
Gets the available document type fields for variant.
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. |
Name | Type | Comment | Required |
---|---|---|---|
Name | String | Contains the name of field | Yes |
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.
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.
|
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.
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.
|