EKM Client API

- Main Page
- Namespaces
- Classes

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Properties
com::ansys::ingress::connector::model::spec::ModelSpec Class Reference

ModelSpec defines type information about objects in the repository. More...

List of all members.

## Public Types

enum | Searchable { ALL, ROOT, NONE }
| Used to determine who can search for a particular object type. More...

## Public Member Functions

| ModelSpec ()
| Creates a new instance of a ModelSpec.
| ModelSpec (string typename)
| Creates a new instance of a ModelSpec.
| ModelSpec (string typename, string modelObjectClass)
| Creates a new instance of a ModelSpec.
| ModelSpec (string typename, string modelObjectClass, string baseType, string specType)
| Creates a new instance of a ModelSpec.
void | AddExtension (Extension extension)
| Adds an extension.
void | AddPropertySpec (string category, string name, PropertySpec spec)
| Adds a property spec.
void | AddTypeAttribute (string name, List< string > values)
| Adds a multivalued type attribute.
void | AddTypeAttribute (string name, string value)
| Adds a type attribute.
void | ApplyExtensions ()
| Applies extensions to this type.
void | ApplyMixins (object modelCache)
| Applies mixins to this type.
string | GetActualBaseTypeName ()
| Gets the actual base type name of this type.
ModelScript | GetCustomActions ()
| Returns the type's custom actions.
Dictionary< string, Variant > | GetDefaultProperties ()
| Gets the type's default properties.
Dictionary< string, bool > .KeyCollection | GetPermissionActionNames ()
| Gets a dictionary of action names and their permissions.
int | GetPermissionLevel (string actionName)
| Gets the permission level for the specified action.
Dictionary< String, PropertySpec >.KeyCollection | GetPropertyNames ()
| Gets the names of all properties defined by the type.
PropertySpec | GetPropertySpec (string name)
| Gets the property spec for the specified property.
Dictionary< string, List < string > >.KeyCollection | GetTypeAttributeNames ()
| Gets the name of this type's attributes.
string | GetTypeAttributeValue (string name)
| Gets the value of the specified type attribute.
List< string > | GetTypeAttributeValues (string name)
| Gets all of the values for the specified type attribute.
bool | IsChildRequired (string child)
| Determines if the specified child spec is required or not.
bool | IsMixin ()
| Determines if this type is a mixin or not.
bool | IsQuery (string actionName)
| Determines if the specified action is a query.
bool | IsVersioningSupported ()
| Determines if the type support versioning.
void | SetCustomActions (ModelScript actions)
| Sets the type's custom actions.
void | SetPermissionLevel (string actionName, int level)
| Sets the permission level for the given action.
void | SetTypeAttribute (string name, List< string > values)
| Sets the values for a type attribute.
ModelSpecData | Serialize ()
| Converts this model into a Model that can then be serialized into XML.

## Static Public Member Functions

static string | GetDefaultTypeName ()
| Returns this type's default type name.
static string | GetPermissionProperty (string actionName)
| Gets the name of the permission property for the specified action.
static bool | IsPermissionPropetyName (string name)
| Determines if the specified property name is a permission property.
static bool | IsValidItemName (string name, bool isProperty)
| Determines if the specified name is valid or not.
static ModelSpec | CreateSpec (ModelSpecData serializableModel)
| Creates a ModelSpec instance from a serializable model spec.
static ModelSpec | Deserialize (string xml)
| Converst XML into a ModelSpec instance.

## Public Attributes

