|
| 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 | Delete () |
| | Permanently removes this object and all its associated child objects from the database. 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...
|
| |
| bool | HasPermission (GenericPermissions prm) |
| | Checks to see if the currently logged in user has permission to perform the generic action on this object More...
|
| |
| bool | HasPropertyPermission (GenericPermissions prm, PropertyIds propId) |
| | Checks to see if the currently logged in user has permission to perform the generic action on the specified property of this object 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...
|
| |
|
| string | Comments [get, set] |
| | Gets or sets a string containing the comments as provided by the reviewer, authorizer or editor as part of the Document Review process. More...
|
| |
| TrimDateTime | DueDate [get, set] |
| | Gets or sets a datetime value indicating when a reviewer, authorizer or editor should have completed their work as part of the Document Review process. More...
|
| |
| string | Email [get] |
| | Gets a string containing the email address of this location. More...
|
| |
| string | FaxNo [get] |
| | Gets a string containing the fax number of this location. More...
|
| |
| TrimDateTime | FromDateTime [get, set] |
| | Gets or sets the date this Location was attached to the parent Record as a RecLocation. More...
|
| |
| string | IdNumber [get] |
| | Gets a string containing the unique ID number for this Location More...
|
| |
| bool | IsComplete [get, set] |
| | Gets or sets a boolean value indicating whether a reviewer, authorizer or editor has completed their work as part of the Document Review process. More...
|
| |
| bool | IsOverdue [get, set] |
| | Gets or sets a boolean value indicating whether the reviewer, authorizer or editor has not completed their work and it is past the due date. More...
|
| |
| bool | IsPrimaryContact [get, set] |
| | Gets or sets a Boolean value indicating whether this RecLocation is the primary Contact for this Record, if the RecLocation is of Location Type 'Contact'. More...
|
| |
| TrimDateTime | LatestDateTime [get, set] |
| | Gets or sets the latest date at which the parent Record was last confirmed to be physically at the Location corresponding to this RecLocation. The value of this property only differs from the Record.FromDateTime property under circumstances where the parent Record is reassigned to this Location while already the Assignee. This may happen for example during a Census, in which all Content Manager records included in the Census are reassigned to ensure the Assignee locations are up to date with the physical locations of documents within the organization. More...
|
| |
| Location? | Location [get, set] |
| | Gets or sets the base Location object corresponding to this RecLocation. More...
|
| |
| string | MobileNo [get] |
| | Gets a string containing the mobile number of this location. More...
|
| |
| new string | Name [get] |
| | Gets the string containing the sort name of the Location corresponding to this child Location. More...
|
| |
| Location? | Organization [get] |
| | Gets a location of type 'Organization' for which this location holds a relationship of type 'Member Of'. If there is more than one, it returns the location designated as the default organization. More...
|
| |
| string | OriginalName [get] |
| | Gets a string containing the original name of this location. This is the name of the location as it was when the relationship to the record was first created. More...
|
| |
| string | PAddress [get] |
| | Gets a string containing the Mailing Address of this Location. More...
|
| |
| string | PhoneNumber [get] |
| | Gets a string containing the main telephone number of the Location object corresponding to this RecLocation. Mobile, fax and home telephone numbers are held in the mobileNo, faxNo and ahPhoneNo properties, respectively. More...
|
| |
| TrimDateTime | ReturnDateTime [get, set] |
| | Gets or sets the date at which this Record is due to be returned to the previously assigned Location, if the RecLocation is of Record Location Type 'Assignee'. Else, this date is blank, meaning the property will return the value 30/12/1899 (d,m,y). More...
|
| |
| string | SAddress [get] |
| | Gets a string containing the Street Address of this Location More...
|
| |
| Space? | Space [get] |
| | Gets the base Space object corresponding to this RecLocation, if this RecLocation is a Space. More...
|
| |
| RecLocSubTypes | Status [get] |
| | Gets a lsRecLocSubTypes enum value indicating the Location status of this RecLocation. If this RecLocation is of Record Location Type 'Assignee', the status indicates whether the Record is currently at home ('At Home'), at another location ('At Location'), in a container ('In Container'), in the space system ('In Space') or at an unknown location ('Missing'). If this RecLocation is of Record Location Type 'Home', it indicates whether the Home Location is a Location ('At Location'), a container Record ('In Container'), or a Space ('In Space'). Else, this property is simply set to 'At Location', indicating that this RecLocation is a Location (and not a container, etc.). More...
|
| |
| ContactType | TypeOfContact [get, set] |
| | Gets or sets a ctContactType enum value representing the Contact Type by which this RecLocation is attached to its parent Record, if the RecLocation is of Location Type 'Contact'. The Contact Type will be one of the following: 'Author', 'Addressee', 'Representative', 'Client', 'Other' or 'Custom1' to 'Custom10'. Use the Caption Editor under Tools - Content Manager Administration in Content Manager Context to change the caption of the Custom contact types. More...
|
| |
| RecordLocationType | TypeOfRecordLocation [get] |
| | Gets a rlRecordLocationType enum value representing the Record Location Type by which this RecLocation is attached to its parent Record. The Record Location Type will be one of the following: 'Assigned To', 'Home', 'Owner', 'Creator' or 'Contact'. More...
|
| |
| string | WebPage [get] |
| | Gets a string containing the web page URL of this location. More...
|
| |
| bool | CanModifyExistingNotes [get] |
| |
| bool | CanAddToNotes [get] |
| |
| string | Notes [get, set] |
| |
| 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...
|
| |
| uint | Idx [get] |
| | Gets the position in the child object list that this child object occupies. 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...
|
| |
| bool | PossiblyHasSubordinates [get] |
| | Indicates if this object could possibly have child objects of the same type that can be displayed in a hierarchy. 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...
|
| |
Defines an association between the parent Record and a Location
Public Member Functions inherited from TRIM.SDK.TrimChildObject
1.9.1