Describes a consignment that is used to perform disposal actions on one or more Records
More...
|
| | Consignment (Database database, TrimURI uri) |
| | The basic constructor for a new consignment. More...
|
| |
| | Consignment (Database database, string name) |
| | This form of the consignment constructor allows you to specify to use the special aggregated box selection style. More...
|
| |
| | Consignment (Database database, ConsignmentDisposalType initializeAsType, TrimDateTime cutoffDate, TrimMainObjectSearch recordSubSelection, bool onlyScheduledDisposals, bool includeRecordsBeyondScheduledDisposal, bool includeRecordsOnHold, bool requireOwnerApproval, bool requireOwnerAdministratorApproval) |
| | This form of the consignment constructor allows you to specify a list of extra approvers. More...
|
| |
| | Consignment (Database database, ConsignmentDisposalType initializeAsType, TrimDateTime cutoffDate, bool useBoxSelectionStyle, TrimMainObjectSearch recordSubSelection, bool includeRecordsOnHold, bool requireOwnerApproval, bool requireOwnerAdministratorApproval) |
| | This form of the consignment constructor allows you to specify to use the special aggregated box selection style and also a list of extra approvers. More...
|
| |
| | Consignment (Database database, ConsignmentDisposalType initializeAsType, TrimDateTime cutoffDate, TrimMainObjectSearch recordSubSelection, bool onlyScheduledDisposals, bool includeRecordsBeyondScheduledDisposal, bool includeRecordsOnHold, bool requireOwnerApproval, bool requireOwnerAdministratorApproval, LocationList extraLocationsToApprove) |
| |
| | Consignment (Database database, ConsignmentDisposalType initializeAsType, TrimDateTime cutoffDate, bool useBoxSelectionStyle, TrimMainObjectSearch recordSubSelection, bool includeRecordsOnHold, bool requireOwnerApproval, bool requireOwnerAdministratorApproval, LocationList extraLocationsToApprove) |
| |
| void | RemoveRecord (Record recordToRemove) |
| | Removes the specified record from this consignment. More...
|
| |
| void | RunExaminationProcess () |
| | Executes what could be a long running process to examine all records in the consignment for issue More...
|
| |
| void | SetArchivistReviewComplete () |
| | Updates the consignment to indicate that archivist review activity is complete. Note, all issues need to be resolved before this can be done. More...
|
| |
| void | PrepareForTransfer (RecordType logRecordType, Record logContainer) |
| | First step of disposal processing for Transfers - initializes the log record and sets the status of the consignment to be waiting for the acknowledgement of receipt of the consignment by the agency the data is being transferred to. More...
|
| |
| void | CompleteTransfer (bool deleteRecordMetadata, TrimDateTime dateTimeConsignmentReceived) |
| | Second step of disposal processing for Transfers - updates the consignment with the supplied receipt date and then completes the disposal operation. More...
|
| |
| void | DoDisposal (bool deleteRecordMetadata, RecordType logRecordType, Record logContainer) |
| | Performs the disposal operation for this consignment, use this for Archive or Destroy, you can also use it for Transfers that do not need to be acknowledged 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...
|
| |
| 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...
|
| |
|
| TrimDateTime | AckTransferDate [get] |
| | Gets the date from which this Consignment Transfer was acknowledged. More...
|
| |
| bool | AllowOnHold [get] |
| | Gets a flag to indicate whether the initial record selection will include records that are currently on hold. More...
|
| |
| bool | AllowOutsideSchedule [get] |
| | Gets a flag to indicate whether the initial record selection will include record with a disposal schedule contradicting the cutoff date or method of this consignment More...
|
| |
| Location | Archivist [get, set] |
| | Gets or sets the archivist responsiible for this consignment More...
|
| |
| bool | AuthenticateApprovals [get, set] |
| | Gets a boolean value indicating whether consignment approvers need to re-authenticate before they can approve a consignment. More...
|
| |
| bool | AutoRenderToPDF [get, set] |
| | Gets or sets a boolean property indicating if the records in this consignment should be rendered to long term storage format More...
|
| |
| TrimDateTime | CutoffDate [get] |
| | Gets the date from which this Consignment is cutoff. More...
|
| |
| TrimDateTime | DateApproved [get] |
| | Gets the date that all records were approved (or rejected and removed) by the record approvers. More...
|
| |
| TrimDateTime | DateAutoExamined [get] |
| | Gets the date that all records were automatically examined for issues. More...
|
| |
| TrimDateTime | DateRejected [get] |
| | Gets the date that the consignment was rejected by one or more approvers. More...
|
| |
| TrimDateTime | DateReviewed [get] |
| | Gets the date that the archivist has completed the review of the consignment records. More...
|
| |
| string | Description [get, set] |
| | Gets a string containing a description of this Consignment More...
|
| |
| TrimDateTime | DisposalDate [get] |
| | Gets the date from which this Consignment Disposal was executed. More...
|
| |
| ConsignmentDisposalType | DisposalMethod [get] |
| | Gets a consignmentDisposalType enumerated value indicating how the items within this consignment will be disposed. More...
|
| |
| bool | DoApprovals [get] |
| | Gets a boolean value indicating whether the records within this consignment need to be approved for disposal. More...
|
| |
| string | FilterString [get] |
| | Gets a string value which defines filters for the search. More...
|
| |
| bool | IsComplete [get] |
| | Gets a boolean flag to indicate whether this consignment is now complete. More...
|
| |
| Record | LogRecord [get] |
| | Gets the record that has the logfile of the disposal processing More...
|
| |
| long | NbrApprovers [get] |
| | Gets the number of approvers currently assigned to this consignment. More...
|
| |
| long | NbrApproversPending [get] |
| | Gets the number of approvers that have not completed their approval process More...
|
| |
| long | NbrDisposalErrors [get] |
| | Gets the number of records that failed to be disposed do to errors in disposal processing More...
|
| |
| long | NbrDisposed [get] |
| | Gets the number of records that were successfully disposed as part of the processing of this consignment More...
|
| |
| long | NbrIssuesNow [get] |
| | Gets the number of records currently proposed for consignment that have an issue More...
|
| |
| long | NbrRecordsNow [get] |
| | Gets the number of records currently proposed for consignment More...
|
| |
| long | NbrRecordsStart [get] |
| | Gets the number of records originally selected for consignment More...
|
| |
| long | NbrRejected [get] |
| | Gets the number of records that were rejected from the consignment by consignment approvers More...
|
| |
| long | NbrRejectedNeedConfirm [get] |
| | Gets the number of rejected records still requiring confirmation of removal from the consignment More...
|
| |
| long | NbrRemoved [get] |
| | Gets the number of records that were removed from the consignment by the archivist More...
|
| |
| string | Number [get, set] |
| | Gets or sets a string containing the name of this Hold object. More...
|
| |
| bool | OnlyScheduledDisposal [get] |
| | Gets a flag to indicate whether the initial record selection will be limited to only records that have been scheduled for the disposal type of this consignment and earlier than the cutoff date. More...
|
| |
| bool | OwnerApproval [get] |
| | Gets a boolean flag to indicate whether the approval should be sought from the owners of the selected records before disposing. More...
|
| |
| string | QueryString [get] |
| | Gets a string value which defines the main criteria search. More...
|
| |
| bool | SelectingTopContainers [get] |
| | Gets a boolean value indicating whether the initial record selection should use the top container aggregation search style. More...
|
| |
| bool | SignedApprovals [get, set] |
| | Gets a boolean value indicating whether consignment approvers need to digitally sign an approval document. More...
|
| |
| ConsignmentState | Status [get] |
| | Gets a ConsignmentStates enumerated vale indicating the current state of the consignment. More...
|
| |
| Location | TransferLocation [get, set] |
| | Gets or sets a Location object representing the place where records are to be transferred for this Consignment (only applies when disposal method is Transfer). More...
|
| |
| bool | UseOwnerAdminForApproval [get] |
| | Gets a boolean flag to indicate whether the approval should be sought from the administrator of the owner Locations (if the owner location has an administrator). More...
|
| |
| bool | UseScheduleTransferLocation [get, set] |
| | Gets or sets a boolean property indicating if a custody trasfer should use the location specified in retention schedule More...
|
| |
| bool | WaitingAcknowledgement [get] |
| | Gets a boolean flag to indicate whether the consignment is currently waiting for acknowledgement of a successful transfer. More...
|
| |
| Properties inherited from HP.HPTRIM.SDK.TrimMainObject |
| TrimDateTime | LastUpdatedOn [get] |
| | Returns the date and time that changes to this object were last committed. More...
|
| |
| Location | LastUpdatedBy [get] |
| | Returns the user that committed the most recent change to this object. 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...
|
| |
| 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...
|
| |
Describes a consignment that is used to perform disposal actions on one or more Records
1.8.11 