const int | SYSTEM = 0
| System spec.
const int | AUTHORIZED_USERS = 1
| Authroized users.
const int | INVALID = 2
| Invalid.
const string | ASSOCIATED_IMAGE_PROPERTY = "associatedImage"
| The property for an object's associated image.
const string | CHANGE_LOG_PROPERTY = "__changeLog__"
| The property for the object's change log.
const string | CHECKED_OUT_BY_PROPERTY = "checkedOutBy"
| The property for the user that has the object checked out.
const string | CHECKIN_DISABLED_OPTION = "checkinDisabled"
| The property for indicating checkin is disabled for the object.
const string | CHECKIN_ENABLED_OPTION = "checkinEnabled"
| The property for indicating checkin is enabled for the object.
const string | CHECKIN_POLICY_PROPERTY = "checkinPolicy"
| The property for the object's checkin policy.
const string | CREATION_TIME_PROPERTY = "creationTime"
| The property for the object's creation time.
const string | CREATOR_PROPERTY = "creator"
| The property for the object's creator.
const string | DEFAULT_TYPE_NAME = "Model"
| The default type name.
const string | CONTAINER_TYPE_NAME = "Container"
| Container type name.
const string | FILE_TYPE_NAME = "File"
| File type name.
const string | FOLDER_TYPE_NAME = "Folder"
| Folder type name.
const string | REMOTE_ITEM_TYPE_NAME = "RemoteItem"
| Remote item type name.
const string | DEPENDENCY_TYPE_REFERENCE = "reference"
| A dependency reference.
const string | DESCRIPTION_PROPERTY = "description"
| The property for the object's description.
const string | EXPIRATION_DATE_PROPERTY = "expirationDate"
| The property for the object's expiration date.
const string | HIDDEN_CATEGORY = "Hidden Properties"
| The category for hidden properties.
const string | ICON_ATTRIBUTE = "icon"
| The spec's icon type attribute.
const string | IS_INTERNAL_PROPERTY = "__isInternal__"
| The property for determining if the object is internal or not.
const string | LIFECYCLE_HISTORY_CHILD = "__lifecycleHistory__"
| The name for a lifecycle history child.
const string | LIFECYCLE_STAGE_NONE = "None"
| The name of a lifecycle stage.
const string | LIFECYCLE_STAGE_PROPERTY = "lifecycleStage"
| The property for the object's lifecycle stage.
const String | LOCKING_ENABLED_OPTION = "lockingEnabled"
| Locking enabled policy.
const string | MODIFICATION_TIME_PROPERTY = "modificationTime"
| The property for the object's modification time.
const string | CONTENT_MODIFICATION_TIME_PROPERTY = "contentModificationTime"
| The property for the object's file content modification time.
const string | MODIFIED_BY_PROPERTY = "modifiedBy"
| The property for the object's modifier.
const string | NAME_PROPERTY = "name"
| The property for the object's name.
const char | PATH_SEPARATOR = '/'
| Repository path separator.
const string | PERISHABLE_PROPERTY = "perishable"
| The property for determining if the object is perishable.
const string | SPEC_TYPE_MIXIN = "mixin"
| A mixin spec.
const string | SPEC_TYPE_TYPE = "type"
| The spec type.
const string | STATUS_FLAG_INACTIVE = "inactive"
| Inactive status flag.
const string | STATUS_FLAG_USER_DATA_MISSING = "userDataMissing"
| User data missing status flag.
const string | STATUS_FLAGS_PROPERTY = "statusFlags"
| The property for the object's status flags.
const string | TYPE_PROPERTY = "type"
| The property for the object's type.
const string | UPDATE_EXPIRATION_ON_MOD_PROPERTY = "updateExpirationOnMod"
| The property for the object's update expiration on modification flag.
const string | VERSIONING_ENABLED_OPTION = "versioningEnabled"
| The property for the object's versioning enabled flag.
const string | ACCESS_ACTION = "access"
| Access action.
const string | CHECKOUT_ACTION = "checkout"
| Checkout action.
const string | CREATE_ACTION = "create"
| Create action.
const string | DELETE_ACTION = "delete"
| Delete action.
const string | MODIFY_ACTION = "modify"
| Modify action.
const string | DOWNLOAD_ACTION = "download"
| Download action.
const string | LIFECYCLE_ACTION = "lifecycle"
| Lifecycle action.
const string | FULL_CONTROL_ACTION = "fullControl"
| Full control action.
const string | VERSION_HISTORY_FILE_NAME = "version-history.xml"
| Version history file name.
const string | VERSION_GRAPH_IMAGE_FILE_NAME = "version-history-graph.gif"
| Version graph image file name.
const string | VERSION_GRAPH_MAP_FILE_NAME = "version-history-graph.map"
| Version graph map file name.
const string | ANCESTOR_VERSION_GRAPH_IMAGE_FILE_NAME = "ancestor-version-history-graph.gif"
| Ancestor graph image file name.
const string | ANCESTOR_VERSION_GRAPH_MAP_FILE_NAME = "ancestor-version-history-graph.map"
| Ancestor graph map file name.
const string | ATTRIBUTE_MODIFIED_FROM_BASELINE = "__vm-modifiedFromBaseline__"
| Modified from baseline attribute.
const string | ATTRIBUTE_VERSIONED_OBJECT_IDENTIFIER = "__vm-voi__"
| Object identifier.
const string | ATTRIBUTE_BRANCH_NUMBER = "__vm-bn__"
| Branch number.
const string | ATTRIBUTE_VERSION_NUMBER = "__vm-vn__"
| Version number.
const string | ATTRIBUTE_REPOSITORY_OBJECT_ID = "__vm-oid__"
| Repository object ID.
const string | TAGS_CATEGORY = "User Specified Properties"
| User specified properties category.

