HPE Content Manager SDK 9.1
HP.HPTRIM.SDK.RecordType Class Reference

This object represents a TRIM Record Type. A record type is required for the construction of a new record in TRIM and the record type has a number of properties that determine behavior and default settings for records More...

Inheritance diagram for HP.HPTRIM.SDK.RecordType:
HP.HPTRIM.SDK.TrimMainObject HP.HPTRIM.SDK.ITrimNotes HP.HPTRIM.SDK.ITrimSecurity HP.HPTRIM.SDK.ITrimAccessControl HP.HPTRIM.SDK.ITrimAccessControlDefault HP.HPTRIM.SDK.ITrimActiveDates HP.HPTRIM.SDK.TrimObject HP.HPTRIM.SDK.TrimPropertySet

Public Member Functions

 RecordType (Database database, TrimURI uri)
 
 RecordType (Database database, string name)
 
 RecordType (Database database)
 
 RecordType (Database inDatabase, RecordBehaviour initializeAs)
 
void SetUserFieldUsage (FieldDefinition userFieldToAddorRemove, bool usesThisField)
 
bool ActiveAuditEventEnabled (HistoryTypes activeAuditEventType)
 Returns a boolean value indicating whether the nominated event should be logged in the active audit event log More...
 
void EnableActiveAuditEvent (HistoryTypes activeAuditEventType, bool isEnabled)
 Turns on or off the logging of the nominated event within the active audit event log More...
 
RecordType NewCopy ()
 Sets up a new record type by copying attributes of this record type More...
 
bool CanContain (RecordType contentType)
 Use this function to determine if a record of this type can act as a container for a record of the specified contentType. If it returns false, the ErrorMessage property will be set to provide extra information More...
 
bool CanHaveContainer (RecordType containerType)
 Use this function to determine if a record of this type can be contained within a container of the specified containerType. If it returns false, the ErrorMessage property will be set to provide extra information More...
 
void SetNotes (string newValue, NotesUpdateType TypeOfNotesUpdate)
 Updates the notes attached to this object. Typically used when a new contibution is to be combined with the existing notes, as some users only have the privilige to add to the notes, rather than overwriting them. More...
 
void SetActiveDateRange (TrimDateTime validFromDate, TrimDateTime validToDate)
 Sets the date range for which this object is active. Note that only the date component of the date and time is relevant for active date ranges. More...
 
- Public Member Functions inherited from HP.HPTRIM.SDK.TrimMainObject
virtual void Save ()
 Permanently commits all changes made to this object (and all its child objects). For new objects a new unique identifier will be allocated (Uri). More...
 
string MakeReference (string SuggestName)
 Creates a TRIM reference file for this object, given the path and filename. A reference file can be associated with the Open command of various of the TRIM executables - TRIM.exe, TRIMDesktop.exe, etc. When the reference file is double-clicked, the associated application will then launch (or activate if it already running) and the object will then be displayed inside that executable. Returns a string containing the path and filename of the reference file created. More...
 
virtual void Delete ()
 Permanently removes this object and all its associated child objects from the database. More...
 
bool IsDeleteOk ()
 Determines if this object can be deleted. If it returns false, check the ErrorMessage details for more information. It is possible that the ErrorMessage property could contain a warning message even though the function returns true. More...
 
bool Verify (bool failOnWarning)
 Verifies all properties that have been modified since this object was last saved. Returns a Boolean value indicating whether the function succeeded. If false, the error description is stored in the ErrorMessage property. More...
 
TrimChildObjectList GetChildObjectList (BaseObjectTypes childType)
 Retrieves the child object collection of the nominated child object type. More...
 
TrimMainObject GetNewCopy ()
 Creates a new TrimMainObject which is a copy of this TrimMainObject. Where appropriate, property values are copied from this TrimMainObject to the new TrimMainObject. You will generally need to set any unique properties manually afterwards, prior to committing this new TrimMainObject to the TRIM database with the Save() method. See also the NewCopy function of the derived objects that implement this capability. Will return NULL if this object does not support the Copy function. More...
 
virtual void Refresh ()
 Resets this object to the current state on the database, will revert any changes that might have been made. Only required if you are not using BOBnotifications, or need to guarantee a really up-to-date version of the object state. More...
 
- Public Member Functions inherited from HP.HPTRIM.SDK.TrimObject
bool IsMandatory (FieldDefinition field)
 Gets a boolean value indication whether the specified field must have a non-NULL value for this object. More...
 
bool IsValidFor (int purpose)
 Call this method to determine if this object can be used for the nominated purpose. To determine what the valid purposes are, look in the derived class at the more type safe versions of this function. More...
 
bool IsValidFor (int purpose, TrimMainObject purposeExtraObject)
 Call this method to determine if this object can be used for the nominated purpose. To determine what the valid purposes are, look in the derived class at the more type safe versions of this function. The purposeExtraObject is necessary for some purpose types - once again, the derived class will have more information. More...
 
bool IsValidFor (int purpose, int purposeExtraEnumValue)
 Call this method to determine if this object can be used for the nominated purpose. To determine what the valid purposes are, look in the derived class at the more type safe versions of this function. The purposeExtraInformation is necessary for some purpose types - once again, the derived class will have more information. More...
 
- Public Member Functions inherited from HP.HPTRIM.SDK.TrimPropertySet
TrimIcon GetPropertyIcon (PropertyIds propertyId)
 Gets the icon value associated the a property of this object. More...
 
TrimMainObject GetPropertyTrimObject (PropertyIds dnPropId)
 
string GetPropertyString (PropertyIds dnPropId)
 
int GetPropertyLong (PropertyIds dnPropId)
 
long GetPropertyLong64 (PropertyIds dnPropId)
 
bool GetPropertyBool (PropertyIds dnPropId)
 
TrimDateTime GetPropertyDate (PropertyIds dnPropId)
 
TrimDecimal GetPropertyDecimal (PropertyIds dnPropId)
 
TrimCurrency GetPropertyCurrency (PropertyIds dnPropId)
 
TrimURI GetPropertyUri (PropertyIds dnPropId)
 
bool SetPropertyTrimObject (PropertyIds dnPropId, TrimMainObject newValue)
 
bool SetPropertyString (PropertyIds dnPropId, string newValue)
 
bool SetPropertyLong (PropertyIds dnPropId, int newValue)
 
bool SetPropertyLong64 (PropertyIds dnPropId, long newValue)
 
bool SetPropertyBool (PropertyIds dnPropId, bool newValue)
 
bool SetPropertyDate (PropertyIds dnPropId, TrimDateTime newValue)
 
bool SetPropertyCurrency (PropertyIds dnPropId, TrimCurrency newValue)
 
bool SetPropertyDecimal (PropertyIds dnPropId, TrimDecimal newValue)
 
bool SetPropertyDouble (PropertyIds dnPropId, double newValue)
 
bool SetPropertyUri (PropertyIds dnPropId, TrimURI newValue)
 
bool ClearProperty (PropertyIds dnPropId)
 
object GetProperty (PropertyIds propId)
 
bool SetProperty (PropertyIds propId, object newValue)
 
string GetPropertyAsString (PropertyIds propertyId, StringDisplayType propertyValueStringType, bool useHTMLEscapeChars)
 Gets a string representation of a property value in a format appropriate for a specific use. More...
 
bool IsMandatory (PropertyIds propertyId)
 Gets a boolean value indication whether the specified property must have a non-NULL value for this object. More...
 
bool VerifyProperty (PropertyIds propertyId, bool doMandatoryChecks)
 Verifies the value of a particular property, by cross checking it against other property values. The ErrorMessage property provides details if the verification fails. More...
 
bool CanModifyProperty (PropertyIds propertyId)
 Indicates whether the current user has the permission to modify the specified property. More...
 

Properties

bool AcknowledgeRequests [get, set]
 Gets or sets a boolean value indicating whether requestors of records of this type need to acknowledge the receipt of the requested record before the request is consider complete. Only applies to delivery requests. More...
 
