The RecordSearch object enables TRIM records to be retrieved by creating a search expression from a number of search methods. The object has methods to allow boolean AND, OR and NOT relationships (these use the 'Reverse Polish' notation), and also the ability to set Record Type filters and sort criteria. RecordSearch instances(Searches) may also be loaded or saved More...

Inheritance diagram for HP.HPTRIM.SDK.SavedSearch:

Public Member Functions
	SavedSearch (Database database, TrimURI uri)

	SavedSearch (Database database, string name)

	SavedSearch (Database db, BaseObjectTypes type)

	SavedSearch (Database db, BaseObjectTypes type, bool isGroupHeading)

	SavedSearch (TrimMainObjectSearch search)

TrimMainObjectSearch	GetSearch ()

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 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	ActivityDueSearchIncludesAuthorization `[get, set]`
	Gets or sets a boolean parameter indicating that when searching for BS_activity% Due, include bs_activity% requiring authorization More...

bool	ActivityDueSearchIncludesEscalated `[get, set]`
	Gets or sets a boolean parameter indicating that when searching for BS_activity% Due, include escalated bs_activity% More...

bool	AnyWordContents `[get, set]`
	Gets or sets a boolean parameter indicating that when using the Any Word search, include document content More...

bool	AnyWordNotes `[get, set]`
	Gets or sets a boolean parameter indicating that when using the Any Word search, include B_record% notes More...

bool	AnyWordTitle `[get, set]`
	Gets or sets a boolean parameter indicating that when using the Any Word search, include B_record% titles More...

bool	AssigneeSearchIncludesDelegates `[get, set]`
	Gets or sets a boolean parameter indicating that when searching by assignee, include delegates for current user More...

bool	AssigneeSearchIncludesGroups `[get, set]`
	Gets or sets a boolean parameter indicating that when searching by assignee, include groups for current user More...

bool	AssigneeSearchIncludesPosition `[get, set]`
	Gets or sets a boolean parameter indicating that when searching by assignee, include person's position More...

bool	CanEdit `[get, set]`
	Gets a boolean property indicating whether the current user can edit the query More...

bool	CanExecute `[get, set]`
	Gets a boolean property indicating whether the current user can execute the query More...

bool	DefaultIncludesContent `[get, set]`
	Gets or sets a boolean property indicating that when using a default record search, look for matching record document content More...

bool	DefaultIncludesNotes `[get, set]`
	Gets or sets a boolean property indicating that when using a default record search, look for matching record notes More...

bool	DefaultIncludesNumber `[get, set]`
	Gets or sets a boolean property indicating that when using a default record search, look for matching record numbers More...

bool	DefaultIncludesTitle `[get, set]`
	Gets or sets a boolean property indicating that when using a default record search, look for matching record titles More...

string	Description `[get, set]`
	Gets or sets a string value that provides a more detailed explanation of when this search should be used More...

bool	ExtendedIDOLOptimization `[get, set]`
	Gets or sets a boolean parameter indicating whether to use extended IDOL optimization when processing the query More...

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

string	FullName `[get, set]`
	Gets the full name of this search (includes any parent search name). More...

Icons	IconId `[get, set]`
	Gets or sets an Icons enumeration value to associate a standard Content Manager icon with this saved search. More...

IdolSearchStyles	IdolSearchStyle `[get, set]`
	Gets or sets an IdolSearchStyles value indicating how the IDOL engine will be used in resolving the query More...

bool	IsGrouping `[get]`
	Gets a boolean value indicating whether this search is simply a grouping level for a hierarchy, and not actually a search. More...

bool	IsOldFormat `[get]`
	Gets a boolean value indicating if this search is an old format record search. More...

bool	IsPublic `[get]`
	Gets a boolean value indicating whethe this search is a search available to all Content Manager users. More...

new string	Name `[get, set]`
	Gets or sets a string value uniquely identifying this search More...

BaseObjectTypes	ObjectType `[get]`
	Gets a BaseObjectTypes enum value indicating the type of object this search is designed to retrieve. More...

Location	Owner `[get, set]`
	Gets or sets a location value indicating the owner of this search. A null value indicates a public search. More...

SavedSearch	Parent `[get, set]`
	Gets or sets a SavedSearch to be the parent of this saved search when displaying a hierarchical view of searches More...

string	QueryString `[get, set]`
	Gets or sets a string value which defines the main criteria search. More...

ResultPostProcessingMethod	ResultPostProcessing `[get, set]`
	Gets or sets a ResultPostProcessingMethod to apply to the search results More...

string	SortString `[get, set]`
	Gets or sets a string value which defines the sorting order for the search results. More...

TrimAccessControlList	AccessControlList `[get, set]`

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

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.ITrimAccessControl
TrimAccessControlList	AccessControlList `[get, set]`
	Gets or sets the access control list attached to this object. More...

Detailed Description

The RecordSearch object enables TRIM records to be retrieved by creating a search expression from a number of search methods. The object has methods to allow boolean AND, OR and NOT relationships (these use the 'Reverse Polish' notation), and also the ability to set Record Type filters and sort criteria. RecordSearch instances(Searches) may also be loaded or saved

Constructor & Destructor Documentation

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

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

HP.HPTRIM.SDK.SavedSearch.SavedSearch	(	Database	db,
		BaseObjectTypes	type
	)

HP.HPTRIM.SDK.SavedSearch.SavedSearch	(	Database	db,
		BaseObjectTypes	type,
		bool	isGroupHeading
	)

HP.HPTRIM.SDK.SavedSearch.SavedSearch ( TrimMainObjectSearch search )

Member Function Documentation

void HP.HPTRIM.SDK.SavedSearch.AddToFavorites ( )

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

Implements HP.HPTRIM.SDK.ITrimLabels.

void HP.HPTRIM.SDK.SavedSearch.ApplyUserLabel ( UserLabel userLabelToApply )

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

Implements HP.HPTRIM.SDK.ITrimLabels.

bool HP.HPTRIM.SDK.SavedSearch.ChangePositionWithinFavorites ( LabelPositionChange positionChange )

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

Implements HP.HPTRIM.SDK.ITrimLabels.

bool HP.HPTRIM.SDK.SavedSearch.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 HP.HPTRIM.SDK.ITrimLabels.

void HP.HPTRIM.SDK.SavedSearch.DetachUserLabel ( UserLabel userLabelToDetach )

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

Implements HP.HPTRIM.SDK.ITrimLabels.

TrimMainObjectSearch HP.HPTRIM.SDK.SavedSearch.GetSearch ( )

void HP.HPTRIM.SDK.SavedSearch.RemoveFromFavorites ( )

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

Implements HP.HPTRIM.SDK.ITrimLabels.

Property Documentation

TrimAccessControlList HP.HPTRIM.SDK.SavedSearch.AccessControlList

getset

bool HP.HPTRIM.SDK.SavedSearch.ActivityDueSearchIncludesAuthorization

getset

Gets or sets a boolean parameter indicating that when searching for BS_activity% Due, include bs_activity% requiring authorization

bool HP.HPTRIM.SDK.SavedSearch.ActivityDueSearchIncludesEscalated

getset

Gets or sets a boolean parameter indicating that when searching for BS_activity% Due, include escalated bs_activity%

bool HP.HPTRIM.SDK.SavedSearch.AnyWordContents

getset

Gets or sets a boolean parameter indicating that when using the Any Word search, include document content

bool HP.HPTRIM.SDK.SavedSearch.AnyWordNotes

getset

Gets or sets a boolean parameter indicating that when using the Any Word search, include B_record% notes

bool HP.HPTRIM.SDK.SavedSearch.AnyWordTitle

getset

Gets or sets a boolean parameter indicating that when using the Any Word search, include B_record% titles

bool HP.HPTRIM.SDK.SavedSearch.AssigneeSearchIncludesDelegates