## Protected Member Functions

void | AddChildSpec (ChildSpec childSpec)
| Adds a child spec.
void | AddMixin (string mixin)
| Adds a mixin.
void | AddPermissionPropertySpec (string actionname, Variant[] defaultPermissions)
| Adds a permission property spec.
void | AddPermissionPropertySpec (string actionName, Variant[] defaultPermissions, bool isQuery)
| Adds a permission property spec.
void | AddPropertySpec (string name, PropertySpec spec)
| Adds a property spec.
void | AddStatusFlag (string statusFlag)
| Adds a status flag.
void | AppendTypeAttibute (string name, string value)
| Appends a value to a multivalued type attribute.
void | DeleteChildSpec (ChildSpec childSpec)
| Removes a child spec.
void | DeletePropertySpec (string name)
| Removes a property spec.
int | GetDefaultRetentionPolicy ()
| Gets the default retention policy for this type.
string | GetImageTypeName ()
| Returns the name of the image associated with the type.

## Properties

string | BaseTypeName`[get, set]`
| The name of this type's base type.
string | Label`[get, set]`
| The label for this type.
string | TypeName`[get, set]`
| The name of this type.
string | Version`[get, set]`
| This type's version.
string | ModelObjectClassName`[get, set]`
| The model object class name associated with this type.
HashSet< string > | Mixins`[get, set]`
| This type's mixin types.
HashSet< Extension > | Extensions`[get, set]`
| This type's extensions.
List< ChildSpec > | Children`[get, set]`
| This type's child specs.
Dictionary< string, PropertySpec > | PropertySpecs`[get, set]`
| This type's properties.
Dictionary< string, bool > | Permissions`[get, set]`
| This type's permissions.
Dictionary< string, int > | PermissionLevels`[get, set]`
| This type's permission levels.
HashSet< string > | StatusFlags`[get, set]`
| This type's status flags.
Dictionary< string, List < string > > | TypeAttributes`[get, set]`
| This type's attributes.
List< string > | DependencyTypes`[get, set]`
| This type's dependencies.
bool | Internal`[get, set]`
| If this type is internal or not.
bool | Beta`[get, set]`
| If this type is beta or not.
Searchable | SearchableBy`[get, set]`
| Who can search for this type.
string | SpecType`[get, set]`
| The type (mixin, extension, type)
HashSet< string > | RequiredChildren`[get, set]`
| This type's required child specs.
string | LifecycleDefinition`[get, set]`
| This types lifecycle definition.
ModelScript | ModelScriptInstance`[get, set]`
| This type's model script.

## Detailed Description

ModelSpec defines type information about objects in the repository.

## Member Enumeration Documentation

enum com::ansys::ingress::connector::model::spec::ModelSpec::Searchable

Used to determine who can search for a particular object type.

Enumerator:

  ALL | All user may search.
  ROOT | Root user may search.
  NONE | No users may search.

## Constructor & Destructor Documentation

com::ansys::ingress::connector::model::spec::ModelSpec::ModelSpec | ( |  | ) | `[inline]`

Creates a new instance of a ModelSpec.

com::ansys::ingress::connector::model::spec::ModelSpec::ModelSpec | ( | string | typename | ) | `[inline]`

Creates a new instance of a ModelSpec.

Parameters:

  typename | The spec's type name

com::ansys::ingress::connector::model::spec::ModelSpec::ModelSpec | ( | string | typename,
|  | string | modelObjectClass
| ) |  | `[inline]`

Creates a new instance of a ModelSpec.

Parameters:

  typename | The spec's type name
  modelObjectClass | The spec's model object class

com::ansys::ingress::connector::model::spec::ModelSpec::ModelSpec | ( | string | typename,
|  | string | modelObjectClass,
|  | string | baseType,
|  | string | specType
| ) |  | `[inline]`

Creates a new instance of a ModelSpec.

Parameters:

  typename | The spec's type name
  modelObjectClass | The spec's model object class
  baseType | The base type of the spec
  specType | The type of the spec (type, mixin, extension)

## Member Function Documentation

