HP.HPTRIM.SDK.Hold Class Reference

Describes a restriction that may be could be applied to one or more Records, usually related to ongoing legal action More...

Inheritance diagram for HP.HPTRIM.SDK.Hold:

Public Member Functions
	Hold (Database database, TrimURI uri)
	Hold (Database database, string name)
	Hold (Database database)
long	AddRecords (string recordSelectionString)
	Adds a set of records to this hold. Provides an efficient way for adding multiple records to a hold. Returns the number of records that were added to the hold (the ErrorMessage property will contain an information message describing this in more detail). More...
long	AddRecords (string recordSelectionString, bool addOnlineAuditEntryForEachRecord, bool addOfflineAuditEntryForEachRecord)
	Adds a set of records to this hold. Provides an efficient way for adding multiple records to a hold. Returns the number of records that were added to the hold (the ErrorMessage property will contain an information message describing this in more detail). This version allows you to specify how the audit entries are generated. More...
long	RemoveRecords (string recordSelectionString)
	Removes a set of records from this hold. Provides an efficient way for removing multiple records from a hold. Returns the number of records that were removed from the hold (the ErrorMessage property will contain an information message describing this in more detail). More...
long	RemoveRecords (string recordSelectionString, bool addOnlineAuditEntryForEachRecord, bool addOfflineAuditEntryForEachRecord)
	Removes a set of records from this hold. Provides an efficient way for removing multiple records from a hold. Returns the number of records that were removed from the hold (the ErrorMessage property will contain an information message describing this in more detail). This version allows you to specify how the audit entries are generated. More...
long	RemoveAllRecords ()
	Removes all records from this hold. Provides an efficient way for removing all records from a hold. Returns the number of records that were removed from the hold (the ErrorMessage property will contain an information message describing this in more detail). More...
long	RemoveAllRecords (bool addOnlineAuditEntryForEachRecord, bool addOfflineAuditEntryForEachRecord)
	Removes all records from this hold. Provides an efficient way for removing all records from a hold. Returns the number of records that were removed from the hold (the ErrorMessage property will contain an information message describing this in more detail). This version allows you to specify how the audit entries are generated. 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...
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...
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...
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 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	AffectsDispositionOnly [get, set]
	Gets or sets a Boolean value indicating whether this Hold only affects disposition changes for the record. That is, when a Hold with this property set to true is applied to a record, a user may not change the disposition of the record, nor delete it or any attached electronic document. The record will be available for other modifications, however. If the property is set to false then only the assignee field can be changed for the period of the hold. More...
Location	Contact [get, set]
	Gets or sets a Location object which is the nominated contact location for the Hold. More...
string	ExternalId [get, set]
	Gets or sets a string value indicating the name of an external system that has created this hold. External holds require special permissions to be removed from records. More...
new string	Name [get, set]
	Gets or sets a string containing the name of this Hold object. More...
string	SearchCriteria [get, set]
	Gets or sets a string containing a record search string used to identify records selected for this hold.. More...
TrimDateTime	SearchLastRunOn [get, set]
	Gets or sets a datetime which indicates when a search for records was last executed for this hold. More...
