Describes a template for a type of consignment. Templates allow for the automated creation of Consignments More...

Inheritance diagram for TRIM.SDK.ConsignmentTemplate:

Public Member Functions
	ConsignmentTemplate (Database database, TrimURI uri)
	Constructs a consignment template of the specified disposal type More...

	ConsignmentTemplate (Database database, string name)

	ConsignmentTemplate (Database fromDB, ConsignmentDisposalType cdt)

bool	ShouldCheckForIssue (DisposalIssue errorType)
	Gets a boolean value indicating whether the record examination process should check for an error of the nominated type. More...

void	SetShouldCheckForIssue (DisposalIssue errorType, bool shouldCheck)
	Allows you to specify whether the record examination process should check for an error of the nominated type. 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...

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...

Public Member Functions inherited from TRIM.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...

virtual void	Reindex (bool doWordIndex, bool doAdditionalFields, bool doContentEngine)
	Sends an indexing request to the event processor to update main text index on the object, indexes for additional fields or indexes for the content engine. More...

Public Member Functions inherited from TRIM.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...

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...

Public Member Functions inherited from TRIM.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	AllowOnHold `[get, set]`
	Gets a flag to indicate whether the initial record selection will include records that are currently on hold. More...

bool	AllowOutsideSchedule `[get, set]`
	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 consignments 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 consignmenst should be rendered to long term storage format More...

bool	BasicRecordsOnly `[get, set]`
	Gets or sets a boolean property indicating if consignments are only for archiving records with basic metadata only. More...

TriggerRounding	CutoffRounding `[get, set]`
	Gets or sets a TriggerRounding enumerated value indicating how to round up cutoff dates when creating a consignment. More...

string	Description `[get, set]`
	Gets a string containing a description of this type of consignment More...

ConsignmentDisposalType	DisposalMethod `[get]`
	Gets a consignmentDisposalType enumerated value indicating how the items within consignments will be disposed. More...

bool	ExcludeXDMSRecords `[get, set]`
	Gets or sets a boolean property indicating whether consignments specifically exclude any XDMS records. More...

string	FilterString `[get, set]`
	Gets a string value which defines filters for the search. More...

bool	KeepTransferredDocuments `[get, set]`
	Gets or sets a boolean property indicating whether the electronic document should be kept if the disposal is a transfer of custody. More...

bool	NeedsTransferAck `[get, set]`
	Gets or sets a boolean property indicating whether consignments require acknowledgement from the transfer location before final disposal can take place. More...

string	NumberPrefix `[get, set]`
	Gets or sets a string containing the number prefix to use when generating consignments based on this template. More...

bool	OnlyScheduledDisposal `[get, set]`
	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, set]`
	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, set]`
	Gets a string value which defines the main criteria search. More...

ConsignmentReportLayoutType	ReportLayoutType `[get, set]`
	Gets a ConsignmentReportLayoutType enumerated value indicating where to obtain the default consignment report layout from. More...

bool	SelectingTopContainers `[get, set]`
	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...

Location?	TransferLocation `[get, set]`
	Gets or sets a Location object representing the place where records are to be transferred for consignments (only applies when disposal method is Transfer). More...

bool	UseOwnerAdminForApproval `[get, set]`
	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 transfer should use the location specified in retention schedule More...

TrimMainObjectSearch?	AdditionalSearchCriteria `[get, set]`
	Gets or sets additional record search criteria to apply on top of the standard cutoff date search More...

LocationList?	ExtraLocationsToApprove `[get, set]`
	Gets or sets a list of additional locations that will be required to approve the final disposal of consignments. More...

Properties inherited from TRIM.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...

Properties inherited from TRIM.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...

bool	PossiblyHasSubordinates `[get]`
	Indicates if this object could possibly have child objects of the same type that can be displayed in a hierarchy. More...

Properties inherited from TRIM.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...

Detailed Description

Describes a template for a type of consignment. Templates allow for the automated creation of Consignments

Constructor & Destructor Documentation

◆ ConsignmentTemplate() [1/3]

TRIM.SDK.ConsignmentTemplate.ConsignmentTemplate	(	Database	database,
		TrimURI	uri
	)

Constructs a consignment template of the specified disposal type

◆ ConsignmentTemplate() [2/3]

TRIM.SDK.ConsignmentTemplate.ConsignmentTemplate	(	Database	database,
		string	name
	)

◆ ConsignmentTemplate() [3/3]

TRIM.SDK.ConsignmentTemplate.ConsignmentTemplate	(	Database	fromDB,
		ConsignmentDisposalType	cdt
	)