void com::ansys::ingress::connector::model::spec::ModelSpec::AddChildSpec | ( | ChildSpec | childSpec | ) | `[inline, protected]`

Adds a child spec.

Parameters:

  childSpec | The child spec

void com::ansys::ingress::connector::model::spec::ModelSpec::AddExtension | ( | Extension | extension | ) | `[inline]`

Adds an extension.

Parameters:

  extension | The extension

void com::ansys::ingress::connector::model::spec::ModelSpec::AddMixin | ( | string | mixin | ) | `[inline, protected]`

Adds a mixin.

Parameters:

  mixin | The mixin

void com::ansys::ingress::connector::model::spec::ModelSpec::AddPermissionPropertySpec | ( | string | actionname,
|  | Variant[] | defaultPermissions
| ) |  | `[inline, protected]`

Adds a permission property spec.

Parameters:

  actionname | The permission action
  defaultPermissions | The default permissions

void com::ansys::ingress::connector::model::spec::ModelSpec::AddPermissionPropertySpec | ( | string | actionName,
|  | Variant[] | defaultPermissions,
|  | bool | isQuery
| ) |  | `[inline, protected]`

Adds a permission property spec.

Parameters:

  actionName | The permission action
  defaultPermissions | The default permissions
  isQuery | If the action is a query

void com::ansys::ingress::connector::model::spec::ModelSpec::AddPropertySpec | ( | string | name,
|  | PropertySpec | spec
| ) |  | `[inline, protected]`

Adds a property spec.

Parameters:

  name | The property name
  spec | The spec

void com::ansys::ingress::connector::model::spec::ModelSpec::AddPropertySpec | ( | string | category,
|  | string | name,
|  | PropertySpec | spec
| ) |  | `[inline]`

Adds a property spec.

Parameters:

  category | The property's category
  name | The property name
  spec | The spec

void com::ansys::ingress::connector::model::spec::ModelSpec::AddStatusFlag | ( | string | statusFlag | ) | `[inline, protected]`

Adds a status flag.

Parameters:

  statusFlag | The flag

void com::ansys::ingress::connector::model::spec::ModelSpec::AddTypeAttribute | ( | string | name,
|  | List< string > | values
| ) |  | `[inline]`

Adds a multivalued type attribute.

Parameters:

  name | The attribute name
  values | The attribute values

void com::ansys::ingress::connector::model::spec::ModelSpec::AddTypeAttribute | ( | string | name,
|  | string | value
| ) |  | `[inline]`

Adds a type attribute.

Parameters:

  name | The attribute name
  value | The attribute value

void com::ansys::ingress::connector::model::spec::ModelSpec::AppendTypeAttibute | ( | string | name,
|  | string | value
| ) |  | `[inline, protected]`

Appends a value to a multivalued type attribute.

Parameters:

  name | The attribute name
  value | The attribute value

void com::ansys::ingress::connector::model::spec::ModelSpec::ApplyExtensions | ( |  | ) | `[inline]`

Applies extensions to this type.

void com::ansys::ingress::connector::model::spec::ModelSpec::ApplyMixins | ( | object | modelCache | ) | `[inline]`

Applies mixins to this type.

Parameters:

  modelCache | The model cache

static ModelSpec com::ansys::ingress::connector::model::spec::ModelSpec::CreateSpec | ( | ModelSpecData | serializableModel | ) | `[inline, static]`

Creates a ModelSpec instance from a serializable model spec.

Parameters:

  serializableModel | The serializable model spec

Returns:
  Returns the ModelSpec instance.

void com::ansys::ingress::connector::model::spec::ModelSpec::DeleteChildSpec | ( | ChildSpec | childSpec | ) | `[inline, protected]`

Removes a child spec.

Parameters:

  childSpec | The child spec to remove

void com::ansys::ingress::connector::model::spec::ModelSpec::DeletePropertySpec | ( | string | name | ) | `[inline, protected]`

Removes a property spec.

Parameters:

  name | The property to remove

static ModelSpec com::ansys::ingress::connector::model::spec::ModelSpec::Deserialize | ( | string | xml | ) | `[inline, static]`

Converst XML into a ModelSpec instance.

Parameters:

  xml | The XML to convert

Returns:
  Returns a ModelSpec instance.

string com::ansys::ingress::connector::model::spec::ModelSpec::GetActualBaseTypeName | ( |  | ) | `[inline]`

Gets the actual base type name of this type.

