ItemCacheMappedEntityBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ItemCacheMappedEntityBuilder Class

class `NXOpen.``ItemCacheMappedEntityBuilder`

  Bases: `NXOpen.Builder`

  Generic journal methods for ItemCacheMappedEntityBuilder

  Not support KF.

  New in version NX12.0.0.

# Properties

Property | Description
--- | ---
ItemDescription | Returns or sets the description value.
ItemId | Returns or sets the id value.
ItemName | Returns or sets the name value.
ItemPropertyTable | Returns the property table associated with the object
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetObject | Returns the object currently being edited by this builder.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Property Detail

## ItemDescription

`ItemCacheMappedEntityBuilder.``ItemDescription`

  Returns or sets the description value.

  `-------------------------------------`

  Getter Method

  Signature `ItemDescription`

  Returns: | Description value.
  Return type: | str

  New in version NX12.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ItemDescription`

  Parameters: | description (str) – Description value.

  New in version NX12.0.0.

  License requirements: None.

## ItemId

`ItemCacheMappedEntityBuilder.``ItemId`

  Returns or sets the id value.

  `-------------------------------------`

  Getter Method

  Signature `ItemId`

  Returns: | The ID value.
  Return type: | int

  New in version NX12.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ItemId`

  Parameters: | id (int) – The ID value.

  New in version NX12.0.0.

  License requirements: None.

## ItemName

`ItemCacheMappedEntityBuilder.``ItemName`

  Returns or sets the name value.

  `-------------------------------------`

  Getter Method

  Signature `ItemName`

  Returns: | The name string value.
  Return type: | str

  New in version NX12.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ItemName`

  Parameters: | name (str) – The name string value.

  New in version NX12.0.0.

  License requirements: None.

## ItemPropertyTable

`ItemCacheMappedEntityBuilder.``ItemPropertyTable`

  Returns the property table associated with the object

  `-------------------------------------`

  Getter Method

  Signature `ItemPropertyTable`

  Returns: | property table
  Return type: | `NXOpen.CAE.PropertyTable`

  New in version NX12.0.0.

  License requirements: None.

# Method Detail

## Validate

`ItemCacheMappedEntityBuilder.``Validate`

  Validate whether the inputs to the component are sufficient for commit to be called.

  If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

  Signature `Validate()`

  Returns: | Was self validation successful
  Return type: | bool

  New in version NX3.0.1.

  License requirements: None.