Member Function Documentation

◆ AddToFavorites()

void TRIM.SDK.ConsignmentTemplate.AddToFavorites ( )

Adds the object to the special user label called 'Favorites'

Implements TRIM.SDK.ITrimLabels.

◆ ApplyUserLabel()

void TRIM.SDK.ConsignmentTemplate.ApplyUserLabel ( UserLabel userLabelToApply )

Creates a link between the nominated user label and this object.

Implements TRIM.SDK.ITrimLabels.

◆ ChangePositionWithinFavorites()

bool TRIM.SDK.ConsignmentTemplate.ChangePositionWithinFavorites ( LabelPositionChange positionChange )

Changes the position of this object within a users list of favorite objects of this type

Implements TRIM.SDK.ITrimLabels.

◆ ChangePositionWithinUserLabel()

bool TRIM.SDK.ConsignmentTemplate.ChangePositionWithinUserLabel	(	UserLabel	userLabelToChange,
		LabelPositionChange	positionChange
	)

Changes the position of this object within a users list of objects that have been labeled with the specified user label

Implements TRIM.SDK.ITrimLabels.

◆ DetachUserLabel()

void TRIM.SDK.ConsignmentTemplate.DetachUserLabel ( UserLabel userLabelToDetach )

Removes the link between the nominated user label and this object.

Implements TRIM.SDK.ITrimLabels.

◆ GetFieldValue()

UserFieldValue TRIM.SDK.ConsignmentTemplate.GetFieldValue ( FieldDefinition userFieldType )

Gets the value of the nominated user-defined field for this object.

Implements TRIM.SDK.ITrimUserFields.

◆ GetFieldValueAsString()

string TRIM.SDK.ConsignmentTemplate.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.

Implements TRIM.SDK.ITrimUserFields.

◆ RemoveFromFavorites()

void TRIM.SDK.ConsignmentTemplate.RemoveFromFavorites ( )

Removes the object from the special user label called 'Favorites'

Implements TRIM.SDK.ITrimLabels.

◆ SetFieldValue()

void TRIM.SDK.ConsignmentTemplate.SetFieldValue	(	FieldDefinition	userFieldType,
		UserFieldValue	newFieldValue
	)

Sets the value of the nominated user-defined field for this object.

Implements TRIM.SDK.ITrimUserFields.

◆ SetShouldCheckForIssue()

void TRIM.SDK.ConsignmentTemplate.SetShouldCheckForIssue	(	DisposalIssue	errorType,
		bool	shouldCheck
	)

Allows you to specify whether the record examination process should check for an error of the nominated type.

◆ ShouldCheckForIssue()

bool TRIM.SDK.ConsignmentTemplate.ShouldCheckForIssue ( DisposalIssue errorType )

Gets a boolean value indicating whether the record examination process should check for an error of the nominated type.

Property Documentation

◆ AdditionalSearchCriteria

TrimMainObjectSearch? TRIM.SDK.ConsignmentTemplate.AdditionalSearchCriteria

getset

Gets or sets additional record search criteria to apply on top of the standard cutoff date search

◆ AllowOnHold

bool TRIM.SDK.ConsignmentTemplate.AllowOnHold

getset

Gets a flag to indicate whether the initial record selection will include records that are currently on hold.

◆ AllowOutsideSchedule

bool TRIM.SDK.ConsignmentTemplate.AllowOutsideSchedule

getset

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

◆ Archivist

Location? TRIM.SDK.ConsignmentTemplate.Archivist

getset

Gets or sets the archivist responsiible for consignments

◆ AuthenticateApprovals

bool TRIM.SDK.ConsignmentTemplate.AuthenticateApprovals

getset

Gets a boolean value indicating whether consignment approvers need to re-authenticate before they can approve a consignment.

◆ AutoRenderToPDF

bool TRIM.SDK.ConsignmentTemplate.AutoRenderToPDF

getset

Gets or sets a boolean property indicating if the records in consignmenst should be rendered to long term storage format

◆ BasicRecordsOnly

bool TRIM.SDK.ConsignmentTemplate.BasicRecordsOnly

getset

Gets or sets a boolean property indicating if consignments are only for archiving records with basic metadata only.

◆ CutoffRounding

TriggerRounding TRIM.SDK.ConsignmentTemplate.CutoffRounding

getset

Gets or sets a TriggerRounding enumerated value indicating how to round up cutoff dates when creating a consignment.

◆ Description

string TRIM.SDK.ConsignmentTemplate.Description

getset

Gets a string containing a description of this type of consignment