Returns:
  Returns the base type name.

ModelScript com::ansys::ingress::connector::model::spec::ModelSpec::GetCustomActions | ( |  | ) | `[inline]`

Returns the type's custom actions.

Returns:
  Returns the custom actions.

Dictionary<string, Variant> com::ansys::ingress::connector::model::spec::ModelSpec::GetDefaultProperties | ( |  | ) | `[inline]`

Gets the type's default properties.

Returns:
  Returns the default properties.

int com::ansys::ingress::connector::model::spec::ModelSpec::GetDefaultRetentionPolicy | ( |  | ) | `[inline, protected]`

Gets the default retention policy for this type.

Returns:
  Returns the policy.

static string com::ansys::ingress::connector::model::spec::ModelSpec::GetDefaultTypeName | ( |  | ) | `[inline, static]`

Returns this type's default type name.

Returns:
  Returns the default type name.

string com::ansys::ingress::connector::model::spec::ModelSpec::GetImageTypeName | ( |  | ) | `[inline, protected]`

Returns the name of the image associated with the type.

Returns:
  Returns the image name.

Dictionary<string, bool>.KeyCollection com::ansys::ingress::connector::model::spec::ModelSpec::GetPermissionActionNames | ( |  | ) | `[inline]`

Gets a dictionary of action names and their permissions.

Returns:
  Returns the dictionary.

int com::ansys::ingress::connector::model::spec::ModelSpec::GetPermissionLevel | ( | string | actionName | ) | `[inline]`

Gets the permission level for the specified action.

Parameters:

  actionName | The action

Returns:
  Returns the level.

static string com::ansys::ingress::connector::model::spec::ModelSpec::GetPermissionProperty | ( | string | actionName | ) | `[inline, static]`

Gets the name of the permission property for the specified action.

Parameters:

  actionName | The action

Returns:
  Returns the property name.

Dictionary<String, PropertySpec>.KeyCollection com::ansys::ingress::connector::model::spec::ModelSpec::GetPropertyNames | ( |  | ) | `[inline]`

Gets the names of all properties defined by the type.

Returns:
  Returns the collection of names.

PropertySpec com::ansys::ingress::connector::model::spec::ModelSpec::GetPropertySpec | ( | string | name | ) | `[inline]`

Gets the property spec for the specified property.

Parameters:

  name | The property name

Returns:
  Returns the property spec.

Dictionary<string, List<string> >.KeyCollection com::ansys::ingress::connector::model::spec::ModelSpec::GetTypeAttributeNames | ( |  | ) | `[inline]`

Gets the name of this type's attributes.

Returns:
  Returns the collection of names.

string com::ansys::ingress::connector::model::spec::ModelSpec::GetTypeAttributeValue | ( | string | name | ) | `[inline]`

Gets the value of the specified type attribute.

Parameters:

  name | The attribute name

Returns:
  Returns the value.

List<string> com::ansys::ingress::connector::model::spec::ModelSpec::GetTypeAttributeValues | ( | string | name | ) | `[inline]`

Gets all of the values for the specified type attribute.

Parameters:

  name | The attribute name

Returns:
  Returns the list of values

bool com::ansys::ingress::connector::model::spec::ModelSpec::IsChildRequired | ( | string | child | ) | `[inline]`

Determines if the specified child spec is required or not.

Parameters:

  child | The child spec name

Returns:
  Returns true if the child spec is required.

bool com::ansys::ingress::connector::model::spec::ModelSpec::IsMixin | ( |  | ) | `[inline]`

Determines if this type is a mixin or not.

Returns:
  Returns true if this type is a mixin.

static bool com::ansys::ingress::connector::model::spec::ModelSpec::IsPermissionPropetyName | ( | string | name | ) | `[inline, static]`

Determines if the specified property name is a permission property.

Parameters:

  name | The name to test.

Returns:
  Returns true if the name is a permission property name.

bool com::ansys::ingress::connector::model::spec::ModelSpec::IsQuery | ( | string | actionName | ) | `[inline]`

Determines if the specified action is a query.

Parameters:

  actionName | The action

Returns:
  Returns true if the action is a query.

static bool com::ansys::ingress::connector::model::spec::ModelSpec::IsValidItemName | ( | string | name,
|  | bool | isProperty
| ) |  | `[inline, static]`

Determines if the specified name is valid or not.

Parameters:

  name | The name
  isProperty | If the name is for a property or not

Returns:
  Returns true if the name is valid.