ActionDef Action [get, set]
 
bool AllowBlankFreeTextTitle [get, set]
 Gets or sets a Boolean value indicating whether the Free Text Title field component may be left blank. This property is only active when a structured Titling method is used (Classification, Thesaurus or Client titling methods). More...
 
bool AllowMultipleExtensions [get, set]
 Gets or sets a boolean value indicating whether records of this type can have the borrowing return date extended multiple times More...
 
bool AllowParts [get, set]
 Gets or sets a Boolean value indicating if this RecordType allows the creation of part relationships between Records. (Note for COM developers, use the SetPartNumberingDetails method to set the value of this property). More...
 
bool AllowReplace [get, set]
 Gets or sets a Boolean value indicating whether users will be allowed to return Electronic Documents, replacing existing copies of the document. More...
 
bool AllowVersions [get, set]
 Gets or sets a Boolean value indicating whether users will be allowed to return Electronic Documents as new revisions, thereby retaining a history of all changes to the document. Note: This property does not allow or disallow versions. To control the creation of versions, the menu item (or task) 'New Version' must be enabled/disabled for this Record Type. More...
 
bool AlwaysAuditSecurityBreaches [get, set]
 Gets or sets a boolean value indicating whether events that are security breaches should always be logged to the online audit log More...
 
bool AnnotateOnly [get, set]
 Gets or sets a Boolean value indicating whether users without 'Record Administration' will be prevented from overwriting existing notes (annotations only allowed). More...
 
bool AnnotateWhenReadOnly [get, set]
 Gets or sets a Boolean value indicating whether users without 'Modify Record' permission are allowed to annotate the notes for records of this Record Type. More...
 
Location Assignee [get, set]
 Gets or sets the default assignee location for records of this Record Type. The assignee location is traditionally used to hold the current location of a record. More...
 
bool AuditCreateEventsOffline [get, set]
 Gets or sets a boolean value to indicate that when a record of this type is created, there should be an entry added to the offline audit log. More...
 
bool AuditDeleteEventsOffline [get, set]
 Gets or sets a boolean value to indicate that when a record of this type is deleted, there should be an entry added to the offline audit log. More...
 
bool AuditModifyEventsOffline [get, set]
 Gets or sets a boolean value to indicate that when a record of this type is modified, there should be an entry added to the offline audit log. More...
 
AuthorizationMethods AuthorizationMethod [get, set]
 Gets or sets an AuthorizationMethods enumerated value indicating how documents should be authorized. More...
 
int AuthorizerReminderDays [get, set]
 Gets or sets a number value indicating how many days should pass before sending a reminder about completing the authorization process for a document (0 = don't issue reminders). More...
 
bool BelongsToAMatter [get, set]
 Gets or sets a boolean value indicating whether records of this type need to be associated with a matter before being created. More...
 
int BorrowingLimit [get, set]
 Gets or sets a number of days that should be used to limit borrowing of physical records. When this value is set to a non-zero value, whenever a record is moved from it's home location, a due for return date is calculated based on the number of days specified for the borrowing limit More...
 
bool CanHaveSharePointItems [get, set]
 Gets or sets a boolean value indicating whether records of this type can be SharePoint List Item records, as designeated by the HPE Content Manager SharePoint Integration. More...
 
bool ChangeTitleWhenReadOnly [get, set]
 Gets or sets a Boolean value indicating whether users without 'Modify Record' permission are allowed to change the free text title for records of this Record Type. More...
 
GeneralExceptionHandling CheckDuplicateTitles [get, set]
 Gets or sets a geGeneralExceptionHandling enum value indicating how HPE Content Manager should behave upon saving a record of this record type with a title that has already been used for another record. Note: Checking for Duplicate Titles only occurs if the records Indexing Event has been processed. More...
 
Classification Classification [get, set]
 Gets or sets a classification that is the starting point for any classification attached to records of this Record Type. If the ClassificationMandatory property is set to true, all Records must be within this Classification. More...
 
bool ClassificationMandatory [get, set]
 Gets or sets a Boolean value indicating whether users will be forced to create records of this Record Type within the starting classification held in the Classification property. This property is enabled only when the Record Type has a starting classification. More...
 
RecordClass ClassOfRecord [get, set]
 Gets or sets an rcRecordClass enum value indicating the default Record Class for records of this Record Type. A Record may be categorised as either Vital, Corporate (default value), Workgroup, Personal, Reference or Temporary. More...
 
bool CompressPartNumber [get, set]
 Gets or sets a Boolean value indicating whether the Part Number will be compressed (displayed without any leading zeros). (Note for COM developers, use the SetPartNumberingDetails method to set the value of this property). More...
 
bool ConfirmEachNumber [get, set]
 Gets or sets a Boolean value indicating whether a dialog will be displayed when a record of this Record Type is saved, to confirm the record number. More...
 
ContainmentRule ContainerRule [get, set]
 Gets or sets a ContainmentRule enumerated value indicating the business rule for what is a suitable container for records of this type More...
 
ContainmentRule ContentsRule [get, set]
 Gets or sets a ContainmentRule enumerated value indicating the business rule for what sort of contents can be added to a container record of this type More...
 
int DaysDue [get, set]
 Gets or sets an integer containing the number of days until due. If creating documents that require an action to be performed within a certain time period from the date of registration, set the value of this property to the number of business days that are to be calculated until the due date. This property is only activated when the RecordType.SetDueDateFromActions property is false, whereupon the Date Due field will operate independently of Action Tracking or Workflow. More...
 
Jurisdiction DefaultJurisdiction [get, set]
 Gets or sets the default jurisdiction of this record type. A record type can either have a default jurisdiction or a default jurisdiction group. More...
 
Record DefaultSeries [get, set]
 Gets or sets the default series record for any record created using this Record Type. The default series should be a valid series record, that is a record of a RecordType with UsualBehaviour 'bhSeries'. This property is only activated when the RecordType.WithinSeries property is set to 'true'. More...
 
RecordDisp Disposition [get, set]
 Gets or sets a rdRecordDisp enum value indicating the default disposition for records of this Record Type More...
 
int EditorReminderDays [get, set]
 Gets or sets a number value indicating how many days should pass before sending a reminder about completing the drafting process for a document (0 = don't issue reminders). More...
 
bool EndUsersCanModify [get, set]
 Gets or sets a boolean value indicating whether users without 'Modify Record' permission can update record metadata if the record is not finalized. Users must have the Document Update permission. More...
 
EsoActionType EsoActionType [get, set]
 Gets or sets a esoActionType enumeration value indicating what type of action to perform on documents when they are selected for Inactive Record Management More...
 
bool EsoAllowEvents [get, set]
 Gets or sets whether documents can be moved to other storage by the event processor More...
 
EsoDateType EsoDateType [get, set]
 Gets or sets the date field used to select candidate documents for Inactive Record Management More...
 
bool EsoEnable [get, set]
 Gets or sets whether this record type support Electronic Inactive Record Management More...
 
int EsoMonths [get, set]
 Gets or sets the number of months to pass before a document is eligible for Inactive Record Management More...
 
ElectronicStore EsoStoreUri [get, set]
 Gets or sets the electronic store an inactive document is moved to More...
 
int EsoYears [get, set]
 Gets or sets the number of years to pass before a document is eligible for Inactive Record Management More...
 
ElectronicStore EStore [get, set]
 Gets or sets the ElectronicStore object used to store electronic attachments to records of this Record Type. Setting this property to an existing non-default Electronic Store will automatically replace any previous value for the RecordType.StoreType property with 'tsUseStore'. More...
 
int ExtensionLimit [get, set]
 Gets or sets a number of days that should be used to limit extension of borrowing of physical records. When this value is set to a zero value, there is no extension allowed More...
 
string ExternalId [get, set]
 Gets or sets a string containing the External Identification Number for this Record Type. This identifier cannot be changed through the HPE Content Manager user interface and so guarantees your program a reliable handle to the record type aside from the URI. If this field contains a value and the Database.HideCustomRecordTypes property is set to true, then the whole record type will not be visible in the HPE Content Manager user interface. More...
 
bool FinalisePreviousVersion [get, set]
 Gets or sets a Boolean value indicating whether the previous version should be set to final (meaning no more modifications may be made) upon creation of a new version for a record of this Record Type. Any old revisions of the finalized record may be automatically removed when this occurs by setting the RecordType.PurgePreviousVersion property to 'true'. More...
 
int FinalReminderDays [get, set]
 Gets or sets a number value indicating how many days should pass before sending a reminder about completing the finalization of a document (0 = don't issue reminders). More...
 
int FollowupReminderDays [get, set]
 Gets or sets a number value indicating how many days should pass before sending a further reminder about completing an action in the review process (0 = don't issue reminders). More...
 
bool HideFreeTextTitle [get, set]
 Gets or sets a Boolean value indicating whether the Free Text Title field should be suppressed on the Data Entry Form. This is used in conjunction with the Record.AllowBlankFreeTextTitle property and only becomes active when a blank Free Text Title is allowed. More...
 
bool HomeCanBeSpace [get, set]
 Gets or sets a Boolean value indicating whether records of this Record Type are allowed to have a home location within the Space Management System. More...
 
Location HomeLocation [get, set]
 Gets or sets the default home location for records of this Record Type. The home location is traditionally used to hold the storage location of a record. If this property does not have a value, the default Location set in Tools - System Options - Locations will be assigned. Note: This Location must not have a lower Security Profile than the Record Type. More...
 
ContainerSecurityHandling InsecureContainer [get, set]
 Gets or sets a csContainerSecurityHandling enum value indicating the behavior for a record of this Record Type if it becomes an insecure container. That is if records (documents) of a higher Security Level are enclosed in a container of this Record Type which has a lower Security Level. More...
 
DocumentSecurityHandling InsecureDocument [get, set]
 Gets or sets a dsDocumentSecurityHandling enum value indicating the behavior for a record of this Record Type if it becomes an insecure document. That is if records (documents) of this Record Type with a lower Security Level are enclosed in a container of a higher Security Level. More...
 
string LastNumber [get, set]
 Gets or sets a string containing the starting number for any new records created with this Record Type. This must be set to a value that matches the numbering pattern determined by the RecordType.NumberPattern property before this RecordType object can be saved. More...
 
int Level [get, set]
 Gets or sets a number (0-9) indicating the container level allocated to this Record Type. A record may only contain records of a lower level number. More...
 
MediaTypes MediaType [get, set]
 Gets or sets a MediaTypes enumerated value to indicate the default media type for records of this record. More...
 
bool MoveWhenReadOnly [get, set]
 Gets or sets a Boolean value indicating whether users with no 'Modify Record' permission are allowed to move (change Assignee) records of this Record Type. More...
 
new string Name [get, set]
 Gets or sets a string containing the name of this Record Type. More...
 
bool NeedsAuthorizationProcess [get, set]
 Gets or sets a boolean property indicating where records of this type should be subject to an authorization process before being finalized. More...
 
bool NeedsClassification [get]
 Gets a boolean value indicating whether records of this type need to have a classification provided as part of the record creation process More...
 
bool NeedsReviewProcess [get, set]
 Gets or sets a boolean property indicating where records of this type should be subject to a review process before being finalized. More...
 
AutoPartRule NewPartCreationRule [get, set]
 Gets or sets the default Automated Part Rule used by records of this Record Type which governs the automated closure and creation of new record parts based on predefined criteria. More...
 
NotesInsertStyles NotesInsertStyle [get, set]
 Gets or sets an niNotesInsertStyle enum value indicating how notes should be added to the notes field on records of this Record Type. The possible styles are: only at the top, only at the bottom, or either at the top or the bottom. More...
 
RecordType NumberFromType [get, set]
 Gets or sets a RecordType object whose numbering pattern and starting number this Record Type shares. More...
 
bool NumberingIsManual [get]
 Gets a Boolean value indicating whether the numbering of records using this Record Type requires manual input. More...
 
NumberingMethods NumberMethod [get, set]
 Gets or sets an nmNumberingMethods enum value indicating whether records of this Record Type should be numbered by container, by a numbering pattern, or by copying the numbering pattern of another Record Type. To number based on Classification, include one of the characters 'P' or 'S' within the number pattern set via the RecordType.NumberPattern property. More...
 
string NumberPattern [get, set]
 Gets or sets the number pattern for this Record Type. It establishes the form of the record number for records created using this Record Type. The RecordType.LastNumber property must also be set before the RecordType can be saved.If the Record Type is to be numbered by classification, one of the characters 'P' or 'S' must be included within the number pattern. If the number pattern includes a 'P', (along with any of the alphabetic characters), the record number will be generated from the Record Numbering Pattern defined in the Classification.RecPattern property for this classification, and no RecordType.LastNumber property needs to be set. If it includes an 'S' (in which case some alphabetic and some numeric characters must also be specified within the number pattern), the record number will be generated in the usual way for record numbers, with the full classification level number replacing the 'S' character. For more information on the characters used to create a numbering pattern, refer to the HPE Content Manager Help File. More...
 
OldVersionPurgeOptions OldVersionPurgeStyle [get, set]
 Gets or sets a oldVersionPurgeOptions enumeration value indicating whether old revisions of the previous version for records of this Record Type should be removed when the a new version is created upon creation of a new version. This property is activated when the RecordType.FinalizePreviousVersion is set to true. More...
 
Location OwnerLocation [get, set]
 Gets or sets the default owner location for records of this Record Type. The owner location traditionally has responsibility for a record. Only users that belong to the owner location of a record can initially set its access controls. Note: This Location must not have a lower Security Profile than the Record Type. More...
 
string PartSeparator [get, set]
 Gets or sets a string which separates the Record Number from the Part Number of any parts created for records of this Record Type. (Note for COM developers, use the SetPartNumberingDetails method to set the value of this property). More...
 
bool PreventDispChangeIfNoSchedule [get, set]
 Gets or sets a Boolean value indicating whether the record's disposition is prevented from being changed if it does not have an attached schedule. More...
 
PsoActionType PsoActionType [get, set]
 Gets or sets a psoActionType enumeration value indicating what type of action to perform on records when they are selected for Inactive Record Management More...
 
RecordType PsoBoxRTY [get, set]
 Gets or sets the record type that will be used to create boxes during the inactive physical record management process More...
 
PsoDateType PsoDateType [get, set]
 Gets or sets the date field used to select physical candidate records for Inactive Record Management More...
 
bool PsoEnable [get, set]
 Gets or sets whether this record type support Inactive Record Management More...
 
int PsoMonths [get, set]
 Gets or sets the number of months to pass before a physical record is eligible for Inactive Record Management More...
 
Location PsoNewHomeLoc [get, set]
 Gets or sets the new home location of a physical inactive record More...
 
int PsoYears [get, set]
 Gets or sets the number of years to pass before a physical record is eligible for Inactive Record Management More...
 
bool PurgePreviousVersion [get, set]
 You should use the oldversionPurgeStyle property instead. More...
 
bool ResetAtYearEnd [get, set]
 Gets a Boolean value indicating whether any automatic component of this Record Type's numbering pattern will restart at number one at the beginning of a new year. More...
 
Schedule RetentionSchedule [get, set]
 Gets or sets the Schedule object which is the default Retention Schedule to be attached to new records of this Record Type. Setting a value for this property automatically sets the RecordType.UseRetention property to true. More...
 
int ReviewerReminderDays [get, set]
 Gets or sets a number value indicating how many days should pass before sending a reminder about completing the review process for a document (0 = don't issue reminders). More...
 
RecordType SapContainerRecordType [get, set]
 Gets or sets the default Record Type to be used when creating containers for SAP documents. More...
 
bool SapCreateContact [get, set]
 Gets or sets a boolean value indicating whether the SAP interface should create contacts (for customer ID) when creating SAP documents. More...
 
bool SapCreateContainers [get, set]
 Gets or sets a boolean value indicating whether the SAP interface should create containers (based on customer id/name) when creating SAP documents. More...
 
bool SapCreateCountries [get, set]
 Gets or sets a boolean value indicating whether the SAP interface should create a new jurisdiction if one is no found to match the supplied 'LAND1' SAP metadata value. More...
 
bool SapCreateCreatorLoc [get, set]
 Gets or sets a boolean value indicating whether the SAP interface should create a creator location when creating SAP documents. More...
 
bool SapForceDeleteDate [get, set]
 Gets or sets a boolean value indicating whether the SAP interface should override any existing retention schedule with a manual destruction date when using the delete date metadata. More...
 
string SapRepositoryId [get, set]
 Gets or sets a string value indicating if this record type is the default for the specified SAP repository More...
 
string SapTitleTemplate [get, set]
 Gets or sets a string value for the title of SAP documents created for this record type. More...
 
string SapTitleTemplateKS [get, set]
 Gets or sets a string value for the title of SAP documents created for this record type. This form is used after a call to DocumentKeysSet has been made for the new document. More...
 
bool SapUseCountryCode [get, set]
 Gets or sets a boolean value indicating whether the SAP interface should attach jurisdictions based on the SAP metadata property 'LAND1'. More...
 
bool SapUseDeleteDate [get, set]
 Gets or sets a boolean value indicating whether the SAP interface should set the manual destruction due date based on the SAP metadata property 'DEL_DATE'. More...
 
bool SetDueDateFromActions [get, set]
 Gets or sets a Boolean value indicating whether the Record.DateDue property should be updated based on the current action (Action Tracking) of the Record. If set to false, the Date Due field will operate independently of any Actions associated with the record. More...
 
string SortOrder [get, set]
 Gets or sets an alphabetic string (up to 3 characters long) by which this Record Type is sorted within the Record Types list. This is helpful if there is a large number of Record Types and there is a preferred order in which they should be displayed to the user. When the string is empty, the Record Types will be sorted alphabetically by Record Type name. More...
 
WorkflowTemplate StartupTemplate [get, set]
 Gets or sets the default Workflow Template used to initiate a new workflow whenever a new record of this Record Type is created. More...
 
UseStoreType StoreType [get, set]
 Gets or sets a tsUseStoreType enum value indicating whether the record type will use the default electronic document store, the nominated store set in the RecordType.Store property, or not use a store at all (no electronic object support for this Record Type). More...
 
bool SuppressContentIndexing [get, set]
 Gets or sets a Boolean value indicating whether HPE Content Manager should suppress document content indexing for records of this Record Type. Document content indexing enables the ability to search for records in HPE Content Manager by words that occur inside the attached electronic documents. More...
 
TitlingMethods TitlingMethod [get, set]
 Gets or sets a tmTitlingMethod enum value indicating the default titling method for records of this Record Type. A record may be titled by: Free Text (default) in which there is no controlled list of values for the title the user sets; Classification in which record titles are created according to a hierarchical Classification system; Thesaurus (ISO Standard) in which titles are created according to a hierarchical word list of standard terms; Thesaurus (Descriptor) in which titles are created with any thesaurus terms, as long as the first term is a top term; or Client in which titles contain a Location name at the start of the title. More...
 
Icons TrimIconId [get, set]
 Gets or sets a number indicating the style of icon that will depict records of this type throughout HPE Content Manager. More...
 
bool UseCensus [get, set]
 Gets or sets a Boolean value indicating whether records of this Record Type will be tracked during a census. The object of a Census is to create an accurate count of records assigned to a particular location during a defined date/time period. More...
 
bool UsePartNumber [get, set]
 Gets or sets a Boolean value indicating whether this Record Type should use part numbering. (Note for COM developers, use the SetPartNumberingDetails method to set the value of this property). More...
 
bool UseRetention [get, set]
 Gets or sets a Boolean value indicating whether a Retention Schedule may be attached to records of this Record Type. More...
 
RecordBehaviour UsualBehaviour [get, set]
 Gets or sets a bhRecordBehaviour enum value determining the general behavior for records of this Record Type. The record may behave like a Document, used to catalog/register individual documents that may then be placed on file; Folder, used to create records that will contain documents or other records; Series, used to link records with disparate metadata; Box, used to contain records (usually for archival purposes); Folder (Paper Only), used to create paper based records; Document Template, a Word Template used in HPE Content Manager's Document Assembly module; or Content Block, an individual document section used within HPE Content Manager's Document Assembly module. More...
 
bool VersionNumbering [get, set]
 Gets or sets a Boolean value indicating whether version numbering should be used when creating new versions for records of this Record Type. A new version of a document is registered as a record in its own right with a link to its previous version. This is different from a revision, which gets attached to the same record. More...
 
bool WithinSeries [get, set]
 Gets or sets a Boolean value indicating whether records of this Record Type should be placed within a series. The RecordType.DefaultSeries property is only activated upon setting this property to true. More...
 
RecordTypeAutoSubFolders ChildAutoSubFolders [get]
 Get the list of Automatic Sub Folders More...
 
FieldDefinitionList UserFields [get]
 
FormDefinition RecordPropertiesFormDefinition [get, set]
 Gets or sets the form definition used for editing records of this type. More...
 
TrimURIList Reviewers [get, set]
 Gets or sets a list of locations representing the default reviewers of a document when using the Document Review feature More...
 
TrimURIList Authorizers [get, set]
 Gets or sets a list of locations representing the default authorizers of a document when using the Document Review feature More...
 
TrimURIList ContainerTypes [get, set]
 Gets or sets a list of record types representing the list of valid record types that can be containers of this record type. Use this with the ContainerRule value of ByList More...
 
TrimURIList ContentsTypes [get, set]
 Gets or sets a list of record types representing the list of valid record types that can be contains of a container record of this record type. Use this with the ContentsRule value of ByList More...
 
bool CanModifyExistingNotes [get]
 
bool CanAddToNotes [get]
 
string Notes [get, set]
 
TrimSecurityProfile SecurityProfile [get, set]
 
TrimAccessControlList AccessControlList [get, set]
 
TrimAccessControlList DefaultAccessControlList [get, set]
 
TrimDateTime DateActiveFrom [get]
 
TrimDateTime DateActiveTo [get]
 
string ActiveDateRangeDescription [get]
 
bool IsActive [get]
 
- Properties inherited from HP.HPTRIM.SDK.TrimMainObject
TrimDateTime LastUpdatedOn [get]
 Returns the date and time that changes to this object were last committed. More...
 
string Name [get]
 Gets a string name for this object which is a user-friendly way of displaying this object. For most TRIM objects the name is a unique string, although some times this is not the case (eg Location Names). More...
 
bool Verified [get]
 Gets a Boolean value indicating whether the object has been verified. That is, whether a call to the 'Verify' method has been made and has succeeded. More...
 
string WebURL [get]
 
bool IsInFavorites [get]
 Gets a boolean value indicating whether this object is in the current user's list of favorites More...
 
string UpdateComment [get, set]
 Gets or sets a string value to be recorded with any audit entries related to the update of this object More...
 
- Properties inherited from HP.HPTRIM.SDK.TrimObject
BaseObjectTypes TrimType [get]
 Gets a BaseObjectTypes enum value indicating the type of this object. More...
 
TrimURI Uri [get]
 Gets the unique row identifier for this object. Once an object has been committed to the database, typically by calling a Save method, this unique identifier is allocated. From that time on, the uri will remain constant and can never be changed. It is always unique across all objects of the same Type. More...
 
string URN [get]
 Gets the uniform resource name for this object. More...
 
string NameString [get]
 Gets a string name for this object which is a user-friendly way of displaying this object. For most TRIM objects the name is a unique string, although some times this is not the case (eg Location Names). More...
 
string NameStringExtra [get]
 Gets a more verbose description of this object, particularly when the name is perhaps a little cryptic or not enough to fully describe the object. More...
 
bool IsReadOnly [get]
 Gets a boolean parameter indicating if this object is "ReadOnly". This would generally indicate that none of the object's properties could be modified, in some cases there are exceptions that can be tested via CanModifyProperty method. More...
 
- Properties inherited from HP.HPTRIM.SDK.TrimPropertySet
string ErrorMessage [get]
 All TRIM SDK objects have an ErrorMessage property which can be used to examine any error that may have occurred in the most recent method call. More...
 
TrimException Error [get]
 All TRIM SDK objects have an Error property which can be used to examine any error that may have occurred in the most recent method call. More...
 
Database Database [get]
 Gets the TRIM Database object in which this object resides. All Trim objects live within a particular TRIM database and cannot be created without one. More...
 
virtual string Caption [get]
 Gets the user-defined caption that has been associated with all TrimPropertySets of this type. More...
 
virtual TrimIcon Icon [get]
 Gets the icon value associated this TrimPropertySet. More...
 
bool IsModified [get]
 Gets a boolean parameter indicating if any changes have been made to this object since it was first constructed, or last saved. More...
 
- Properties inherited from HP.HPTRIM.SDK.ITrimNotes
bool CanModifyExistingNotes [get]
 Gets a boolean parameter indicating whether the current user can modify the existing notes attached to this object. More...
 
bool CanAddToNotes [get]
 Gets a boolean value indicating whether the current user can either append or prepend some text to the existing notes. More...
 
string Notes [get, set]
 Gets or sets a string value corresponding to the notes attached to this object. More...
 
- Properties inherited from HP.HPTRIM.SDK.ITrimSecurity
TrimSecurityProfile SecurityProfile [get, set]
 Gets or sets the security profile attached to this object. More...
 
- Properties inherited from HP.HPTRIM.SDK.ITrimAccessControl
TrimAccessControlList AccessControlList [get, set]
 Gets or sets the access control list attached to this object. More...
 
- Properties inherited from HP.HPTRIM.SDK.ITrimAccessControlDefault
TrimAccessControlList DefaultAccessControlList [get, set]
 Gets or sets the default reference or copied access control list attached to this object. More...
 
- Properties inherited from HP.HPTRIM.SDK.ITrimActiveDates
TrimDateTime DateActiveFrom [get]
 Gets the TrimDateTime property corresponding to when this object first became active. If the returned value is blank, it indicates that the item has always been active (until the DateActiveTo value). More...
 
TrimDateTime DateActiveTo [get]
 Gets the TrimDateTime property corresponding to when this object first became active. If the returned value is blank, it indicates that the item has always been active (until the DateActiveTo value). More...
 
string ActiveDateRangeDescription [get]
 Gets a string describing the period during which this object was active. More...
 
bool IsActive [get]
 Gets a boolean value indicating whether this object is currently active. More...
 

Detailed Description

This object represents a TRIM Record Type. A record type is required for the construction of a new record in TRIM and the record type has a number of properties that determine behavior and default settings for records

Constructor & Destructor Documentation

HP.HPTRIM.SDK.RecordType.RecordType ( Database  database,
TrimURI  uri 
)
HP.HPTRIM.SDK.RecordType.RecordType ( Database  database,
string  name 
)
HP.HPTRIM.SDK.RecordType.RecordType ( Database  database)
HP.HPTRIM.SDK.RecordType.RecordType ( Database  inDatabase,
RecordBehaviour  initializeAs 
)

Member Function Documentation

bool HP.HPTRIM.SDK.RecordType.ActiveAuditEventEnabled ( HistoryTypes  activeAuditEventType)

Returns a boolean value indicating whether the nominated event should be logged in the active audit event log

bool HP.HPTRIM.SDK.RecordType.CanContain ( RecordType  contentType)

Use this function to determine if a record of this type can act as a container for a record of the specified contentType. If it returns false, the ErrorMessage property will be set to provide extra information

bool HP.HPTRIM.SDK.RecordType.CanHaveContainer ( RecordType  containerType)

Use this function to determine if a record of this type can be contained within a container of the specified containerType. If it returns false, the ErrorMessage property will be set to provide extra information

void HP.HPTRIM.SDK.RecordType.EnableActiveAuditEvent ( HistoryTypes  activeAuditEventType,
bool  isEnabled 
)

Turns on or off the logging of the nominated event within the active audit event log

RecordType HP.HPTRIM.SDK.RecordType.NewCopy ( )

Sets up a new record type by copying attributes of this record type

void HP.HPTRIM.SDK.RecordType.SetActiveDateRange ( TrimDateTime  validFromDate,
TrimDateTime  validToDate 
)

Sets the date range for which this object is active. Note that only the date component of the date and time is relevant for active date ranges.

Implements HP.HPTRIM.SDK.ITrimActiveDates.

void HP.HPTRIM.SDK.RecordType.SetNotes ( string  NewNotesText,
NotesUpdateType  TypeOfNotesUpdate 
)

Updates the notes attached to this object. Typically used when a new contibution is to be combined with the existing notes, as some users only have the privilige to add to the notes, rather than overwriting them.

Implements HP.HPTRIM.SDK.ITrimNotes.

void HP.HPTRIM.SDK.RecordType.SetUserFieldUsage ( FieldDefinition  userFieldToAddorRemove,
bool  usesThisField 
)

Property Documentation

TrimAccessControlList HP.HPTRIM.SDK.RecordType.AccessControlList
getset
bool HP.HPTRIM.SDK.RecordType.AcknowledgeRequests
getset

Gets or sets a boolean value indicating whether requestors of records of this type need to acknowledge the receipt of the requested record before the request is consider complete. Only applies to delivery requests.

ActionDef HP.HPTRIM.SDK.RecordType.Action
getset
string HP.HPTRIM.SDK.RecordType.ActiveDateRangeDescription
get
bool HP.HPTRIM.SDK.RecordType.AllowBlankFreeTextTitle
getset

Gets or sets a Boolean value indicating whether the Free Text Title field component may be left blank. This property is only active when a structured Titling method is used (Classification, Thesaurus or Client titling methods).

bool HP.HPTRIM.SDK.RecordType.AllowMultipleExtensions
getset

Gets or sets a boolean value indicating whether records of this type can have the borrowing return date extended multiple times

bool HP.HPTRIM.SDK.RecordType.AllowParts
getset

Gets or sets a Boolean value indicating if this RecordType allows the creation of part relationships between Records. (Note for COM developers, use the SetPartNumberingDetails method to set the value of this property).

bool HP.HPTRIM.SDK.RecordType.AllowReplace
getset

Gets or sets a Boolean value indicating whether users will be allowed to return Electronic Documents, replacing existing copies of the document.

bool HP.HPTRIM.SDK.RecordType.AllowVersions
getset

Gets or sets a Boolean value indicating whether users will be allowed to return Electronic Documents as new revisions, thereby retaining a history of all changes to the document. Note: This property does not allow or disallow versions. To control the creation of versions, the menu item (or task) 'New Version' must be enabled/disabled for this Record Type.

bool HP.HPTRIM.SDK.RecordType.AlwaysAuditSecurityBreaches
getset

Gets or sets a boolean value indicating whether events that are security breaches should always be logged to the online audit log

bool HP.HPTRIM.SDK.RecordType.AnnotateOnly
getset

Gets or sets a Boolean value indicating whether users without 'Record Administration' will be prevented from overwriting existing notes (annotations only allowed).

bool HP.HPTRIM.SDK.RecordType.AnnotateWhenReadOnly
getset

Gets or sets a Boolean value indicating whether users without 'Modify Record' permission are allowed to annotate the notes for records of this Record Type.

Location HP.HPTRIM.SDK.RecordType.Assignee
getset

Gets or sets the default assignee location for records of this Record Type. The assignee location is traditionally used to hold the current location of a record.

bool HP.HPTRIM.SDK.RecordType.AuditCreateEventsOffline
getset

Gets or sets a boolean value to indicate that when a record of this type is created, there should be an entry added to the offline audit log.

bool HP.HPTRIM.SDK.RecordType.AuditDeleteEventsOffline
getset

Gets or sets a boolean value to indicate that when a record of this type is deleted, there should be an entry added to the offline audit log.

bool HP.HPTRIM.SDK.RecordType.AuditModifyEventsOffline
getset

Gets or sets a boolean value to indicate that when a record of this type is modified, there should be an entry added to the offline audit log.

AuthorizationMethods HP.HPTRIM.SDK.RecordType.AuthorizationMethod
getset

Gets or sets an AuthorizationMethods enumerated value indicating how documents should be authorized.

int HP.HPTRIM.SDK.RecordType.AuthorizerReminderDays
getset

Gets or sets a number value indicating how many days should pass before sending a reminder about completing the authorization process for a document (0 = don't issue reminders).

TrimURIList HP.HPTRIM.SDK.RecordType.Authorizers
getset

Gets or sets a list of locations representing the default authorizers of a document when using the Document Review feature

bool HP.HPTRIM.SDK.RecordType.BelongsToAMatter
getset

Gets or sets a boolean value indicating whether records of this type need to be associated with a matter before being created.

int HP.HPTRIM.SDK.RecordType.BorrowingLimit
getset

Gets or sets a number of days that should be used to limit borrowing of physical records. When this value is set to a non-zero value, whenever a record is moved from it's home location, a due for return date is calculated based on the number of days specified for the borrowing limit

bool HP.HPTRIM.SDK.RecordType.CanAddToNotes
get
bool HP.HPTRIM.SDK.RecordType.CanHaveSharePointItems
getset

Gets or sets a boolean value indicating whether records of this type can be SharePoint List Item records, as designeated by the HPE Content Manager SharePoint Integration.

bool HP.HPTRIM.SDK.RecordType.CanModifyExistingNotes
get
bool HP.HPTRIM.SDK.RecordType.ChangeTitleWhenReadOnly
getset

Gets or sets a Boolean value indicating whether users without 'Modify Record' permission are allowed to change the free text title for records of this Record Type.

GeneralExceptionHandling HP.HPTRIM.SDK.RecordType.CheckDuplicateTitles
getset

Gets or sets a geGeneralExceptionHandling enum value indicating how HPE Content Manager should behave upon saving a record of this record type with a title that has already been used for another record. Note: Checking for Duplicate Titles only occurs if the records Indexing Event has been processed.

RecordTypeAutoSubFolders HP.HPTRIM.SDK.RecordType.ChildAutoSubFolders
get

Get the list of Automatic Sub Folders

Classification HP.HPTRIM.SDK.RecordType.Classification
getset

Gets or sets a classification that is the starting point for any classification attached to records of this Record Type. If the ClassificationMandatory property is set to true, all Records must be within this Classification.

bool HP.HPTRIM.SDK.RecordType.ClassificationMandatory
getset

Gets or sets a Boolean value indicating whether users will be forced to create records of this Record Type within the starting classification held in the Classification property. This property is enabled only when the Record Type has a starting classification.

RecordClass HP.HPTRIM.SDK.RecordType.ClassOfRecord
getset

Gets or sets an rcRecordClass enum value indicating the default Record Class for records of this Record Type. A Record may be categorised as either Vital, Corporate (default value), Workgroup, Personal, Reference or Temporary.

bool HP.HPTRIM.SDK.RecordType.CompressPartNumber
getset

Gets or sets a Boolean value indicating whether the Part Number will be compressed (displayed without any leading zeros). (Note for COM developers, use the SetPartNumberingDetails method to set the value of this property).

bool HP.HPTRIM.SDK.RecordType.ConfirmEachNumber
getset

Gets or sets a Boolean value indicating whether a dialog will be displayed when a record of this Record Type is saved, to confirm the record number.

ContainmentRule HP.HPTRIM.SDK.RecordType.ContainerRule
getset

Gets or sets a ContainmentRule enumerated value indicating the business rule for what is a suitable container for records of this type

TrimURIList HP.HPTRIM.SDK.RecordType.ContainerTypes
getset

Gets or sets a list of record types representing the list of valid record types that can be containers of this record type. Use this with the ContainerRule value of ByList

ContainmentRule HP.HPTRIM.SDK.RecordType.ContentsRule
getset

Gets or sets a ContainmentRule enumerated value indicating the business rule for what sort of contents can be added to a container record of this type

TrimURIList HP.HPTRIM.SDK.RecordType.ContentsTypes
getset

Gets or sets a list of record types representing the list of valid record types that can be contains of a container record of this record type. Use this with the ContentsRule value of ByList

TrimDateTime HP.HPTRIM.SDK.RecordType.DateActiveFrom
get
TrimDateTime HP.HPTRIM.SDK.RecordType.DateActiveTo
get
int HP.HPTRIM.SDK.RecordType.DaysDue
getset

Gets or sets an integer containing the number of days until due. If creating documents that require an action to be performed within a certain time period from the date of registration, set the value of this property to the number of business days that are to be calculated until the due date. This property is only activated when the RecordType.SetDueDateFromActions property is false, whereupon the Date Due field will operate independently of Action Tracking or Workflow.

TrimAccessControlList HP.HPTRIM.SDK.RecordType.DefaultAccessControlList
getset
Jurisdiction HP.HPTRIM.SDK.RecordType.DefaultJurisdiction
getset

Gets or sets the default jurisdiction of this record type. A record type can either have a default jurisdiction or a default jurisdiction group.

Record HP.HPTRIM.SDK.RecordType.DefaultSeries
getset

Gets or sets the default series record for any record created using this Record Type. The default series should be a valid series record, that is a record of a RecordType with UsualBehaviour 'bhSeries'. This property is only activated when the RecordType.WithinSeries property is set to 'true'.

RecordDisp HP.HPTRIM.SDK.RecordType.Disposition
getset

Gets or sets a rdRecordDisp enum value indicating the default disposition for records of this Record Type

int HP.HPTRIM.SDK.RecordType.EditorReminderDays
getset

Gets or sets a number value indicating how many days should pass before sending a reminder about completing the drafting process for a document (0 = don't issue reminders).

bool HP.HPTRIM.SDK.RecordType.EndUsersCanModify
getset

Gets or sets a boolean value indicating whether users without 'Modify Record' permission can update record metadata if the record is not finalized. Users must have the Document Update permission.

EsoActionType HP.HPTRIM.SDK.RecordType.EsoActionType
getset

Gets or sets a esoActionType enumeration value indicating what type of action to perform on documents when they are selected for Inactive Record Management

bool HP.HPTRIM.SDK.RecordType.EsoAllowEvents
getset

Gets or sets whether documents can be moved to other storage by the event processor

EsoDateType HP.HPTRIM.SDK.RecordType.EsoDateType
getset

Gets or sets the date field used to select candidate documents for Inactive Record Management

bool HP.HPTRIM.SDK.RecordType.EsoEnable
getset

Gets or sets whether this record type support Electronic Inactive Record Management

int HP.HPTRIM.SDK.RecordType.EsoMonths
getset

Gets or sets the number of months to pass before a document is eligible for Inactive Record Management

ElectronicStore HP.HPTRIM.SDK.RecordType.EsoStoreUri
getset

Gets or sets the electronic store an inactive document is moved to

int HP.HPTRIM.SDK.RecordType.EsoYears
getset

Gets or sets the number of years to pass before a document is eligible for Inactive Record Management

ElectronicStore HP.HPTRIM.SDK.RecordType.EStore
getset

Gets or sets the ElectronicStore object used to store electronic attachments to records of this Record Type. Setting this property to an existing non-default Electronic Store will automatically replace any previous value for the RecordType.StoreType property with 'tsUseStore'.

int HP.HPTRIM.SDK.RecordType.ExtensionLimit
getset

Gets or sets a number of days that should be used to limit extension of borrowing of physical records. When this value is set to a zero value, there is no extension allowed

string HP.HPTRIM.SDK.RecordType.ExternalId
getset

Gets or sets a string containing the External Identification Number for this Record Type. This identifier cannot be changed through the HPE Content Manager user interface and so guarantees your program a reliable handle to the record type aside from the URI. If this field contains a value and the Database.HideCustomRecordTypes property is set to true, then the whole record type will not be visible in the HPE Content Manager user interface.

bool HP.HPTRIM.SDK.RecordType.FinalisePreviousVersion
getset

Gets or sets a Boolean value indicating whether the previous version should be set to final (meaning no more modifications may be made) upon creation of a new version for a record of this Record Type. Any old revisions of the finalized record may be automatically removed when this occurs by setting the RecordType.PurgePreviousVersion property to 'true'.

int HP.HPTRIM.SDK.RecordType.FinalReminderDays
getset

Gets or sets a number value indicating how many days should pass before sending a reminder about completing the finalization of a document (0 = don't issue reminders).

int HP.HPTRIM.SDK.RecordType.FollowupReminderDays
getset

Gets or sets a number value indicating how many days should pass before sending a further reminder about completing an action in the review process (0 = don't issue reminders).

bool HP.HPTRIM.SDK.RecordType.HideFreeTextTitle
getset

Gets or sets a Boolean value indicating whether the Free Text Title field should be suppressed on the Data Entry Form. This is used in conjunction with the Record.AllowBlankFreeTextTitle property and only becomes active when a blank Free Text Title is allowed.

bool HP.HPTRIM.SDK.RecordType.HomeCanBeSpace
getset

Gets or sets a Boolean value indicating whether records of this Record Type are allowed to have a home location within the Space Management System.

Location HP.HPTRIM.SDK.RecordType.HomeLocation
getset

Gets or sets the default home location for records of this Record Type. The home location is traditionally used to hold the storage location of a record. If this property does not have a value, the default Location set in Tools - System Options - Locations will be assigned. Note: This Location must not have a lower Security Profile than the Record Type.

ContainerSecurityHandling HP.HPTRIM.SDK.RecordType.InsecureContainer
getset

Gets or sets a csContainerSecurityHandling enum value indicating the behavior for a record of this Record Type if it becomes an insecure container. That is if records (documents) of a higher Security Level are enclosed in a container of this Record Type which has a lower Security Level.

DocumentSecurityHandling HP.HPTRIM.SDK.RecordType.InsecureDocument
getset

Gets or sets a dsDocumentSecurityHandling enum value indicating the behavior for a record of this Record Type if it becomes an insecure document. That is if records (documents) of this Record Type with a lower Security Level are enclosed in a container of a higher Security Level.

bool HP.HPTRIM.SDK.RecordType.IsActive
get
string HP.HPTRIM.SDK.RecordType.LastNumber
getset

Gets or sets a string containing the starting number for any new records created with this Record Type. This must be set to a value that matches the numbering pattern determined by the RecordType.NumberPattern property before this RecordType object can be saved.

int HP.HPTRIM.SDK.RecordType.Level
getset

Gets or sets a number (0-9) indicating the container level allocated to this Record Type. A record may only contain records of a lower level number.

MediaTypes HP.HPTRIM.SDK.RecordType.MediaType
getset

Gets or sets a MediaTypes enumerated value to indicate the default media type for records of this record.

bool HP.HPTRIM.SDK.RecordType.MoveWhenReadOnly
getset

Gets or sets a Boolean value indicating whether users with no 'Modify Record' permission are allowed to move (change Assignee) records of this Record Type.

new string HP.HPTRIM.SDK.RecordType.Name
getset

Gets or sets a string containing the name of this Record Type.

bool HP.HPTRIM.SDK.RecordType.NeedsAuthorizationProcess
getset

Gets or sets a boolean property indicating where records of this type should be subject to an authorization process before being finalized.

bool HP.HPTRIM.SDK.RecordType.NeedsClassification
get

Gets a boolean value indicating whether records of this type need to have a classification provided as part of the record creation process

bool HP.HPTRIM.SDK.RecordType.NeedsReviewProcess
getset

Gets or sets a boolean property indicating where records of this type should be subject to a review process before being finalized.

AutoPartRule HP.HPTRIM.SDK.RecordType.NewPartCreationRule
getset

Gets or sets the default Automated Part Rule used by records of this Record Type which governs the automated closure and creation of new record parts based on predefined criteria.

string HP.HPTRIM.SDK.RecordType.Notes
getset
NotesInsertStyles HP.HPTRIM.SDK.RecordType.NotesInsertStyle
getset

Gets or sets an niNotesInsertStyle enum value indicating how notes should be added to the notes field on records of this Record Type. The possible styles are: only at the top, only at the bottom, or either at the top or the bottom.

RecordType HP.HPTRIM.SDK.RecordType.NumberFromType
getset

Gets or sets a RecordType object whose numbering pattern and starting number this Record Type shares.

bool HP.HPTRIM.SDK.RecordType.NumberingIsManual
get

Gets a Boolean value indicating whether the numbering of records using this Record Type requires manual input.

NumberingMethods HP.HPTRIM.SDK.RecordType.NumberMethod
getset

Gets or sets an nmNumberingMethods enum value indicating whether records of this Record Type should be numbered by container, by a numbering pattern, or by copying the numbering pattern of another Record Type. To number based on Classification, include one of the characters 'P' or 'S' within the number pattern set via the RecordType.NumberPattern property.

string HP.HPTRIM.SDK.RecordType.NumberPattern
getset

Gets or sets the number pattern for this Record Type. It establishes the form of the record number for records created using this Record Type. The RecordType.LastNumber property must also be set before the RecordType can be saved.If the Record Type is to be numbered by classification, one of the characters 'P' or 'S' must be included within the number pattern. If the number pattern includes a 'P', (along with any of the alphabetic characters), the record number will be generated from the Record Numbering Pattern defined in the Classification.RecPattern property for this classification, and no RecordType.LastNumber property needs to be set. If it includes an 'S' (in which case some alphabetic and some numeric characters must also be specified within the number pattern), the record number will be generated in the usual way for record numbers, with the full classification level number replacing the 'S' character. For more information on the characters used to create a numbering pattern, refer to the HPE Content Manager Help File.

OldVersionPurgeOptions HP.HPTRIM.SDK.RecordType.OldVersionPurgeStyle
getset

Gets or sets a oldVersionPurgeOptions enumeration value indicating whether old revisions of the previous version for records of this Record Type should be removed when the a new version is created upon creation of a new version. This property is activated when the RecordType.FinalizePreviousVersion is set to true.

Location HP.HPTRIM.SDK.RecordType.OwnerLocation
getset

Gets or sets the default owner location for records of this Record Type. The owner location traditionally has responsibility for a record. Only users that belong to the owner location of a record can initially set its access controls. Note: This Location must not have a lower Security Profile than the Record Type.

string HP.HPTRIM.SDK.RecordType.PartSeparator
getset

Gets or sets a string which separates the Record Number from the Part Number of any parts created for records of this Record Type. (Note for COM developers, use the SetPartNumberingDetails method to set the value of this property).

bool HP.HPTRIM.SDK.RecordType.PreventDispChangeIfNoSchedule
getset

Gets or sets a Boolean value indicating whether the record's disposition is prevented from being changed if it does not have an attached schedule.

PsoActionType HP.HPTRIM.SDK.RecordType.PsoActionType
getset

Gets or sets a psoActionType enumeration value indicating what type of action to perform on records when they are selected for Inactive Record Management

RecordType HP.HPTRIM.SDK.RecordType.PsoBoxRTY
getset

Gets or sets the record type that will be used to create boxes during the inactive physical record management process

PsoDateType HP.HPTRIM.SDK.RecordType.PsoDateType
getset

Gets or sets the date field used to select physical candidate records for Inactive Record Management

bool HP.HPTRIM.SDK.RecordType.PsoEnable
getset

Gets or sets whether this record type support Inactive Record Management

int HP.HPTRIM.SDK.RecordType.PsoMonths
getset

Gets or sets the number of months to pass before a physical record is eligible for Inactive Record Management

Location HP.HPTRIM.SDK.RecordType.PsoNewHomeLoc
getset

Gets or sets the new home location of a physical inactive record

int HP.HPTRIM.SDK.RecordType.PsoYears
getset

Gets or sets the number of years to pass before a physical record is eligible for Inactive Record Management

bool HP.HPTRIM.SDK.RecordType.PurgePreviousVersion
getset

You should use the oldversionPurgeStyle property instead.

FormDefinition HP.HPTRIM.SDK.RecordType.RecordPropertiesFormDefinition
getset

Gets or sets the form definition used for editing records of this type.

bool HP.HPTRIM.SDK.RecordType.ResetAtYearEnd
getset

Gets a Boolean value indicating whether any automatic component of this Record Type's numbering pattern will restart at number one at the beginning of a new year.

Schedule HP.HPTRIM.SDK.RecordType.RetentionSchedule
getset

Gets or sets the Schedule object which is the default Retention Schedule to be attached to new records of this Record Type. Setting a value for this property automatically sets the RecordType.UseRetention property to true.

int HP.HPTRIM.SDK.RecordType.ReviewerReminderDays
getset

Gets or sets a number value indicating how many days should pass before sending a reminder about completing the review process for a document (0 = don't issue reminders).

TrimURIList HP.HPTRIM.SDK.RecordType.Reviewers
getset

Gets or sets a list of locations representing the default reviewers of a document when using the Document Review feature

RecordType HP.HPTRIM.SDK.RecordType.SapContainerRecordType
getset

Gets or sets the default Record Type to be used when creating containers for SAP documents.

bool HP.HPTRIM.SDK.RecordType.SapCreateContact
getset

Gets or sets a boolean value indicating whether the SAP interface should create contacts (for customer ID) when creating SAP documents.

bool HP.HPTRIM.SDK.RecordType.SapCreateContainers
getset

Gets or sets a boolean value indicating whether the SAP interface should create containers (based on customer id/name) when creating SAP documents.

bool HP.HPTRIM.SDK.RecordType.SapCreateCountries
getset

Gets or sets a boolean value indicating whether the SAP interface should create a new jurisdiction if one is no found to match the supplied 'LAND1' SAP metadata value.

bool HP.HPTRIM.SDK.RecordType.SapCreateCreatorLoc
getset

Gets or sets a boolean value indicating whether the SAP interface should create a creator location when creating SAP documents.

bool HP.HPTRIM.SDK.RecordType.SapForceDeleteDate
getset

Gets or sets a boolean value indicating whether the SAP interface should override any existing retention schedule with a manual destruction date when using the delete date metadata.

string HP.HPTRIM.SDK.RecordType.SapRepositoryId
getset

Gets or sets a string value indicating if this record type is the default for the specified SAP repository

string HP.HPTRIM.SDK.RecordType.SapTitleTemplate
getset

Gets or sets a string value for the title of SAP documents created for this record type.

string HP.HPTRIM.SDK.RecordType.SapTitleTemplateKS
getset

Gets or sets a string value for the title of SAP documents created for this record type. This form is used after a call to DocumentKeysSet has been made for the new document.

bool HP.HPTRIM.SDK.RecordType.SapUseCountryCode
getset

Gets or sets a boolean value indicating whether the SAP interface should attach jurisdictions based on the SAP metadata property 'LAND1'.

bool HP.HPTRIM.SDK.RecordType.SapUseDeleteDate
getset

Gets or sets a boolean value indicating whether the SAP interface should set the manual destruction due date based on the SAP metadata property 'DEL_DATE'.

TrimSecurityProfile HP.HPTRIM.SDK.RecordType.SecurityProfile
getset
bool HP.HPTRIM.SDK.RecordType.SetDueDateFromActions
getset

Gets or sets a Boolean value indicating whether the Record.DateDue property should be updated based on the current action (Action Tracking) of the Record. If set to false, the Date Due field will operate independently of any Actions associated with the record.

string HP.HPTRIM.SDK.RecordType.SortOrder
getset

Gets or sets an alphabetic string (up to 3 characters long) by which this Record Type is sorted within the Record Types list. This is helpful if there is a large number of Record Types and there is a preferred order in which they should be displayed to the user. When the string is empty, the Record Types will be sorted alphabetically by Record Type name.

WorkflowTemplate HP.HPTRIM.SDK.RecordType.StartupTemplate
getset

Gets or sets the default Workflow Template used to initiate a new workflow whenever a new record of this Record Type is created.

UseStoreType HP.HPTRIM.SDK.RecordType.StoreType
getset

Gets or sets a tsUseStoreType enum value indicating whether the record type will use the default electronic document store, the nominated store set in the RecordType.Store property, or not use a store at all (no electronic object support for this Record Type).

bool HP.HPTRIM.SDK.RecordType.SuppressContentIndexing
getset

Gets or sets a Boolean value indicating whether HPE Content Manager should suppress document content indexing for records of this Record Type. Document content indexing enables the ability to search for records in HPE Content Manager by words that occur inside the attached electronic documents.

TitlingMethods HP.HPTRIM.SDK.RecordType.TitlingMethod
getset

Gets or sets a tmTitlingMethod enum value indicating the default titling method for records of this Record Type. A record may be titled by: Free Text (default) in which there is no controlled list of values for the title the user sets; Classification in which record titles are created according to a hierarchical Classification system; Thesaurus (ISO Standard) in which titles are created according to a hierarchical word list of standard terms; Thesaurus (Descriptor) in which titles are created with any thesaurus terms, as long as the first term is a top term; or Client in which titles contain a Location name at the start of the title.

Icons HP.HPTRIM.SDK.RecordType.TrimIconId
getset

Gets or sets a number indicating the style of icon that will depict records of this type throughout HPE Content Manager.

bool HP.HPTRIM.SDK.RecordType.UseCensus
getset

Gets or sets a Boolean value indicating whether records of this Record Type will be tracked during a census. The object of a Census is to create an accurate count of records assigned to a particular location during a defined date/time period.

bool HP.HPTRIM.SDK.RecordType.UsePartNumber
getset

Gets or sets a Boolean value indicating whether this Record Type should use part numbering. (Note for COM developers, use the SetPartNumberingDetails method to set the value of this property).

bool HP.HPTRIM.SDK.RecordType.UseRetention
getset

Gets or sets a Boolean value indicating whether a Retention Schedule may be attached to records of this Record Type.

FieldDefinitionList HP.HPTRIM.SDK.RecordType.UserFields
get
RecordBehaviour HP.HPTRIM.SDK.RecordType.UsualBehaviour
getset

Gets or sets a bhRecordBehaviour enum value determining the general behavior for records of this Record Type. The record may behave like a Document, used to catalog/register individual documents that may then be placed on file; Folder, used to create records that will contain documents or other records; Series, used to link records with disparate metadata; Box, used to contain records (usually for archival purposes); Folder (Paper Only), used to create paper based records; Document Template, a Word Template used in HPE Content Manager's Document Assembly module; or Content Block, an individual document section used within HPE Content Manager's Document Assembly module.

bool HP.HPTRIM.SDK.RecordType.VersionNumbering
getset

Gets or sets a Boolean value indicating whether version numbering should be used when creating new versions for records of this Record Type. A new version of a document is registered as a record in its own right with a link to its previous version. This is different from a revision, which gets attached to the same record.

bool HP.HPTRIM.SDK.RecordType.WithinSeries
getset

Gets or sets a Boolean value indicating whether records of this Record Type should be placed within a series. The RecordType.DefaultSeries property is only activated upon setting this property to true.