Assessment object

[This documentation is preliminary and is subject to change.]

The Assessment Object accesses an assessment and aligns with the hierarchy of the AXE Assessment Manifest.

These are properties that directly reflect data in an assessment’s manifest. Note that from programmatic perspective an “assessment” is the manifest. There is no assessment without a manifest.

Members

The Assessment object has the following types of members:

• Collections
• Properties

Collections

The Assessment object has the following collections.

Collection	Description
AssessmentFiles	A collection of AssessmentFile Objects for the assessment. Each AssessmentFile has two properties. The signature of the assessment file and the relative path to the file with no dotted directories in the path.
MetricDefinitions	A collection of MetricDefinition Objects for the assessment. Received from the value of the MetricDefinitions element in the assessment manifest. MetricDefinitions is a collection of MetricDefinition elements.
ParameterDefinitions	A collection of ParameterDefinition Objects for the assessment. Received from the value of the ParameterDefinitions element in the assessment manifest. ParameterDefinitions is a collection of ParameterDefinition elements.

 

Properties

The Assessment object has the following properties.

Property	Access type	Description
AssessmentExecution	Read-only	Provides a single AssessmentExecutionDefinition Object. This will be one of the following: CreateProcessExecutionDefinition ShellExecuteExecutionDefinition
Author	Read-only	A short localized string describing the person or company responsible for the assessment. This field may be empty.
AuthorData	Read-only	Provides is an AuthorData Object of the XmlDocument class defined by the assessment author. This document may be empty. Most solutions will ignore this data. This data enables assessment authors to embed information in the assessment manifest that is marshaled through the assessment process to the final Job results file. Assessment specific processing code can then use this data.
AuthorUrl	Read-only	URI for a location containing a description of the assessment. Received from the value of the AuthorUrl element in the assessment manifest. This field may be empty.
BestPractices	Read-only	A RTF stream that describes best practices for the assessment. Received from the value of the BestPractices element in the assessment manifest. This stream may have zero length (be empty.)
Copyright	Read-only	Localized string that describes copyright information for the assessment. Received from the value of the Copyright element in the assessment manifest. This field may be empty.
Description	Read-only	Descriptive information for the assessment received from the assessment manifest. The values of the following sub-elements of the Description element provide the information describing the assessment: Name provides the localized human-readable name. ProgrammaticName provides the non-localized programmatic name that can be used by applications. ToolTip provides the localized human-readable short description. Tags provides a collection of Tag elements. This field may be empty. Categories provides a collection of Category elements. This collection may be empty. Details provides a rich documentation as a RTF stream. This stream may have zero length (be empty.)
ExitValueMeaning	Read-only	Value describes how to interpret the exit value from an assessment. Received from the value of the ExitValueMeaning element in the assessment manifest.
FileName	Read-only	The file path to the file that backs the assessment data. Received from the value of the FilePath element in the assessment manifest. If the assessment was not loaded from a file then this property will be the empty string.
IsDirty	Read-only	If true, the assessment is not read-only and has been changed. This means it needs to be persisted.
IsNew	Read-only	If true, the assessment manifest is new and has never been saved to a file.
IsReadOnly	Read-only	If true, the assessment object is read-only If true, and any read-only properties are set, AXE throws one of the following exceptions: NamedObjectPropertyIsReadOnlyException NamedObjectIsReadOnlyException ObjectIsReadOnlyException PropertyIsReadOnlyException
IsValid	Read-only	If true, the assessment manifest is valid and was correctly loaded.
LastSaveDateTime	Read-only	Last date and time the assessment manifest was saved. Received from the value of the LastSaveDateTime element in the assessment manifest.
License	Read-only	A RTF stream that describes the license information for the assessment. Received from the value of the License element in the assessment manifest. This stream may have zero length (be empty.)
MayRebootSystem	Read-only	If true, the assessment may restart the system. Received from the value of the MayRebootSystem element in the assessment manifest.
OnlyForProcessor	Read-only	Describes the processors supported by the assessment. Received from the value of the OnlyForProcessor element in the assessment manifest.
RequiresACPower	Read-only	If true, the assessment requires AC power and cannot run on DC power. Received from the value of the RequiresACPower element in the assessment manifest.
RequiresBattery	Read-only	If true, the assessment requires battery power. Received from the value of the RequiresBattery element in the assessment manifest.
RequiresInternet	Read-only	If true, the assessment requires a connections to the internet. Received from the value of the RequiresInternet element in the assessment manifest.
ShouldRunSilent	Read-only	If true, the assessment should be run with no visible UX. Received from the value of the ShouldRunSilent element in the assessment manifest.
SupportOffLineMode	Read-only	If true, the assessment can be run offline.
SupportOnLineMode	Read-only	If true, the assessment can be run online.
SupportWinPE	Read-only	If true, the assessment can run on Windows PE. Received from the value of the SupportsWindowsPE element in the assessment manifest.
UpdateUrl	Read-only	URI for a location containing an update for the assessment. Received from the value of the UpdateUrl element in the assessment manifest. This field may be empty.
Url	Read-only	URI for the location of the assessment. Received from the value of the Url element in the assessment manifest. This field may be empty.
VerifyOSVersionRequired	Read-only	Minimum Windows version required by the assessment. Received from the value of the VerifyOSVersionRequired element in the assessment manifest.
VersionedId	Read-only	Strong identity of the assessment received from the assessment manifest. The values of the Guid and Version sub-elements of the VersionedId element provide the strong identity.

 

See also

Assessment

 

 

Build date: 9/6/2011