bool com::ansys::ingress::connector::model::spec::ModelSpec::IsVersioningSupported | ( |  | ) | `[inline]`

Determines if the type support versioning.

Returns:
  Returns true if the type suports versioning.

ModelSpecData com::ansys::ingress::connector::model::spec::ModelSpec::Serialize | ( |  | ) | `[inline]`

Converts this model into a Model that can then be serialized into XML.

Returns:

void com::ansys::ingress::connector::model::spec::ModelSpec::SetCustomActions | ( | ModelScript | actions | ) | `[inline]`

Sets the type's custom actions.

Parameters:

  actions | The custom actions

void com::ansys::ingress::connector::model::spec::ModelSpec::SetPermissionLevel | ( | string | actionName,
|  | int | level
| ) |  | `[inline]`

Sets the permission level for the given action.

Parameters:

  actionName | The action
  level | The permission level

void com::ansys::ingress::connector::model::spec::ModelSpec::SetTypeAttribute | ( | string | name,
|  | List< string > | values
| ) |  | `[inline]`

Sets the values for a type attribute.

Parameters:

  name | The attribute name
  values | The values

## Member Data Documentation

const string com::ansys::ingress::connector::model::spec::ModelSpec::ACCESS_ACTION = "access"

Access action.

const string com::ansys::ingress::connector::model::spec::ModelSpec::ANCESTOR_VERSION_GRAPH_IMAGE_FILE_NAME = "ancestor-version-history-graph.gif"

Ancestor graph image file name.

const string com::ansys::ingress::connector::model::spec::ModelSpec::ANCESTOR_VERSION_GRAPH_MAP_FILE_NAME = "ancestor-version-history-graph.map"

Ancestor graph map file name.

const string com::ansys::ingress::connector::model::spec::ModelSpec::ASSOCIATED_IMAGE_PROPERTY = "associatedImage"

The property for an object's associated image.

const string com::ansys::ingress::connector::model::spec::ModelSpec::ATTRIBUTE_BRANCH_NUMBER = "__vm-bn__"

Branch number.

const string com::ansys::ingress::connector::model::spec::ModelSpec::ATTRIBUTE_MODIFIED_FROM_BASELINE = "__vm-modifiedFromBaseline__"

Modified from baseline attribute.

const string com::ansys::ingress::connector::model::spec::ModelSpec::ATTRIBUTE_REPOSITORY_OBJECT_ID = "__vm-oid__"

Repository object ID.

const string com::ansys::ingress::connector::model::spec::ModelSpec::ATTRIBUTE_VERSION_NUMBER = "__vm-vn__"

Version number.

const string com::ansys::ingress::connector::model::spec::ModelSpec::ATTRIBUTE_VERSIONED_OBJECT_IDENTIFIER = "__vm-voi__"

Object identifier.

const int com::ansys::ingress::connector::model::spec::ModelSpec::AUTHORIZED_USERS = 1

Authroized users.

const string com::ansys::ingress::connector::model::spec::ModelSpec::CHANGE_LOG_PROPERTY = "__changeLog__"

The property for the object's change log.

const string com::ansys::ingress::connector::model::spec::ModelSpec::CHECKED_OUT_BY_PROPERTY = "checkedOutBy"

The property for the user that has the object checked out.

const string com::ansys::ingress::connector::model::spec::ModelSpec::CHECKIN_DISABLED_OPTION = "checkinDisabled"

The property for indicating checkin is disabled for the object.

const string com::ansys::ingress::connector::model::spec::ModelSpec::CHECKIN_ENABLED_OPTION = "checkinEnabled"

The property for indicating checkin is enabled for the object.

const string com::ansys::ingress::connector::model::spec::ModelSpec::CHECKIN_POLICY_PROPERTY = "checkinPolicy"

The property for the object's checkin policy.

const string com::ansys::ingress::connector::model::spec::ModelSpec::CHECKOUT_ACTION = "checkout"

Checkout action.

const string com::ansys::ingress::connector::model::spec::ModelSpec::CONTAINER_TYPE_NAME = "Container"

Container type name.

const string com::ansys::ingress::connector::model::spec::ModelSpec::CONTENT_MODIFICATION_TIME_PROPERTY = "contentModificationTime"

The property for the object's file content modification time.

const string com::ansys::ingress::connector::model::spec::ModelSpec::CREATE_ACTION = "create"

Create action.

const string com::ansys::ingress::connector::model::spec::ModelSpec::CREATION_TIME_PROPERTY = "creationTime"

The property for the object's creation time.

const string com::ansys::ingress::connector::model::spec::ModelSpec::CREATOR_PROPERTY = "creator"

The property for the object's creator.

const string com::ansys::ingress::connector::model::spec::ModelSpec::DEFAULT_TYPE_NAME = "Model"

The default type name.

const string com::ansys::ingress::connector::model::spec::ModelSpec::DELETE_ACTION = "delete"

Delete action.

const string com::ansys::ingress::connector::model::spec::ModelSpec::DEPENDENCY_TYPE_REFERENCE = "reference"

A dependency reference.

const string com::ansys::ingress::connector::model::spec::ModelSpec::DESCRIPTION_PROPERTY = "description"

The property for the object's description.

const string com::ansys::ingress::connector::model::spec::ModelSpec::DOWNLOAD_ACTION = "download"

Download action.

const string com::ansys::ingress::connector::model::spec::ModelSpec::EXPIRATION_DATE_PROPERTY = "expirationDate"

The property for the object's expiration date.

const string com::ansys::ingress::connector::model::spec::ModelSpec::FILE_TYPE_NAME = "File"

File type name.

const string com::ansys::ingress::connector::model::spec::ModelSpec::FOLDER_TYPE_NAME = "Folder"

Folder type name.

const string com::ansys::ingress::connector::model::spec::ModelSpec::FULL_CONTROL_ACTION = "fullControl"

Full control action.

const string com::ansys::ingress::connector::model::spec::ModelSpec::HIDDEN_CATEGORY = "Hidden Properties"

The category for hidden properties.

const string com::ansys::ingress::connector::model::spec::ModelSpec::ICON_ATTRIBUTE = "icon"

The spec's icon type attribute.

const int com::ansys::ingress::connector::model::spec::ModelSpec::INVALID = 2

Invalid.

const string com::ansys::ingress::connector::model::spec::ModelSpec::IS_INTERNAL_PROPERTY = "__isInternal__"

The property for determining if the object is internal or not.

const string com::ansys::ingress::connector::model::spec::ModelSpec::LIFECYCLE_ACTION = "lifecycle"

Lifecycle action.

const string com::ansys::ingress::connector::model::spec::ModelSpec::LIFECYCLE_HISTORY_CHILD = "__lifecycleHistory__"

The name for a lifecycle history child.

const string com::ansys::ingress::connector::model::spec::ModelSpec::LIFECYCLE_STAGE_NONE = "None"

The name of a lifecycle stage.

const string com::ansys::ingress::connector::model::spec::ModelSpec::LIFECYCLE_STAGE_PROPERTY = "lifecycleStage"

The property for the object's lifecycle stage.

const String com::ansys::ingress::connector::model::spec::ModelSpec::LOCKING_ENABLED_OPTION = "lockingEnabled"

Locking enabled policy.

const string com::ansys::ingress::connector::model::spec::ModelSpec::MODIFICATION_TIME_PROPERTY = "modificationTime"

The property for the object's modification time.

const string com::ansys::ingress::connector::model::spec::ModelSpec::MODIFIED_BY_PROPERTY = "modifiedBy"

The property for the object's modifier.

const string com::ansys::ingress::connector::model::spec::ModelSpec::MODIFY_ACTION = "modify"

Modify action.

const string com::ansys::ingress::connector::model::spec::ModelSpec::NAME_PROPERTY = "name"

The property for the object's name.

const char com::ansys::ingress::connector::model::spec::ModelSpec::PATH_SEPARATOR = '/'

Repository path separator.

const string com::ansys::ingress::connector::model::spec::ModelSpec::PERISHABLE_PROPERTY = "perishable"

The property for determining if the object is perishable.

const string com::ansys::ingress::connector::model::spec::ModelSpec::REMOTE_ITEM_TYPE_NAME = "RemoteItem"

Remote item type name.

const string com::ansys::ingress::connector::model::spec::ModelSpec::SPEC_TYPE_MIXIN = "mixin"

A mixin spec.

const string com::ansys::ingress::connector::model::spec::ModelSpec::SPEC_TYPE_TYPE = "type"

The spec type.

const string com::ansys::ingress::connector::model::spec::ModelSpec::STATUS_FLAG_INACTIVE = "inactive"

Inactive status flag.

const string com::ansys::ingress::connector::model::spec::ModelSpec::STATUS_FLAG_USER_DATA_MISSING = "userDataMissing"

