PropertyDescriptionString Properties

This topic alphabetically lists the properties that apply to the PropertyDescriptionString class.

Cardinality Property

Specifies a Cardinality constant, which indicates whether an object property can hold a single value (single cardinality) or a collection of multiple values (list or enumeration cardinality). You can only set the Cardinality property when you create a new property template. When you create a property definition from a property template, its Cardinality property will be automatically populated with the same value as that of the property template on which it is based. Once you have instantiated an object from the class to which the property definition belongs, the property defined by the property definition will have the specified cardinality.

For PropertyDescription and PropertyDefinition object types, this property is read-only:

For PropertyTemplate object types, this property is settable on create:

The Cardinality property can have one of the values in the following table.

Name Value Description
ENUM 1 Specifies a property with enumeration cardinality. A property with enumeration cardinality is an object-valued property that returns a set collection. A set collection is a read-only collection of unique, unordered, independent objects that must be traversed sequentially. You can iterate through the items of a set collection one page of elements at a time from the server to your client application. However, if the collection changes on the server while you are iterating through it, the number, order, and values of the items in your client copy can change, even if you maintain the same reference to it. A set collection cannot hold any items other than independent objects. By contrast, a list collection can hold items of any data type, with the exception of independent objects.
LIST 2 Specifies a property with list cardinality. A property with list cardinality returns a list collection. A list collection is a collection of ordered items that can either be modifiable (allowing items to be inserted, replaced, or deleted) or read-only. These items need not be unique and can be traversed in any order. When you access a list collection from the server, a complete copy of it is created on your client application, which you can iterate through one element at a time. The items in a list collection must all be of the same data type and must match the data type of the property that returns it. If the property returning a list collection is an object-valued property, all of the objects in the list collection must be dependent objects. A list collection can hold items of any data type (provided each item is of the same data type. However, if a list collection holds objects, they must all be dependent objects; only a set collection can hold independent objects. You cannot create a custom property with list cardinality.
SINGLE 0 Specifies a property with single cardinality. A property with single cardinality returns a single value of the data type that the property can hold.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  LONG
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
PropertyDefaultInteger32:  null
PropertyMaximumInteger32:  null
PropertyMinimumInteger32:  null
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

ChoiceList Property

Specifies a ChoiceList object that represents the discrete set of possible values that this property can hold.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  OBJECT
DeletionAction:  NONE
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
ReflectiveProperty:  null
RequiredClass:  ChoiceList
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

ClassDescription Property

Specifies a ClassDescription object containing the fixed description (immutable metadata) of the class from which this object is instantiated.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  OBJECT
DeletionAction:  NONE
IsHidden:  true
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
ReflectiveProperty:  null
RequiredClass:  ClassDescription
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

DataType Property

Specifies a TypeID constant, which indicates the data type of the value that an object property, choice list, or database table column can hold.

For PropertyDescription, PropertyDefinition, and PropertyTemplate object types, this property is read-only and specifies the data type of the value that an object property can hold. Because the value of the DataType property is automatically set by the server to correspond to the specific object type of the PropertyDescription, PropertyDefinition, or PropertyTemplate object, you do not need to set it when you are creating a property template or property definition. For example, in a PropertyDescriptionBinary, PropertyDefinitionBinary, or PropertyTemplateBinary object, the server automatically sets the DataType property to a value of BINARY.

For ChoiceList objects, this property is settable on create and must be a LONG or STRING constant value. This property determines whether a choice list is an integer-type choice list, which holds integer-type choice items or a string-type choice list, which holds string-type choice items.

For ColumnDefinition objects, this property is read-only and specifies the data type of the object property value that is stored in the represented database table column.

The DataType property can have one of the values in the following table.

Name Value Description
BINARY 1 Specifies a binary data type. Represents binary data by using an array of unsigned 8-bit bytes.
BOOLEAN 2 Specifies a Boolean data type. Represents Boolean data having a value of true or false.
DATE 3 Specifies a DateTime data type. Represents an instance in time as a date and time of day in accordance with ISO 8601.
DOUBLE 4 Specifies a double (Float64) data type. Represents an IEEE-standard 64-bit floating-point number, which has a value ranging from -1.79769313486232e308 to +1.79769313486232e308.
GUID 5 Specifies a GUID (ID) data type. Represents a Globally Unique Identifier (GUID) or DCE Universally Unique Identifier (UUID), which is a unique 128-bit number, as a string of 32 hexadecimal characters enclosed by brackets in the following format: {XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}. For example, {3F2504E0-4F89-11D3-9A0C-0305E82C3301}.
LONG 6 Specifies an integer data type. Represents a signed 32-bit integer, which has a value ranging from -2,147, 483,648 to +2,147,483,647.
OBJECT 7 Specifies an object data type. Represents an object that is instantiated from a Content Engine class.
STRING 8 Specifies a string data type. Represents text consisting of a sequential collection of 16-bit Unicode characters.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  LONG
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
PropertyDefaultInteger32:  8
PropertyMaximumInteger32:  null
PropertyMinimumInteger32:  null
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

DescriptiveText Property

User-readable text that describes an object.

The text is not locale-specific to the retrieving user except for the following classes:

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
MaximumLengthString:  null
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

DisplayName Property

The user-readable, provider-specific name of an object. This property is usually the designated Name property of the object's class.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
MaximumLengthString:  null
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

Id Property

A representation of the Globally Unique Identifier (GUID), a unique 128-bit number, that is assigned to this Content Engine object when the object is created. When converted to a string, the Id property is typically depicted as 32 hexadecimal characters enclosed by brackets in the following format: {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}. For example, {3F2504E0-4F89-11D3-9A0C-0305E82C3301}.

For User and Group classes, the Id property takes the value of the Security Identifier (SID) rather than the 128-bit GUID. The string representation of the SID is in this example format: S-1-5-21-1559522492-2815155736-3711640725-55269. When Active Directory is used as the directory service for IBM FileNet P8, calls to User.get_Id() and Group.get_Id() always return the current SID for the principal, even if this user or group has only historical SIDs populating the Active Directory server.

For a given property representation, the Id property has the following characteristics:

For a newly created document object, you can override the Id property of its associated VersionSeries object before you save or check in the document for the first time.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  GUID
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

Ids Property

Specifies an IdList object containing the collection of all of the IDs used to identify this class description or property description. The collection includes the value of this class description or property description's Id property and the values of any assigned alias IDs.

Metadata

AllowsDefaultChange:  false
Cardinality:  LIST
CopyToReservation:  false
Datatype:  GUID
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

IsCBREnabled Property

Specifies whether this class or property is enabled for full text indexing (content-based retrieval).

For classes, the following conditions apply:

For properties, this property can be enabled only on Document, Annotation, CustomObject, and Folder objects.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  BOOLEAN
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
PropertyDefaultBoolean:  null
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

IsHidden Property

Indicates whether this class or property should be hidden from non-administrative users (true) or not (false).

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  BOOLEAN
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
PropertyDefaultBoolean:  null
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

IsOrderable Property

Indicates whether this property can appear in the ORDER BY clause of a query.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  BOOLEAN
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
PropertyDefaultBoolean:  null
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

IsReadOnly Property

Specifies whether you can modify the value of the property described by this property description (true) or not (false). If IsReadOnly is true, the property's value can only be changed by the server.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  BOOLEAN
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
PropertyDefaultBoolean:  null
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

IsSearchable Property

Specifies whether the class or property can be used as part of the search criteria for a query.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  BOOLEAN
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
PropertyDefaultBoolean:  null
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

IsSelectable Property

Specifies whether the class or property can be selected in a query result set.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  BOOLEAN
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
PropertyDefaultBoolean:  null
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

IsSystemGenerated Property

Indicates whether the property described by a given property description has its value set automatically by the Content Engine server (true) or not (false). In general if IsSystemGenerated is true, the described property either provides system information (for example, DateCreated) or has its value determined by the server according to the results of a method call or some other operation (for example, if you call a folder's CreateSubFolder method, the system will automatically add the newly created folder to the collection of objects returned by the SubFolders property).

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  BOOLEAN
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
PropertyDefaultBoolean:  null
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

IsSystemOwned Property

Indicates whether a given class or property was originally created by the Content Engine (true), as opposed to user-created (false).

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  BOOLEAN
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
PropertyDefaultBoolean:  null
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

IsValueRequired Property

Indicates whether the property represented by a given property description, property definition, or property template is required to have a value (true) or not (false). If you attempt to save an object containing a property that requires a value and that property does not have a value assigned to it, an exception will result.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  BOOLEAN
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
PropertyDefaultBoolean:  null
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

MarkingSet Property

Specifies the set of markings for a given string-valued property. A MarkingSet is a container that holds all of the possible values for a particular marking-enabled property. Each Marking object in the marking set represents a different value for the property.

You can retrieve a string-valued property's marking set by calling get_MarkingSet() method on the PropertyDefinitionString, PropertyTemplateString, or PropertyDescriptionString interfaces.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  OBJECT
DeletionAction:  NONE
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
ReflectiveProperty:  null
RequiredClass:  MarkingSet
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

MaximumLengthString Property

Specifies the maximum length, in characters (excluding the null terminator), of a value for a property that returns a STRING data type.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  LONG
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
PropertyDefaultInteger32:  null
PropertyMaximumInteger32:  null
PropertyMinimumInteger32:  null
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

Name Property

The name for this object.

For most classes, this property is read-only and returns the value of the designated name property for the object, or its ID if there is no name property. If ClassDescription.NamePropertyIndex has a value, this property contains the value of the designated name property. If there is no designated name property value, and the object has an Id property, this property contains the string value of the Id property. If neither of these conditions is satisfied, this property contains an empty string.

For a ComponentRelationship object, this property is read/write and specifies the name of the object.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  true
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
MaximumLengthString:  null
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

PersistenceType Property

Specifies a PropertyPersistence constant that indicates whether a property can be made persistent (that is, have its state stored in a database). If a property can be made persistent, it must have either a dedicated column or a dedicated table in the database.

The PropertyPersistenceType property can have one of the values in the following table.

Name Value Description
NOT_PERSISTENT 0 Specifies that a property cannot be made persistent. If a property is defined as NOT_PERSISTENT, has a default value defined, and the Settability property of its property template has a value of PropertySettability.READ_ONLY, the property is considered to be a constant and will always return its default value for any instance of the property that is returned.
OWN_COLUMN 1 Specifies that the property has a dedicated column in the database and therefore can be made persistent.
OWN_TABLE 1 Specifies that the property has a dedicated table in the database and therefore can be made persistent. This setting applies only to multi-valued scalar (non-object) properties and causes the server to store a property's values into a custom table, which is generated by the server when its property template is first assigned to a class definition as a property definition. The name of this table is derived from the name of the corresponding property. Once it has been created, the same table will be used to store the property's values, regardless of the class to which the property is assigned.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  LONG
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
PropertyDefaultInteger32:  null
PropertyMaximumInteger32:  2
PropertyMinimumInteger32:  0
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

PrivilegedSettability Property

Specifies a PropertySettability constant, which indicates the settability of a property when an application has been granted privileged write access (AccessRight.PRIVILEGED_WRITE access right). Privileged write access gives an application the potential capability to set the Creator, DateCreated, DateLastModified, and LastModifier properties, which are normally read-only. The Settability property continues to indicate the property's settability for all other users.

The PrivilegedSettability property can have one of the values in the following table.

Name Value Description
READ_ONLY 3 Indicates that a property is read-only; only the server can set its value.
READ_WRITE 0 Indicates that a property is read/write; you can set its value at any time.
SETTABLE_ONLY_BEFORE_CHECKIN 1 Indicates that you can only set the value of a property before you check in the object to which it belongs.
SETTABLE_ONLY_ON_CREATE 2 Indicates that you can only set the value of a property when you create the object to which it belongs. Once you save the object for the first time, the property's value cannot be changed.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  LONG
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
PropertyDefaultInteger32:  null
PropertyMaximumInteger32:  null
PropertyMinimumInteger32:  null
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

PropertyDefaultString Property

Specifies the default value for a property that returns a STRING data type.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
MaximumLengthString:  null
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

PropertySelectionsString Property

Specifies a StringList object that contains the list of string values that can be assigned to the property described by this PropertyDescriptionString object.

Metadata

AllowsDefaultChange:  false
Cardinality:  LIST
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
MaximumLengthString:  null
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

RequiresUniqueElements Property

Specifies whether the values of a multi-valued property must be unique (true) or not (false).

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  BOOLEAN
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
PropertyDefaultBoolean:  null
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

Settability Property

Specifies a PropertySettability constant, which indicates when the value of a property can be set: For special system property cases in which privileged write access may be granted, the PrivilegedSettability property governs the property's settability for users who have AccessRight.PRIVILEGED_SETTABILITY access, while the Settability property continues to indicate the property's settability for all other users. See the description of the PrivilegedSettability property for these special cases.

The Settability property can have one of the values in the following table.

Name Value Description
READ_ONLY 3 Indicates that a property is read-only; only the server can set its value.
READ_WRITE 0 Indicates that a property is read/write; you can set its value at any time.
SETTABLE_ONLY_BEFORE_CHECKIN 1 Indicates that you can only set the value of a property before you check in the object to which it belongs.
SETTABLE_ONLY_ON_CREATE 2 Indicates that you can only set the value of a property when you create the object to which it belongs. Once you save the object for the first time, the property's value cannot be changed.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  LONG
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
PropertyDefaultInteger32:  null
PropertyMaximumInteger32:  null
PropertyMinimumInteger32:  null
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

SymbolicName Property

Represents the programmatic identifier for this class description, class definition, property description, property definition, property template, or object store. The value of the property is treated in a case-insensitive manner.

For objects in which you can set the SymbolicName property (object store, class definition, and property template), the value of the SymbolicName property must begin with a letter and contain the following characters only: 'A' to 'Z', 'a' to 'z', '0' to '9', and '_' (underscore). No blanks or symbols are allowed. If you do not provide a value for the SymbolicName property, the server will generate it, based on the value of the DisplayName property, when you save the object.

For property template objects, changing the symbolic name of a property template for a string-valued property that has been enabled for full-text indexing (IsCBREnabled property set to true) will require re-indexing of all objects containing that property. If you do not re-index, full-text searches on this property will fail to find any objects.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  false
MaximumLengthString:  null
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

UsesLongColumn Property

Specifies whether this string-valued property is stored in a database column as a short string (false) or as a long string (true).

Long-string table columns store their values separately from the rest of the table and therefore bypass table row-size limitations. To avoid a table's row-size limitation being exceeded, you should use a long-string column to store a large string-valued property if the database table in which it is stored has many custom properties. Because the actual text data for a long-string column is stored separately from the rest of the database row data (requiring an additional read operation to retrieve the data) you might experience a slight decrease in performance. However you might also potentially experience a system performance gain, because the overall row size for each object is reduced when long-string columns are used, therefore decreasing fetch and storage times.

Note that, unlike short-string columns, long-string columns cannot be specified in a database index.

For database-specific information about short-string and long-string table columns, table columns, see Database Engine Differences.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  BOOLEAN
IsHidden:  false
IsOrderable:  false
IsSearchable:  false
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  NOT_PERSISTENT
PropertyDefaultBoolean:  null
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