bool	CanModifyExistingNotes [get]
bool	CanAddToNotes [get]
string	Notes [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...
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 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.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

Describes a restriction that may be could be applied to one or more Records, usually related to ongoing legal action

Constructor & Destructor Documentation

HP.HPTRIM.SDK.Hold.Hold	(	Database	database,
		TrimURI	uri
	)

HP.HPTRIM.SDK.Hold.Hold	(	Database	database,
		string	name
	)

HP.HPTRIM.SDK.Hold.Hold

(

Database

database

)

Member Function Documentation

long HP.HPTRIM.SDK.Hold.AddRecords

(

string

recordSelectionString

)

Adds a set of records to this hold. Provides an efficient way for adding multiple records to a hold. Returns the number of records that were added to the hold (the ErrorMessage property will contain an information message describing this in more detail).

long HP.HPTRIM.SDK.Hold.AddRecords	(	string	recordSelectionString,
		bool	addOnlineAuditEntryForEachRecord,
		bool	addOfflineAuditEntryForEachRecord
	)

Adds a set of records to this hold. Provides an efficient way for adding multiple records to a hold. Returns the number of records that were added to the hold (the ErrorMessage property will contain an information message describing this in more detail). This version allows you to specify how the audit entries are generated.

UserFieldValue HP.HPTRIM.SDK.Hold.GetFieldValue

(

FieldDefinition

userFieldType

)

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

Implements HP.HPTRIM.SDK.ITrimUserFields.

string HP.HPTRIM.SDK.Hold.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 HP.HPTRIM.SDK.ITrimUserFields.

long HP.HPTRIM.SDK.Hold.RemoveAllRecords

(

)

Removes all records from this hold. Provides an efficient way for removing all records from a hold. Returns the number of records that were removed from the hold (the ErrorMessage property will contain an information message describing this in more detail).

long HP.HPTRIM.SDK.Hold.RemoveAllRecords	(	bool	addOnlineAuditEntryForEachRecord,
		bool	addOfflineAuditEntryForEachRecord
	)

Removes all records from this hold. Provides an efficient way for removing all records from a hold. Returns the number of records that were removed from the hold (the ErrorMessage property will contain an information message describing this in more detail). This version allows you to specify how the audit entries are generated.

long HP.HPTRIM.SDK.Hold.RemoveRecords

(

string

recordSelectionString

)

Removes a set of records from this hold. Provides an efficient way for removing multiple records from a hold. Returns the number of records that were removed from the hold (the ErrorMessage property will contain an information message describing this in more detail).

long HP.HPTRIM.SDK.Hold.RemoveRecords	(	string	recordSelectionString,
		bool	addOnlineAuditEntryForEachRecord,
		bool	addOfflineAuditEntryForEachRecord
	)

Removes a set of records from this hold. Provides an efficient way for removing multiple records from a hold. Returns the number of records that were removed from the hold (the ErrorMessage property will contain an information message describing this in more detail). This version allows you to specify how the audit entries are generated.

void HP.HPTRIM.SDK.Hold.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.Hold.SetFieldValue	(	FieldDefinition	userFieldType,
		UserFieldValue	newFieldValue
	)

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

Implements HP.HPTRIM.SDK.ITrimUserFields.

void HP.HPTRIM.SDK.Hold.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.

Property Documentation

string HP.HPTRIM.SDK.Hold.ActiveDateRangeDescription

get

bool HP.HPTRIM.SDK.Hold.AffectsDispositionOnly

getset

Gets or sets a Boolean value indicating whether this Hold only affects disposition changes for the record. That is, when a Hold with this property set to true is applied to a record, a user may not change the disposition of the record, nor delete it or any attached electronic document. The record will be available for other modifications, however. If the property is set to false then only the assignee field can be changed for the period of the hold.

bool HP.HPTRIM.SDK.Hold.CanAddToNotes

get

bool HP.HPTRIM.SDK.Hold.CanModifyExistingNotes

get

Location HP.HPTRIM.SDK.Hold.Contact

getset

Gets or sets a Location object which is the nominated contact location for the Hold.

TrimDateTime HP.HPTRIM.SDK.Hold.DateActiveFrom

get

TrimDateTime HP.HPTRIM.SDK.Hold.DateActiveTo

get

string HP.HPTRIM.SDK.Hold.ExternalId

getset

Gets or sets a string value indicating the name of an external system that has created this hold. External holds require special permissions to be removed from records.

bool HP.HPTRIM.SDK.Hold.IsActive

get

new string HP.HPTRIM.SDK.Hold.Name

getset

Gets or sets a string containing the name of this Hold object.

string HP.HPTRIM.SDK.Hold.Notes

getset

string HP.HPTRIM.SDK.Hold.SearchCriteria

getset

Gets or sets a string containing a record search string used to identify records selected for this hold..

TrimDateTime HP.HPTRIM.SDK.Hold.SearchLastRunOn

getset

Gets or sets a datetime which indicates when a search for records was last executed for this hold.