User data missing status flag.

const string com::ansys::ingress::connector::model::spec::ModelSpec::STATUS_FLAGS_PROPERTY = "statusFlags"

The property for the object's status flags.

const int com::ansys::ingress::connector::model::spec::ModelSpec::SYSTEM = 0

System spec.

const string com::ansys::ingress::connector::model::spec::ModelSpec::TAGS_CATEGORY = "User Specified Properties"

User specified properties category.

const string com::ansys::ingress::connector::model::spec::ModelSpec::TYPE_PROPERTY = "type"

The property for the object's type.

const string com::ansys::ingress::connector::model::spec::ModelSpec::UPDATE_EXPIRATION_ON_MOD_PROPERTY = "updateExpirationOnMod"

The property for the object's update expiration on modification flag.

const string com::ansys::ingress::connector::model::spec::ModelSpec::VERSION_GRAPH_IMAGE_FILE_NAME = "version-history-graph.gif"

Version graph image file name.

const string com::ansys::ingress::connector::model::spec::ModelSpec::VERSION_GRAPH_MAP_FILE_NAME = "version-history-graph.map"

Version graph map file name.

const string com::ansys::ingress::connector::model::spec::ModelSpec::VERSION_HISTORY_FILE_NAME = "version-history.xml"

Version history file name.

const string com::ansys::ingress::connector::model::spec::ModelSpec::VERSIONING_ENABLED_OPTION = "versioningEnabled"

The property for the object's versioning enabled flag.

## Property Documentation

string com::ansys::ingress::connector::model::spec::ModelSpec::BaseTypeName`[get, set]`

The name of this type's base type.

bool com::ansys::ingress::connector::model::spec::ModelSpec::Beta`[get, set]`

If this type is beta or not.

List<ChildSpec> com::ansys::ingress::connector::model::spec::ModelSpec::Children`[get, set]`

This type's child specs.

List<string> com::ansys::ingress::connector::model::spec::ModelSpec::DependencyTypes`[get, set]`

This type's dependencies.

HashSet<Extension> com::ansys::ingress::connector::model::spec::ModelSpec::Extensions`[get, set]`

This type's extensions.

bool com::ansys::ingress::connector::model::spec::ModelSpec::Internal`[get, set]`

If this type is internal or not.

string com::ansys::ingress::connector::model::spec::ModelSpec::Label`[get, set]`

The label for this type.

string com::ansys::ingress::connector::model::spec::ModelSpec::LifecycleDefinition`[get, set]`

This types lifecycle definition.

HashSet<string> com::ansys::ingress::connector::model::spec::ModelSpec::Mixins`[get, set]`

This type's mixin types.

string com::ansys::ingress::connector::model::spec::ModelSpec::ModelObjectClassName`[get, set]`

The model object class name associated with this type.

ModelScript com::ansys::ingress::connector::model::spec::ModelSpec::ModelScriptInstance`[get, set]`

This type's model script.

Dictionary<string, int> com::ansys::ingress::connector::model::spec::ModelSpec::PermissionLevels`[get, set]`

This type's permission levels.

Dictionary<string, bool> com::ansys::ingress::connector::model::spec::ModelSpec::Permissions`[get, set]`

This type's permissions.

Dictionary<string, PropertySpec> com::ansys::ingress::connector::model::spec::ModelSpec::PropertySpecs`[get, set]`

This type's properties.

HashSet<string> com::ansys::ingress::connector::model::spec::ModelSpec::RequiredChildren`[get, set]`

This type's required child specs.

Searchable com::ansys::ingress::connector::model::spec::ModelSpec::SearchableBy`[get, set]`

Who can search for this type.

string com::ansys::ingress::connector::model::spec::ModelSpec::SpecType`[get, set]`

The type (mixin, extension, type)

HashSet<string> com::ansys::ingress::connector::model::spec::ModelSpec::StatusFlags`[get, set]`

This type's status flags.

Dictionary<string, List<string> > com::ansys::ingress::connector::model::spec::ModelSpec::TypeAttributes`[get, set]`

This type's attributes.

string com::ansys::ingress::connector::model::spec::ModelSpec::TypeName`[get, set]`

The name of this type.

string com::ansys::ingress::connector::model::spec::ModelSpec::Version`[get, set]`

This type's version.

The documentation for this class was generated from the following file:

- ModelSpec.cs

All Classes Namespaces Functions Variables Enumerations Properties