A submission made to be included in the agenda of a meeting More...

Inheritance diagram for HP.HPTRIM.SDK.AgendaItem:

Public Member Functions
	AgendaItem (Database database, TrimURI uri)

	AgendaItem (Database database, string name)

AgendaItem	NewAgendaItem (AgendaItemType agendaType, string itemDescription)

MinuteItem	NewMinuteItem (MinuteItemType itemTypeForTemplate)

MinuteItem	NewMotion (MinuteItemType itemTypeForTemplate)

MinuteItem	NewMinuteItemOrMotion (bool isMotion, MinuteItemType itemTypeForTemplate)

void	RescheduleItem (Meeting meetingToReceiveThisItem)

AgendaItem	CarryForwardItem (Meeting meetingToReceiveNewItem)

void	SetDocument (string fromFileName)
	Set the document associated with this Trim object as a copy of the supplied file name More...

void	LoadDocumentIntoClientCache ()
	Loads the document associated with this object into the client document cache, if one is available. More...

string	GetDocumentPathInClientCache (Events logAccessAs)
	Gets the path to a copy of the document associated with this object within the client document cache - logs access according to the supplied history log type. More...

string	GetDocumentPathInWGSCache (Events logAccessAs)

ExtractDocument	GetExtractDocument ()

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
int	AgendaItemOrderNumber `[get, set]`
	Gets or sets the order number for determining where this item should appear within the agenda. More...

bool	Approved `[get]`
	Gets a boolean value indicating whether this agenda item has been approved More...

AgendaItem	CarriedForwardFromItem `[get]`
	Gets the agenda item which this item is carried forward from. More...

TrimDateTime	DateApproved `[get, set]`
	Gets or sets the date and time that this agenda item was approved. More...

TrimDateTime	DateSubmitted `[get, set]`
	Gets or sets the date and time that this agenda item was submitted. More...

MinuteItemType	DefaultMinuteItemType `[get]`
	Gets the default minute item type that will be used when creating minute items from this agenda item. More...

string	Description `[get, set]`
	Gets or sets a string containing the name of this agenda item. More...

TrimDateTime	DocDateModified `[get]`
	Gets the date and time when the electronic document associated with this object was last modified. More...

string	DocExtension `[get]`
	Gets a string containing the extension (file type) of the electronic document associated with this object. More...

long	DocSize `[get]`
	Gets a string containing the extension (file type) of the electronic document associated with this object. More...

ElectronicStore	DocStore `[get]`
	Gets the document store object which is used to store the document associated with this object. More...

string	DocStoreId `[get]`
	Gets a string containing the store id used for locating the document associated with this item inside a document store. More...

string	ExpandedNumber `[get]`
	Gets or sets a string containing the fully expanded unique number of this agenda item. More...

bool	IsPending `[get]`
	Gets a boolean value indicating whether this agenda item is a pending item not yet allocated to a meeting. More...

bool	IsSection `[get]`
	Gets a boolean value indicating whether this agenda item is a section heading with subordinate items. More...

bool	IsStanding `[get]`
	Gets a boolean value indicating whether this agenda item is a standing item (for a meeting type) or a normal agenda item. More...

AgendaItemType	ItemType `[get]`
	Gets the type of agenda item. More...

Location	NeedsApprovalBy `[get, set]`
	Gets or sets the location that needs to approve this agenda item. More...

string	Number `[get]`
	Gets a string containing the unique number of this agenda item. More...

string	OutlineNumber `[get, set]`
	Gets or sets a string containing the outline number calculated as part of the agenda formatting process. More...

AgendaItem	ParentAgendaItem `[get]`
	Gets the parent agenda item which this item is a subordinate of. More...

Meeting	ParentMeeting `[get]`
	Gets the meeting that this agenda item belongs to. More...

MeetingType	ParentMeetingType `[get]`
	Gets the meeting template that this agenda item belongs to. More...

Location	PrimaryLocation `[get]`
	Gets a location object which is the attachment of type location with the lowest sequence number. More...

Record	PrimaryRecord `[get]`
	Gets a record object which is the attachment of type record with the lowest sequence number. More...

Location	SubmittedBy `[get, set]`
	Gets or sets the location that submitted this agenda item. More...

AgendaItemAttachments	ChildAttachments `[get]`
	Get the list of Agenda Item Attachments More...

TrimAccessControlList	AccessControlList `[get, set]`

bool	IsDocumentInClientCache `[get]`

string	DocumentPathInClientCache `[get]`

