A subject or functional entry used to classify (and possibly affect behaviour of) a set of Records
More...
|
| Classification (Database database, TrimURI uri) |
|
| Classification (Database database, string name) |
|
| Classification (Database database) |
|
Classification | NewLowerLevel () |
| Create a new lower classification object for this classification 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...
|
|
void | ApplyUserLabel (UserLabel userLabelToApply) |
| Creates a link between the nominated user label and this object. More...
|
|
void | DetachUserLabel (UserLabel userLabelToDetach) |
| Removes the link between the nominated user label and this object. More...
|
|
void | AddToFavorites () |
| Adds the object to the special user label called 'Favorites' More...
|
|
void | RemoveFromFavorites () |
| Removes the object from the special user label called 'Favorites' More...
|
|
bool | ChangePositionWithinFavorites (LabelPositionChange positionChange) |
| Changes the position of this object within a users list of favorite objects of this type More...
|
|
bool | ChangePositionWithinUserLabel (UserLabel label, LabelPositionChange positionChange) |
| Changes the position of this object within a users list of objects that have been labeled with the specified user label More...
|
|
UserFieldValue | GetFieldValue (FieldDefinition userFieldType) |
| Gets the value of the nominated user-defined field for this object. More...
|
|
void | SetFieldValue (FieldDefinition userFieldType, UserFieldValue newValue) |
| Sets the value of the nominated user-defined field for this object. More...
|
|
string | GetFieldValueAsString (FieldDefinition userFieldType, StringDisplayType fieldValueStringType, bool useHTMLEscapeChars) |
| Gets a string representation of a user-defined field value in a format appropriate for a specific use. 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...
|
|
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...
|
|
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...
|
|
|
Location | Approver [get, set] |
| Gets or sets a location responsible for approving this classification More...
|
|
bool | CanAttachRecords [get, set] |
| Gets or sets a boolean value indicating whether records can be attached to this classification level. More...
|
|
string | ChildLastNumber [get, set] |
| Gets or sets a string containing the id number of the last sub classification that was created. It is used as the starting point for creation of further sub classifications, and must follow the numbering pattern specified in the Classification.ChildPattern property. More...
|
|
string | ChildPattern [get, set] |
| Gets or sets a string containing the numbering pattern by which the identification number of sub classifications will be set. The starting number (last number used) is held in the Classification.ChildPatternLastNbr property. No child classifications can be created unless this pattern is defined. More...
|
|
RecordClass | ClassOfRecord [get, set] |
| Gets or sets a RecordClass enum value indicating the default record class to be applied to records of this classification. This record class will replace any default record class assigned to the record through record type. More...
|
|
bool | ContainerCreation [get, set] |
| Gets or sets a boolean value indicating whether containers should be created when auto-classifying records into this classification. More...
|
|
DateIntervalSing | ContainerDateInterval [get, set] |
| Gets or sets an enumerated value indicating whether the date range for the container should be a day, a week, a month or a year when auto-classifying records into this classification More...
|
|
bool | ContainerHasDateRange [get, set] |
| Gets or sets a boolean parameter indicating whether containers should be allocated based on a date range for contained items when auto-classifying records into this classification. More...
|
|
bool | ContainerPerOwner [get, set] |
| Gets or sets a boolean value indicating whether the classification should allocate a new container based on the Owner Location of the document being auto-classified into this classification More...
|
|
FieldDefinition | ContainerPerUserField [get, set] |
| Gets or sets a field Definition object indicating that the classification should allocate a new container based on the value of the specified user defined field when auto-classifying records into this classification More...
|
|
int | ContainerSizeThreshold [get, set] |
| Gets or sets a number which determines the maximum number of contained items for containers created when auto-classifying records into this classification More...
|
|
RecordType | ContainerType [get, set] |
| Gets or sets the record type to be used when creating containers to be used when auto-classifying records into this classification. More...
|
|
Jurisdiction | DefaultJurisdiction [get, set] |
| Gets or sets the default jurisdiction of this classification. A classification can either have a default jurisdiction or a default jurisdiction group. More...
|
|
Location | HomeLocation [get, set] |
| Gets or sets the default home location for records of this Classification. The home location is traditionally used to hold the storage location of a record. This Location will replace any default home location assigned to the record through record type. More...
|
|
string | IdNumber [get] |
| Gets a string containing the unique identification number for this Classification. This number uniquely identifies the Classification amongst all other Classifications. It consists of the level number (Classification.LevelNumber) for this Classification preceded by the level numbers of all the parent classifications in this classification's hierarchy. The number will appear compressed (any leading zeros removed) if the numbering pattern for this classification involves upper case numeric characters. The numbering pattern for this Classification is held in the ChildPattern property of its parent classification. More...
|
|
string | IdNumberUncompressed [get] |
| Gets a string containing the expanded form of the unique identification number for this Classification. This consists of the expanded level number (Classification.LevelNumberUncompressed) for this Classification preceded by the expanded level numbers of all the Classification terms in this Classification's hierarchy. More...
|
|
long | IdolCategory [get, set] |
| Gets or sets the IDOL category ID associated with this classification - used for category traning and automatic classification. More...
|
|
bool | IsApproved [get, set] |
| Gets or sets a boolean value indicating that this classification has been approved for use in classifying records. More...
|
|
string | LevelNumber [get, set] |
| Gets or sets a string containing the level number for this Classification. This number uniquely identifies the Classification amongst the other Classification levels of the same parent Classification. The level number will appear compressed (any leading zeros removed) if the numbering pattern for this classification involves upper case numeric characters. The numbering pattern for this Classification is held in the ChildPattern property of its parent Classification. More...
|
|
string | LevelNumberUncompressed [get, set] |
| Gets or sets a string containing the expanded form of the level number for this Classification. This number uniquely identifies the Classification amongst the other classification levels of the same parent classification. More...
|
|
int | MinimumConfidenceLevel [get, set] |
| Gets or sets a number value (1-100) indicating the minimum confidence level attained before this classification can be selected for Auto-Classification More...
|
|
new string | Name [get, set] |
| Gets or sets a string containing the name of this Classification object. This is the name of this Classification level alone, for example 'General' (sub classification in the 'Accommodation - Domestic - General' hierarchy). More...
|
|
bool | NumberingIsManual [get] |
| Gets a Boolean value indicating whether the numbering of records using this Classification requires manual input. More...
|
|
RecordType | OnlyRecordType [get, set] |
| Gets or sets the default record type associated with this classification. 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. This Location will replace any default owner location assigned to the record through record type. More...
|
|
Classification | ParentClassification [get] |
| Gets or sets the parent classification for this classification. Top level classifications do not have a parent classification. When setting the ParentClassification, a number of default values will be inherited from the parent, so you should set this property first on any new classification. More...
|
|
bool | PendingAutoClassification [get, set] |
| Gets or sets a boolean property indicating whether this classification is used as a holding bay for the auto classification processor More...
|
|
string | PolicyCentreGUID [get, set] |
| Gets or sets a GUID value indicating the unique identifier for this classification in the Policy Centre integration More...
|
|
bool | PreventAutoClassification [get, set] |
| Gets or sets a boolean property indicating whether this classifiication is excluded from the set of classifications used by the Auto-Classification tool More...
|
|
string | RecordLastNumber [get, set] |
| Gets or sets a string containing the starting number for any new records created with this Classification, if they are numbered by classification. This should be set to a value that matches the numbering pattern determined by the Classification.RecPattern property. More...
|
|
string | RecordPattern [get, set] |
| Gets or sets a string containing the numbering pattern by which the record number for records created with this Classification should be set, if the records are numbered by classification. The starting number (last number used) is held in the Classification.RecPatternLastNbr property. No records can be created from this level unless this pattern is defined. More...
|
|
Schedule | RetentionSchedule [get, set] |
| Gets or sets a Schedule object which is the Retention Schedule that should be applied to records of this Classification. This Retention Schedule will replace any default schedule assigned to the record through record type. More...
|
|
string | Title [get] |
| Gets a string containing the title of this Classification object, used as the generated part of the title when titling records by classification. It consists of the name of this Classification level (held in the Classification.Name property) preceded by the names of all the Classification terms in this Classification's hierarchy. For example, 'Accommodation - Domestic - General' is the title of the Classification with name 'General'. More...
|
|
ClassificationSapBusinessObjects | ChildSapBusinessObjects [get] |
| Get the list of SAP Business Object Links 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...
|
|
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...
|
|
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...
|
|
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...
|
|
TrimSecurityProfile | SecurityProfile [get, set] |
| Gets or sets the security profile attached to this object. More...
|
|
TrimAccessControlList | AccessControlList [get, set] |
| Gets or sets the access control list attached to this object. More...
|
|
TrimAccessControlList | DefaultAccessControlList [get, set] |
| Gets or sets the default reference or copied access control list attached to this object. More...
|
|
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...
|
|
A subject or functional entry used to classify (and possibly affect behaviour of) a set of Records