◆ DisposalMethod

ConsignmentDisposalType TRIM.SDK.ConsignmentTemplate.DisposalMethod

get

Gets a consignmentDisposalType enumerated value indicating how the items within consignments will be disposed.

◆ ExcludeXDMSRecords

bool TRIM.SDK.ConsignmentTemplate.ExcludeXDMSRecords

getset

Gets or sets a boolean property indicating whether consignments specifically exclude any XDMS records.

◆ ExtraLocationsToApprove

LocationList? TRIM.SDK.ConsignmentTemplate.ExtraLocationsToApprove

getset

Gets or sets a list of additional locations that will be required to approve the final disposal of consignments.

◆ FilterString

string TRIM.SDK.ConsignmentTemplate.FilterString

getset

Gets a string value which defines filters for the search.

◆ KeepTransferredDocuments

bool TRIM.SDK.ConsignmentTemplate.KeepTransferredDocuments

getset

Gets or sets a boolean property indicating whether the electronic document should be kept if the disposal is a transfer of custody.

◆ NeedsTransferAck

bool TRIM.SDK.ConsignmentTemplate.NeedsTransferAck

getset

Gets or sets a boolean property indicating whether consignments require acknowledgement from the transfer location before final disposal can take place.

◆ NumberPrefix

string TRIM.SDK.ConsignmentTemplate.NumberPrefix

getset

Gets or sets a string containing the number prefix to use when generating consignments based on this template.

◆ OnlyScheduledDisposal

bool TRIM.SDK.ConsignmentTemplate.OnlyScheduledDisposal

getset

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.

◆ OwnerApproval

bool TRIM.SDK.ConsignmentTemplate.OwnerApproval

getset

Gets a boolean flag to indicate whether the approval should be sought from the owners of the selected records before disposing.

◆ QueryString

string TRIM.SDK.ConsignmentTemplate.QueryString

getset

Gets a string value which defines the main criteria search.

◆ ReportLayoutType

ConsignmentReportLayoutType TRIM.SDK.ConsignmentTemplate.ReportLayoutType

getset

Gets a ConsignmentReportLayoutType enumerated value indicating where to obtain the default consignment report layout from.

◆ SelectingTopContainers

bool TRIM.SDK.ConsignmentTemplate.SelectingTopContainers

getset

Gets a boolean value indicating whether the initial record selection should use the top container aggregation search style.

◆ SignedApprovals

bool TRIM.SDK.ConsignmentTemplate.SignedApprovals

getset

Gets a boolean value indicating whether consignment approvers need to digitally sign an approval document.

◆ TransferLocation

Location? TRIM.SDK.ConsignmentTemplate.TransferLocation

getset

Gets or sets a Location object representing the place where records are to be transferred for consignments (only applies when disposal method is Transfer).

◆ UseOwnerAdminForApproval

bool TRIM.SDK.ConsignmentTemplate.UseOwnerAdminForApproval

getset

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).

◆ UseScheduleTransferLocation

bool TRIM.SDK.ConsignmentTemplate.UseScheduleTransferLocation

getset

Gets or sets a boolean property indicating if a custody transfer should use the location specified in retention schedule

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ ConsignmentTemplate() [1/3]

◆ ConsignmentTemplate() [2/3]

◆ ConsignmentTemplate() [3/3]

Member Function Documentation

◆ AddToFavorites()

◆ ApplyUserLabel()

◆ ChangePositionWithinFavorites()

◆ ChangePositionWithinUserLabel()

◆ DetachUserLabel()

◆ GetFieldValue()

◆ GetFieldValueAsString()

◆ RemoveFromFavorites()

◆ SetFieldValue()

◆ SetShouldCheckForIssue()

◆ ShouldCheckForIssue()

Property Documentation

◆ AdditionalSearchCriteria

◆ AllowOnHold

◆ AllowOutsideSchedule

◆ Archivist

◆ AuthenticateApprovals

◆ AutoRenderToPDF

◆ BasicRecordsOnly

◆ CutoffRounding

◆ Description

◆ DisposalMethod

◆ ExcludeXDMSRecords

◆ ExtraLocationsToApprove

◆ FilterString

◆ KeepTransferredDocuments

◆ NeedsTransferAck

◆ NumberPrefix

◆ OnlyScheduledDisposal

◆ OwnerApproval

◆ QueryString

◆ ReportLayoutType

◆ SelectingTopContainers

◆ SignedApprovals

◆ TransferLocation

◆ UseOwnerAdminForApproval

◆ UseScheduleTransferLocation