string	DocumentPathInWGSCache `[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...

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

Properties inherited from HP.HPTRIM.SDK.ITrimDocument
bool	IsDocumentInClientCache `[get]`
	Gets a boolean value indicating whether the document associated with this object is currently inside the client document cache. More...

string	DocumentPathInClientCache `[get]`
	Gets a String value representing the path to a copy of the document associated with this object within the client document cache. For records, access is logged as a 'View'. More...

Detailed Description

A submission made to be included in the agenda of a meeting

Constructor & Destructor Documentation

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

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

Member Function Documentation

AgendaItem HP.HPTRIM.SDK.AgendaItem.CarryForwardItem ( Meeting meetingToReceiveNewItem )

string HP.HPTRIM.SDK.AgendaItem.GetDocumentPathInClientCache ( Events logAccessAs )

Gets the path to a copy of the document associated with this object within the client document cache - logs access according to the supplied history log type.

Implements HP.HPTRIM.SDK.ITrimDocument.

string HP.HPTRIM.SDK.AgendaItem.GetDocumentPathInWGSCache ( Events logAccessAs )

ExtractDocument HP.HPTRIM.SDK.AgendaItem.GetExtractDocument ( )

void HP.HPTRIM.SDK.AgendaItem.LoadDocumentIntoClientCache ( )

Loads the document associated with this object into the client document cache, if one is available.

Implements HP.HPTRIM.SDK.ITrimDocument.

AgendaItem HP.HPTRIM.SDK.AgendaItem.NewAgendaItem	(	AgendaItemType	agendaType,
		string	itemDescription
	)

MinuteItem HP.HPTRIM.SDK.AgendaItem.NewMinuteItem ( MinuteItemType itemTypeForTemplate )

MinuteItem HP.HPTRIM.SDK.AgendaItem.NewMinuteItemOrMotion	(	bool	isMotion,
		MinuteItemType	itemTypeForTemplate
	)

MinuteItem HP.HPTRIM.SDK.AgendaItem.NewMotion ( MinuteItemType itemTypeForTemplate )

void HP.HPTRIM.SDK.AgendaItem.RescheduleItem ( Meeting meetingToReceiveThisItem )

void HP.HPTRIM.SDK.AgendaItem.SetDocument ( string fromFileName )

Set the document associated with this Trim object as a copy of the supplied file name

Implements HP.HPTRIM.SDK.ITrimDocument.

Property Documentation

TrimAccessControlList HP.HPTRIM.SDK.AgendaItem.AccessControlList

getset

int HP.HPTRIM.SDK.AgendaItem.AgendaItemOrderNumber

getset

Gets or sets the order number for determining where this item should appear within the agenda.

bool HP.HPTRIM.SDK.AgendaItem.Approved

get

Gets a boolean value indicating whether this agenda item has been approved

AgendaItem HP.HPTRIM.SDK.AgendaItem.CarriedForwardFromItem

get

Gets the agenda item which this item is carried forward from.

AgendaItemAttachments HP.HPTRIM.SDK.AgendaItem.ChildAttachments

get

Get the list of Agenda Item Attachments

TrimDateTime HP.HPTRIM.SDK.AgendaItem.DateApproved

getset

Gets or sets the date and time that this agenda item was approved.

TrimDateTime HP.HPTRIM.SDK.AgendaItem.DateSubmitted

getset

Gets or sets the date and time that this agenda item was submitted.

MinuteItemType HP.HPTRIM.SDK.AgendaItem.DefaultMinuteItemType

get

Gets the default minute item type that will be used when creating minute items from this agenda item.

string HP.HPTRIM.SDK.AgendaItem.Description

getset

Gets or sets a string containing the name of this agenda item.

TrimDateTime HP.HPTRIM.SDK.AgendaItem.DocDateModified

get

Gets the date and time when the electronic document associated with this object was last modified.

string HP.HPTRIM.SDK.AgendaItem.DocExtension

get

Gets a string containing the extension (file type) of the electronic document associated with this object.

long HP.HPTRIM.SDK.AgendaItem.DocSize

get

Gets a string containing the extension (file type) of the electronic document associated with this object.

ElectronicStore HP.HPTRIM.SDK.AgendaItem.DocStore

get

Gets the document store object which is used to store the document associated with this object.

string HP.HPTRIM.SDK.AgendaItem.DocStoreId

get

Gets a string containing the store id used for locating the document associated with this item inside a document store.

string HP.HPTRIM.SDK.AgendaItem.DocumentPathInClientCache

get

string HP.HPTRIM.SDK.AgendaItem.DocumentPathInWGSCache

get

string HP.HPTRIM.SDK.AgendaItem.ExpandedNumber

get

Gets or sets a string containing the fully expanded unique number of this agenda item.

bool HP.HPTRIM.SDK.AgendaItem.IsDocumentInClientCache

get

bool HP.HPTRIM.SDK.AgendaItem.IsPending

get

Gets a boolean value indicating whether this agenda item is a pending item not yet allocated to a meeting.

bool HP.HPTRIM.SDK.AgendaItem.IsSection

get

Gets a boolean value indicating whether this agenda item is a section heading with subordinate items.

bool HP.HPTRIM.SDK.AgendaItem.IsStanding

get

Gets a boolean value indicating whether this agenda item is a standing item (for a meeting type) or a normal agenda item.

AgendaItemType HP.HPTRIM.SDK.AgendaItem.ItemType

get

Gets the type of agenda item.

Location HP.HPTRIM.SDK.AgendaItem.NeedsApprovalBy

getset

Gets or sets the location that needs to approve this agenda item.

string HP.HPTRIM.SDK.AgendaItem.Number

get

Gets a string containing the unique number of this agenda item.

string HP.HPTRIM.SDK.AgendaItem.OutlineNumber

getset

Gets or sets a string containing the outline number calculated as part of the agenda formatting process.

AgendaItem HP.HPTRIM.SDK.AgendaItem.ParentAgendaItem

get

Gets the parent agenda item which this item is a subordinate of.

Meeting HP.HPTRIM.SDK.AgendaItem.ParentMeeting

get

Gets the meeting that this agenda item belongs to.

MeetingType HP.HPTRIM.SDK.AgendaItem.ParentMeetingType

get

Gets the meeting template that this agenda item belongs to.

Location HP.HPTRIM.SDK.AgendaItem.PrimaryLocation

get

Gets a location object which is the attachment of type location with the lowest sequence number.

Record HP.HPTRIM.SDK.AgendaItem.PrimaryRecord

get

Gets a record object which is the attachment of type record with the lowest sequence number.

Location HP.HPTRIM.SDK.AgendaItem.SubmittedBy

getset

Gets or sets the location that submitted this agenda item.

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation