Previous Topic: MethodsNext Topic: Types


Classes

This section details the classes in the Dictionary service.

DictionaryArgs

An instance of this class is created to allow options to be passed to the GetDictionaryClassifications() method.

The class has the following properties:

Locale

Allows a locale to be passed to the server so that results and error messages can be returned in the correct language.

Type: String

Format: A Microsoft LCID value, for example, ‘en-us’.

Default: The locale of the CCS installation

DictionaryResult

An instance of this class is returned from the call to GetDictionaryClassifications(). It contains status information about the call plus a list of DictionaryClassificationItem instances.

The class has the following properties:

Severity

Returns the type of error; Information, Warning, or Error.

Type: CCSResultType

ErrorCode

Returns 0 on success. Other codes are CA Data Protection errors which can be used for reporting and diagnostics.

Type: int

ErrorMessage

Returns the CA Data Protection error message for the ErrorCode.

Type: String

DictionaryClassifications

Returns a list of DictionaryClassificationItems.

DictionaryClassificationsList

This class is used to access the list of DictionaryClassificationItem instances.

The specific methods used to access the list depend on the client tools and environment used to process the WSDL.

DictionaryClassificationItem

This class represents each of the Dictionary Classifications against which content can be tested in the CCS.

The class has the following properties:

NodeType

Identifies this node as a Group or Leaf node, which allows the list to describe a hierarchy.

Type: DictionaryClassificationType

ClassificationID

The unique identifier.

Type: string

ParentID

The unique identifier of the Group.

Type: string

Name

The name of the Dictionary Classification.

Type: string

Description

A description of this Dictionary Classification

Type: string

Enabled

Set to True if this Dictionary Classification is enabled in the CCS policy.

Set to False if it exists in the CCS policy but is not enabled.

Type: Boolean