getset

Gets or sets a boolean parameter indicating that when searching by assignee, include delegates for current user

bool HP.HPTRIM.SDK.SavedSearch.AssigneeSearchIncludesGroups

getset

Gets or sets a boolean parameter indicating that when searching by assignee, include groups for current user

bool HP.HPTRIM.SDK.SavedSearch.AssigneeSearchIncludesPosition

getset

Gets or sets a boolean parameter indicating that when searching by assignee, include person's position

bool HP.HPTRIM.SDK.SavedSearch.CanEdit

getset

Gets a boolean property indicating whether the current user can edit the query

bool HP.HPTRIM.SDK.SavedSearch.CanExecute

getset

Gets a boolean property indicating whether the current user can execute the query

bool HP.HPTRIM.SDK.SavedSearch.DefaultIncludesContent

getset

Gets or sets a boolean property indicating that when using a default record search, look for matching record document content

bool HP.HPTRIM.SDK.SavedSearch.DefaultIncludesNotes

getset

Gets or sets a boolean property indicating that when using a default record search, look for matching record notes

bool HP.HPTRIM.SDK.SavedSearch.DefaultIncludesNumber

getset

Gets or sets a boolean property indicating that when using a default record search, look for matching record numbers

bool HP.HPTRIM.SDK.SavedSearch.DefaultIncludesTitle

getset

Gets or sets a boolean property indicating that when using a default record search, look for matching record titles

string HP.HPTRIM.SDK.SavedSearch.Description

getset

Gets or sets a string value that provides a more detailed explanation of when this search should be used

bool HP.HPTRIM.SDK.SavedSearch.ExtendedIDOLOptimization

getset

Gets or sets a boolean parameter indicating whether to use extended IDOL optimization when processing the query

string HP.HPTRIM.SDK.SavedSearch.FilterString

getset

Gets or sets a string value which defines filters for the search.

string HP.HPTRIM.SDK.SavedSearch.FullName

getset

Gets the full name of this search (includes any parent search name).

Icons HP.HPTRIM.SDK.SavedSearch.IconId

getset

Gets or sets an Icons enumeration value to associate a standard Content Manager icon with this saved search.

IdolSearchStyles HP.HPTRIM.SDK.SavedSearch.IdolSearchStyle

getset

Gets or sets an IdolSearchStyles value indicating how the IDOL engine will be used in resolving the query

bool HP.HPTRIM.SDK.SavedSearch.IsGrouping

get

Gets a boolean value indicating whether this search is simply a grouping level for a hierarchy, and not actually a search.

bool HP.HPTRIM.SDK.SavedSearch.IsOldFormat

get

Gets a boolean value indicating if this search is an old format record search.

bool HP.HPTRIM.SDK.SavedSearch.IsPublic

get

Gets a boolean value indicating whethe this search is a search available to all Content Manager users.

new string HP.HPTRIM.SDK.SavedSearch.Name

getset

Gets or sets a string value uniquely identifying this search

BaseObjectTypes HP.HPTRIM.SDK.SavedSearch.ObjectType

get

Gets a BaseObjectTypes enum value indicating the type of object this search is designed to retrieve.

Location HP.HPTRIM.SDK.SavedSearch.Owner

getset

Gets or sets a location value indicating the owner of this search. A null value indicates a public search.

SavedSearch HP.HPTRIM.SDK.SavedSearch.Parent

getset

Gets or sets a SavedSearch to be the parent of this saved search when displaying a hierarchical view of searches

string HP.HPTRIM.SDK.SavedSearch.QueryString

getset

Gets or sets a string value which defines the main criteria search.

ResultPostProcessingMethod HP.HPTRIM.SDK.SavedSearch.ResultPostProcessing

getset

Gets or sets a ResultPostProcessingMethod to apply to the search results

string HP.HPTRIM.SDK.SavedSearch.SortString

getset

Gets or sets a string value which defines the sorting order for the search results.

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation