General.DocumentTypeSecurityConditions Entity

Namespace: General

Provides rules to conditionally secure new documents. Entity: Gen_Document_Type_Security_Conditions

Default Visualization

Default Display Text Format:
{DocumentType.EntityName}
Default Search Members:
DocumentType.EntityName
Name Data Member:
DocumentType.EntityName
Category: Definitions
Show in UI: ShownByDefault

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Parent:
General.DocumentTypes
Aggregate Root:
General.DocumentTypes

Attributes

Name	Type	Description
ConditionFilterXml	dataaccessfilter	Specifies the documents, for which the current rule is applicable. The XML filter is compared against new documents and the rule is applicable when they match. `Required`
Description	string (254)	The description of this DocumentTypeSecurity Condition. `Required` `Filter(eq;like)`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
ObjectVersion	int32	The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.
Priority	Priority	Priority of the rule against other rules, which are also applicable. Only the highest priority rule is selected. `Required` `Default(3)` `Filter(ge;le)`

References

Name	Type	Description
DocumentAccessKey	AccessKeys	The access key, which will be used to secure new documents, when this rule is selected. `Required` `Filter(multi eq)`
DocumentType	DocumentTypes	The document type, whose documents will be secured by the current rule. `Required` `Filter(multi eq)` `Owner`

Attribute Details

ConditionFilterXml

Specifies the documents, for which the current rule is applicable. The XML filter is compared against new documents and the rule is applicable when they match. Required

Type: dataaccessfilter
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

Description

The description of this DocumentTypeSecurityCondition. Required Filter(eq;like)

Type: string (254)
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 254
Show in UI: ShownByDefault

DisplayText

Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown

ObjectVersion

The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

Type: int32
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

Priority

Priority of the rule against other rules, which are also applicable. Only the highest priority rule is selected. Required Default(3) Filter(ge;le)

Type: Priority
Category: System
Generic enum type for Priority properties
Allowed Values (General.Priority Enum Members)

Value	Description
Lowest	Lowest value. Stored as 1. Database Value: 1 Model Value: 1 Domain API Value: 'Lowest'
Low	Low value. Stored as 2. Database Value: 2 Model Value: 2 Domain API Value: 'Low'
Medium	Medium value. Stored as 3. Database Value: 3 Model Value: 3 Domain API Value: 'Medium'
High	High value. Stored as 4. Database Value: 4 Model Value: 4 Domain API Value: 'High'
Highest	Highest value. Stored as 5. Database Value: 5 Model Value: 5 Domain API Value: 'Highest'

Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Default Value: 3
Show in UI: ShownByDefault

Reference Details

DocumentAccessKey

The access key, which will be used to secure new documents, when this rule is selected. Required Filter(multi eq)

Type: AccessKeys
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

DocumentType

The document type, whose documents will be secured by the current rule. Required Filter(multi eq) Owner

Type: DocumentTypes
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
Show in UI: ShownByDefault

API Methods

Methods that can be invoked in public APIs.

GetAllowedCustomPropertyValues

Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
Return Type: Collection Of CustomPropertyValue
Declaring Type: EntityObject
Domain API Request: GET

Parameters

customPropertyCode
The code of the custom property
Type: string
search
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: null
exactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: False
orderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: False
top
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10
skip
The skip clause - default is 0
Type: int32
Optional: True
Default Value: 0

CreateNotification

Creates a notification and sends a real time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST