MGCLatticeDmfSpecResultContract

The result of applying a data management configuration specification.

Methods

new

Initializes a new instance of the MGCLatticeDmfSpecResultContract class.

• Visibility: public
• Returns: void

No parameters.

construct

Creates a new instance of the MGCLatticeDmfSpecResultContract class.

• Visibility: public
• Returns: MGCLatticeDmfSpecResultContract A new instance.

No parameters.

add

Records what happened to one item and counts it.

• Visibility: public
• Returns: void

Name	Type	Optional	Description
_kind	str	No	What the item is.
_name	str	No	The item's name.
_outcome	str	No	What happened.
_detail	str	Yes	Anything worth saying about it.

outcomeCreated

The outcome name for an item that did not exist and now does.

• Visibility: public
• Returns: str The outcome name.

No parameters.

outcomeUpdated

The outcome name for an item that existed and was changed to match.

• Visibility: public
• Returns: str The outcome name.

No parameters.

outcomeUnchanged

The outcome name for an item that already matched the specification.

• Visibility: public
• Returns: str The outcome name.

No parameters.

outcomeRemoved

The outcome name for an item the specification does not describe and that was taken away.

• Visibility: public
• Returns: str The outcome name.

No parameters.

outcomeActivated

The outcome name for a job that was started.

• Visibility: public
• Returns: str The outcome name.

No parameters.

outcomeDeactivated

The outcome name for a job that was stopped.

• Visibility: public
• Returns: str The outcome name.

No parameters.

outcomeFailed

The outcome name for an item that could not be applied.

• Visibility: public
• Returns: str The outcome name.

No parameters.

changed

The number of items this run actually changed.

• Visibility: public
• Returns: int The count.

No parameters.

parmSuccess

Gets or sets whether every item was applied.

• Visibility: public
• Returns: boolean Whether the run succeeded.

Name	Type	Optional	Description
_success	boolean	Yes	Whether the run succeeded.

parmValidateOnly

Gets or sets whether this run was a dry run that changed nothing.

• Visibility: public
• Returns: boolean Whether the run was a dry run.

Name	Type	Optional	Description
_validateOnly	boolean	Yes	Whether the run was a dry run.

parmMessage

Gets or sets the summary sentence.

• Visibility: public
• Returns: str The message.

Name	Type	Optional	Description
_message	str	Yes	The message.

parmCreated

Gets or sets how many items were created.

• Visibility: public
• Returns: int The count.

Name	Type	Optional	Description
_created	int	Yes	The count.

parmUpdated

Gets or sets how many items were changed to match.

• Visibility: public
• Returns: int The count.

Name	Type	Optional	Description
_updated	int	Yes	The count.

parmUnchanged

Gets or sets how many items already matched.

• Visibility: public
• Returns: int The count.

Name	Type	Optional	Description
_unchanged	int	Yes	The count.

parmRemoved

Gets or sets how many items were taken away.

• Visibility: public
• Returns: int The count.

Name	Type	Optional	Description
_removed	int	Yes	The count.

parmFailed

Gets or sets how many items could not be applied.

• Visibility: public
• Returns: int The count.

Name	Type	Optional	Description
_failed	int	Yes	The count.

parmItems

Gets or sets what happened to each item.

• Visibility: public
• Returns: List The item results.

Name	Type	Optional	Description
_items	List	Yes	The item results.