VerityCollection Properties

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

BaseClassIds Property

The IDs of the base classes associated with the VerityCollection instance. There will only be one ID value in this property for release 4.0 (or later) installations. For installations upgraded from a release prior to 4.0, there may be both Annotation and Document class ID values in this property, since these releases stored indexing information for both the Annotation and Document objects in the same Verity collection.

Metadata

AllowsDefaultChange:  false
Cardinality:  LIST
CopyToReservation:  false
Datatype:  GUID
IsHidden:  false
IsOrderable:  false
IsSearchable:  true
IsValueRequired:  true
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
RequiresUniqueElements:  false
Settability:  READ_WRITE
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

CollectionName Property

The name assigned to the Verity collection.

Metadata

AllowsDefaultChange:  false
Cardinality:  SINGLE
CopyToReservation:  false
Datatype:  STRING
IsHidden:  false
IsOrderable:  true
IsSearchable:  true
IsValueRequired:  true
MaximumLengthString:  100
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
RequiresUniqueElements:  false
Settability:  READ_WRITE
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:  true
IsSearchable:  true
IsValueRequired:  false
ModificationAccessRequired:  WRITE
PersistenceType:  OWN_COLUMN
RequiresUniqueElements:  false
Settability:  READ_ONLY
TargetAccessRequired:  READ

OriginalOrdinal Property

The ordinal number of the Verity collection if this collection was created prior to the Content Engine 4.0 release.

For objects indexed in this collection, an arithmetic function is performed on the object's GUID to map it to an ordinal number, indicating this ordinal number (the collection in which the object resides).

Metadata

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

ResourceStatus Property

Contains a ResourceStatus object, which specifies the availability status of a storage or index area. The status value can be any one of the following:

Note: When the ResourceStatus value is UNAVAILABLE, the indexer creates a new collection and completes any pending index requests using the new collection.

The Content Engine supports the following automatic transitions between status values:

An area's status can also be changed manually as allowed by the following rules:

Metadata

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