iCore.Public.Types Namespace
The iCore.Public.Types namespace contains common types used throughout the iCPS Public API.
Classes
| Name | Description |
|---|---|
| DiagnosticInfo | Represents a single diagnostic resulting from an operation. |
| AlreadyInProgressException | Exception thrown to indicate that an operation could not be completed because it (or another operation) is already in progress preventing it. |
| ApiErrorMessageException | The exception that is thrown when an error is received from the iCoreAPI. |
| CommunicationException | The exception that is thrown when a network communication exception occurs. This class is also a base class for more specific exceptions thrown upon certain errors. |
| ConditionalErrorException | The exception thrown when one or more required properties of an entity was not specified when adding or updating it. |
| EntityDependencyException | Thrown to indicate that the operation failed because of a dependency between entities, such as the failure to delete a partner while it is being used by an event configuration. |
| EntityNotFoundException | Indicates that the requested entity could not be found in the current system. |
| EntityUpdateFailedException | The exception thrown when an entity update operation fails. |
| IllegalClrNameException | Exception throw indicating the the CLR-name specified for an entity is not valid. |
| MissingFilterParameterException | Indicates that a parameter needed for executing a Filter was not supplied. |
| NotFoundException | Exception indicating that the requested object could not be found. |
| StringLengthErrorException | Exception thrown to indicate that the requirements of the length of a string property are not met. |
| UniqueConstraintConflictException | Base class for exceptions indicating that the operation caused a violation of a unique constraint. |
| UniqueValueAddConflictException | Indicates that adding the specified item would violate a unique constraint. |
| UniqueValueUpdateConflictException | Indicates the update operation of the specified item would violate a unique constraint. |
| ValidationErrorException | Base class for exceptions indicating a validation error. |
| ValidationException | Exception indicating a problem that occurred during validation of an entity. |
| ValueOutOfRangeErrorException | Exception indicating that one of the specified values was out of range. |
Interfaces
| Name | Description |
|---|---|
| IEntityKey | iCore entity key interface (public). An iCore entity instance has a globally unique key consisting of an id and its entity type. |
| IComponentExecutionResult | Holds the result of a spawned workflow. |
| IProvidesImplementation | This interface is intended for internal use only. |
| ITrackingCleanupSessionReport | Contains information about the execution of a tracking clean-up session. |
| ITrackingCleanupExecutionReport | Obsolete interface containing properties that are now moved to ITrackingCleanupSessionReport. This interface will be removed in a future version of iCore. |
Enums
| Name | Description |
|---|---|
| AuthenticationMode | Authentication mode for using in REST web service clients. |
| BOMTypes | The code pages which support BOM. |
| DiagnosticInfoSeverity | Represents a diagnostic severity. |
| EventPriority | Specifies the event priority |
| ExcelFileFormat | The format of the Excel file. |
| ExistingNodeAttributeTypeOption | Options for when an attribute exist on a node |
| FileFormat | The format of the output. |
| FileSortCategory | Specifies category used for sort of retrieved files. |
| FileSortOrder | Specifies sort order of retrieved files |
| InitDataFormatOptions | Specifies the format of the initialization data in Init data argument for iCore API interaction functionality. |
| iCoreAPIResponseOptions | Specifies the type of response to send back to iCore API. |
| JobLifetime | Specifies how the service should treat jobs with regards to their lifetime. |
| KindOfEvent | The type of event, iCore Event. |
| LogDestination |
Contains constants defining the destination log.
|
| LogLevel | iCore Log entry log levels. |
| MsmqMessageIdMatchMode | Specifies how to match an MSMQ message id. |
| MsmqReadMode | Specifies the method to use when retrieving messages from an MSMQ message queue. |
| NonExistingNodeAttributeTypeOption | Options for when an attribute does not exist on a node |
| ScriptVarType | Basic types available in iCore Scripts. |
| ServerPartType | Represents a server part type. |
| StringLengthFormat | The format in witch the length of the string is defined. |
| StringPrefixType | The type of the prefix used in length-prefixed string. |
| WatchOperationType | File operations that FilesystemListenerActivity can monitor. |
| WebServiceClientType | Specifies the web service type. |
| ZipEncryption | Options for encryption when creating zip files. |
| ExecutionResultStatus | Status of the component execution result. |
| TrackingCleanupCompletionState | Specifies the reason as to why a tracking session was terminated. |