GZTW.AyaNova.BLL

Address object - stores physical location and/or mailing address Parent is responsible for keyword indexing

makes replacements to any characters that might be in a source string so that they conform to mapquest url specs

Get Longitude as string No indication of East / West It is up to caller to check decimal value of Longitude separately to determine if required

Format desired Return string with degrees and other symbols String representation of Longitude

Get Latitude as string No indication of North / South It is up to caller to check decimal value of latitude separately to determine if required

Format desired Return string with degrees and other symbols String representation of Latitude

Get Longitude as string Includes localized East / West indicator prefix

Format desired Return string with degrees and other symbols String representation of Longitude

Get Latitude as string Includes localized North or South text prefix

Format desired Return string with degrees and other symbols String representation of Latitude

Set Longitude from string Expects a '-' sign for West longitudes any character other than a digit, decimal (period) or a - sign is ignored completely and not used in parsing Accepted types of co-ordinates are: Decimal degrees: "-49.3435" Degree decimal minutes: "49°22.456" Degrees Minutes Seconds Decimal seconds: "49° 22' 13.456''" Degree symbols are ignored and thus optional as well as minute ' or seconds '' symbols traditionally used. All that is important is that there is a space or non-numeric character between the groups of digits. If a single number is found it is assumed to be decimal degrees. If two separate numbers are found it is assumed to be Degree decimal minutes If three separate groups of numbers are found it is assumed to be Degress minutes seconds

String indicating coordinate

Set Latitude from string Expects a '-' sign for South Latitudes any character other than a digit, decimal (period) or a - sign is ignored completely and not used in parsing Accepted types of co-ordinates are: Decimal degrees: "-49.3435" Degree decimal minutes: "49°22.456" Degrees Minutes Seconds Decimal seconds: "49° 22' 13.456''" Degree symbols are ignored and thus optional as well as minute ' or seconds '' symbols traditionally used. All that is important is that there is a space or non-numeric character between the groups of digits. If a single number is found it is assumed to be decimal degrees. If two separate numbers are found it is assumed to be Degree decimal minutes If three separate groups of numbers are found it is assumed to be Degress minutes seconds

String indicating coordinate

Parse a string coordinate and return a double coordinate value Negative symbol must be first character if a south latitude or a west longitude is input. All characters other than digits, decimal point (one only) and negative symbol are ignored. Accepted types of co-ordinates are: Decimal degrees: "-49.3435" Degree decimal minutes: "49°22.456" Degrees Minutes Seconds Decimal seconds: "49° 22' 13.456''" Degree symbols are ignored and thus optional as well as minute ' or seconds '' symbols traditionally used. All that is important is that there is a space or non-numeric character between the groups of digits. If a single number is found it is assumed to be decimal degrees. If two separate numbers are found it is assumed to be Degree decimal minutes If three separate groups of numbers are found it is assumed to be Degress minutes seconds

Co-ordinate string Double coordinate value

Convert decimal degrees to String representation of Degrees minutes seconds Negative input is not converted to West or South, all input is returned as absolute value (with no sign) it is up to the caller to add the direction.

Convert decimal degrees to String representation of Degrees minutes and decimal minutes (no seconds) Negative input is not converted to West or South, all input is returned as as absolute value (with no sign) it is up to the caller to add the direction.

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Create new Address Parent sets RootObjectID, RootObjectType and IsMailAddress flag

Get an address from passed in data reader

Delete address

Update object to database

RootOjbect type GUID of root object Address type (must be mail or physical) Parent object's transaction object

Populate this object from the values in the datareader passed to it

client, vendor, headoffice, Unit

ID of root object this address belongs to (client, vendor, headoffice, unit)

Type of address (physical street or mailing only)

User ID who created this Address record

Date this Address was created

User ID who last modified this record

Last date this Address was modified

Get/set street address - maximum 255 char

Get/set city for this address - maximum 255 char - may have default entered by global/regional settings

Get/set state or province for this address - maximum 255 char - may have default entered by global/regional settings

Get/set country for this address - maximum 255 char - may have default entered by global/regional settings

Get/set ISO country code for this country, maximum 2 characters required for all non-US address lookups

Get/set postal code or zip code for this address - maximum 255 char

Returns a valid MapQuest url for opening a map of physical address in a web page

Get complete address as single string for display following US / Canadian postal regulations recommendations: DELIVERY ADDRESS CITY/STATE/ZIP COUNTRY

Longitude in decimal degrees

Latitude in decimal degrees

Criteria for identifying existing object

Used as illegal default to ensure that parent object sets this correctly

Mailing Address

Physical street address

Appointments to display in schedule UI

Check if item in collection

Get all appointments between specified dates

Get item by index

Returns AppointmentListInfo item that matches passed in itemid value

@returns

Back color of appointment could be workorder status or schedmarker colour

Criteria for identifying existing object

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

Get new object Parent is responsible for RootObjectID, RootObjectType and DocumentID

Populate this object from the values in the datareader passed to it

Get internal id number Read only property because it's set internally, not externally

RootObject Type

RootObjectID

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Set/get Description of item

URL for document This could be an internet URL, a UNC path and file name or a drive letter path filename to the file in question Basically this is anything that is understood by the Windows Shell Maximum of 4000 characters

Collection of AssignedDoc items

Remove AssignedDoc by passing it in

Remove AssignedDoc by string of id value

Remove by Guid value of ID

Add a new AssignedDoc to the collection

Check if item in collection

Check if item in collection by string of ID value

Check if item in deleted collection

Check if item in deleted collection by string of ID value

NewItems

GetItems

Fetch children

Populated data reader

Update children

Retrieve AssignedDoc by index

Index

Retrieve AssignedDoc by string containing Guid value

Utility functions and configuration connection data

Take an array of strings and return a single xml string containing unique only, lowercase keywords suitable for passing to a stored procedure or other function that can handle very plain xml Use GlobalSettings.CJKIndex=true to handle Chinese, Japanese, Korean etc (languages with no easily identifiable word boundaries as in english)

return results as XML or as a string of comma delimited words An array of 0 to * strings of text

Instantiates searchable business objects based on type and id (class factory) and processes and returns search result for that object

Take an XML fragment containing the grid criteria extract out the column order, build an ORDERBY clause and return it as a string

Takes an XML fragment containing the grid criteria extracts out the filter criteria builds a WHERE clause and returns it as a string

Translation

returns an empty string if passed in value is null or empty else returns Prepend plus passed in string followed by append string

Text to return to the left of sText string to return if not null or empty Text to return to the right of sText

Convert a string object name value to it's value in the database (prepend with a lowercase a if necessary)

Convert a string DBName value to it's object name value (remove any lowercase 'a' at start of both halves if necessary)

Rank and extract best excerpt of specified text and search terms

Do the extraction and ranking

Give a percentage score for a given window of text in the raw text string 75% of the score is the percentage of all search terms found in the window 25% of the score is the percentage of all characters in the search window that are search term characters

Float value of zero to one hundred

Extract the best scoring excerpt fragments of raw text

This is the ranking of the source text as it pertains to the search terms A rank of zero means either there was no match or the rank that was calculated was lower than the threshold ranking, either way, no excerpt extraction is done. It is a percentage value on a scale of 0 to 100 and is weighted: 75% of the score is the percentage of all search terms found in the text 25% of the score is the percentage of all characters in the text that are search term characters

Maximum characters to appear in an extraction default is 80 Minimum is 10

ExtractionThresholdRank Extraction will only take place if the rank is this value or higher default is 10, maximum is 100 minimum is 0

If true, carriage returns and line feeds will be removed from extract

Extracted text excerpt that best reflects search terms

EnumConverter supporting System.ComponentModel.DescriptionAttribute

Gets Enum Value's Description Attribute This can be called directly from anywhere to return the localized text value of an enumeration.

The value you want the description attribute for The description, if any, else it's .ToString()

Gets the description for certaing named value in an Enumeration

The type of the Enumeration The name of the Enumeration value The description, if any, else the passed name

Gets the value of an Enum, based on it's Description Attribute or named value

The Enum type The description or name of the element The value, or the passed in description, if it was not found

Used to quickly fetch a single Bool record from the db

Private constructor to prevent direct instantiation

Criteria for identifying existing object

Client

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

Returns a DataTable containing columns matching this business objects collection fields. This is used for report designer interface

Create new Client

Client

Fetch existing Client

Client Client Guid

Delete Client

Client GUID

Called by DataPortal to delete/add/update data into the database

Remove a Client record from the database but only if you are an administrator

If Service created from Client screen itself, it defaults to a specific workorder template Note this doesn't apply if you make a workorder "out of the blue" as it doesn't know who you are going to select until after the template is selected.

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Set/get client name

Get /set active status of client If active = true then client is selectable for workorders etc If active = false then client in not selectable, but history can be viewed

Get service address for this client

Get mailing address object for this client Returns GoToAddress object if MailToAddress is empty

Get Contacts collection for this object

web address of client if applicable can be null ties into hyerlink to web browser

popup notes - need a setting to indicate whether to popup only on new workorder, or popup whenever a change too Corresponds to clients.alert in AyaNova v1

Default is false If true, +mMailToAddress becomes +mMailToAddress of Head Office selected

Corresponds to clients.generalnotes in AyaNova v1

Corresponds to clients.technotes in AyaNova v1 These are notes to display on dispatch reports for tech etc

Custom1

Custom2

Custom3

Custom4

Custom5

Custom6

Custom7

Custom8

Custom9

Custom0

If true then banked service is tracked for this object (hours / money / incidents)

Contract that applies to this object or Guid.Empty if no contract

Retrieves the name of the contract for this client or an empty string if there is no contract set

Date contract expires and no longer applies or null if contract does not expire ever

Returns a DataTable containing data from this object for a report

Criteria for identifying existing object

Client group

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

Create new ClientGroup

Fetch existing ClientGroup

Datareader

Populate this object from the values in the datareader passed to it

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Set/get client group name

Get /set active status of client group If active = true then clientgroup is selectable for workorders etc If active = false then clientgroup in not selectable, but history can be viewed

Remove ClientGroup by passing it in

Add a new ClientGroup to the collection

Add ClientGroup by passing it in

Check if item in collection

Check if item in deleted collection

Get item collection

Fetch children

Editable Root Collection Update

Locale key so that generic list editor UI code knows what title to give the list in a grid

Retrieve ClientGroup by index

Index

Criteria for identifying existing object

Read only list of clients.

Check if item in collection

Returns a DataTable containing columns matching this business objects collection fields. This is used for report generation.

Takes an xml column list and where criteria and returns a list filtered and sorted accordingly

Return an empty list used for initializing grid

Get item by index

Returns display text that matches passed in itemid value

Attributes are all that user could select to be displayed

@returns

Criteria for identifying existing object

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

Get new object

Populate this object from the values in the datareader passed to it

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

User selectable data and time of note

Type of source (i.e workorder, quote, etc)

ID of the source where the note was made "from" i.e made from a workorder, it would enter the workroder number link here

Remove ClientNote by passing it in

Add a new ClientNote to the collection

Add ClientNote by passing it in

Check if item in collection

Check if item in deleted collection

Get item collection

Fetch children

Editable Root Collection Update

Locale key so that generic list editor UI code knows what title to give the list in a grid

Retrieve ClientNote by index

Index

Criteria for identifying existing object

i.e phone, fax, followup etc

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Get new object

Populate this object from the values in the datareader passed to it

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Set/get Name of item

ClientNoteType name / value list

Get ClientNoteTypeList object

Fetch name value list

Remove ClientNoteType by passing it in

Add a new ClientNoteType to the collection

Add ClientNoteType by passing it in

Check if item in collection

Check if item in deleted collection

Get item collection

Fetch children

Editable Root Collection Update

Locale key so that generic list editor UI code knows what title to give the list in a grid

Retrieve ClientNoteType by index

Index

Criteria for identifying existing object

Client name / value list

Get ClientNVList object

Fetch name value list

Client request part

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Create item

Parent ID New Item

Retrieve item

Data reader item from database

Fetch from db

Persist object to database

Parent object Parents transaction object

Initial created date of this object

User ID of who initially created this object

Last modified date of this object

User ID of who last modified this object

Unique ID of this object

Parent ID

Part ID

Price

Quantity

this is the collection of parts for this service item - whether they are reserved (not yet used), used in service, on order, or needs to be ordered.

Remove ClientRequestPart by passing it in

Remove ClientRequestPart by string of id value

Remove by Guid value of ID

Add a new ClientRequestPart to the collection

Check if item in collection

Check if item in collection by string of ID value

Check if item in deleted collection

Check if item in deleted collection by string of ID value

NewItems

Get items - Grandchild style

Fetch children - grandchild style

Update children

Given a ClientServiceRequest item ID deletes all items for that ID Called by ClientServiceRequestitem delete

ID of parent ClientServiceRequestItem Database transaction from ascendant item

Retrieve ClientRequestPart by index

Index

Retrieve ClientRequestPart by string containing Guid value

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Create item

Parent ID New Item

Retrieve item

Data reader item from database

Fetch from db

Persist object to database

Parent object Parents transaction object

Initial created date of this object

User ID of who initially created this object

Last modified date of this object

User ID of who last modified this object

Unique ID of this object

Parent ID

UserID Can assign to a scheduleable and active User without setting a scheduled time and date - for those that let tech decide when to schedule

Can assign a start and stop date without assinging to a tech - shows as "unassigned"

Can not be less than start date

this is the collection of scheduled technicians that is selected for a WorkorderItem to display along with start and stop dates (AND times)

Remove ClientRequestTech by passing it in

Remove ClientRequestTech by string of id value

Remove by Guid value of ID

Add a new ClientRequestTech to the collection

Check if item in collection

Check if item in collection by string of ID value

Check if item in deleted collection

Check if item in deleted collection by string of ID value

NewItems

Get items - Grandchild style

Fetch children - grandchild style

Update children

Given a ClientServiceRequest item ID deletes all items for that ID Called by ClientServiceRequestitem delete

ID of parent ClientServiceRequestItem Database transaction from ascendant item

Retrieve ClientRequestTech by index

Index

Retrieve ClientRequestTech by string containing Guid value

Client Service Request - created by a client through remote access when they want service Easily converts to workorder if approved for service by service manager as it has the same structure and fields but only the appropriate subset required.

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

Create new ClientServiceRequest

Fetch existing ClientServiceRequest

Client Guid

Delete ClientServiceRequest (if clients assigned to this group, should be notified)

Client GUID

Called by DataPortal to delete/add/update data into the database

Remove a ClientServiceRequest record from the database

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

GUID of project selected

GUID of priority selected

GUID of priority selected

Onsite indicates at client site Default is true Can be set in regional settings

Takes as default name in client contact list when client first selected, but can be edited by user

Custom1

Custom2

Custom3

Custom4

Custom5

Custom6

Custom7

Custom8

Custom9

Custom0

Criteria for identifying existing object

Used to quickly fetch descriptive information for identifying a client service request to user during notification processing

Private constructor to prevent direct instantiation

Criteria for identifying existing object

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

Create item

Parent ID New Item

Get Item

Fetch

Persist object to database

Parent object Parents transaction object

Called by collection and by the Update method in this object to remove all child collections and workorder item itself

Initial created date of this object

User ID of who initially created this object

Last modified date of this object

User ID of who last modified this object

Unique ID of this object

Parent ID

Brief summary (255 character maximum) description of service to be performed

ID of unit to be serviced

Priority of service to be performed

Client request workorder items collection

Remove ClientServiceRequestItem by passing it in

Remove ClientServiceRequestItem by string of id value

Remove by Guid value of ID

Add a new ClientServiceRequestItem to the collection

Check if item in collection

Check if item in collection by string of ID value

Check if item in deleted collection

Check if item in deleted collection by string of ID value

NewItems

GetItems

Fetch children

Populated data reader

Update children

Given a ClientServiceRequest ID retrieves all ClientServiceRequestItem id values for that ClientServiceRequest, then calls the child and grandchild Shared static direct delete methods to clear out those collections, then finally removes all ClientServiceRequestItems of that ClientServiceRequest ID Called by ClientServiceRequest delete

ID of parent ClientServiceRequest item Database transaction from ascendant item

Retrieve ClientServiceRequestItem by index

Index

Retrieve ClientServiceRequestItem by string containing Guid value

Contact item

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

Create new Contact Sets RootObjectID, RootObjectType

Get an Contact from passed in data reader

Update object to database

RootOjbect type GUID of root object Parent object's sql transaction object

Populate this object from the values in the datareader passed to it

Get internal id number Read only property because it's set internally, not externally

Contact's phone number collection

RootObject type

ID of root object this Contact belongs to

User ID who created this Contact record

Date this Contact was created

User ID who last modified this record

Last date this Contact was modified

Title for this contact (i.e Mr, Mrs etc)

If true, this is the primary contact for this address object If false, then not First contact entered is set to true for this address Additional contacts entered are then set to false automatically User has ability to change true and false

Email address of contact - hyperlink to email program

Job title for this contact (i.e sales manager, office staff, etc)

Guid ID of contact

The point is so that if can not list all phone numbers, this is the default number that will be displayed default is the first one entered is true, all others are false. But if another is made true, then this one becomes false Additional phone entered are then set to false automatically User has ability to change true and false

Could be phone, fax, cell etc

Default can be set from regional settings (or global settings?)

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

Create item

Parent ID New Item

Retrieve item

Data reader item from database

Fetch from db

Persist object to database

Parent object Parents transaction object

Initial created date of this object

User ID of who initially created this object

Last modified date of this object

User ID of who last modified this object

Unique ID of this object

Could be phone, fax, cell etc

Localized text of phone type

Localized text of complete phone record including descriptive name of phone type, country code etc etc

Guid ID of contact

Default can be set from regional settings (or global settings?)

The point is so that if can not list all phone numbers, this is the default number that will be displayed default is the first one entered is true, all others are false. But if another is made true, then this one becomes false Additional phone entered are then set to false automatically User has ability to change true and false

Remove ContactPhone by passing it in

Remove ContactPhone by string of id value

Remove by Guid value of ID

Add a new ContactPhone to the collection

Sets passed in phone id default to true all others to false

Iterates through collection and gets the default phone record

Ensures one contact is set to default

Check if item in collection

Check if item in collection by string of ID value

Check if item in deleted collection

Check if item in deleted collection by string of ID value

NewItems

Get items - Grandchild style

Fetch children - grandchild style

Update children

Retrieve ContactPhone by index

Index

Retrieve ContactPhone by string containing Guid value

Retrieve ContactPhone by Guid value

Used as illegal default to ensure that parent object sets this correctly

Business phone

Cell phone

Fax

Pager

Home phone

Remove Contact by passing it in

Remove Contact by string of id value

Remove by Guid value of ID

Add new

Ensures one contact is set to default

Checks if grandchildren are dirty

Checks if grandchildren are valid

Iterates through collection and sets the default contact id to true for to contact id passed in Sets any other contacts if they are primarycontact=true to false

Iterates through collection and gets the default contact

Returns a string containing the primary contact's default contact info (i.e. Email address and all phones collection)

Check if item in collection

Check if item in collection by string of ID value

Check if item in deleted collection

Check if item in deleted collection by string of ID value

NewItems

GetItems

Fetch children

Populated data reader

Update

Retrieve Contact by index

Index

Retrieve Contact by string containing Guid value

Retrieve Contact by Guid value

Type of phone number i.e telephone, fax, cell, pager, radio

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Get new object

Populate this object from the values in the datareader passed to it

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Set/get Name of item

ContactTitle name / value list

Get ContactTitleList object

Fetch name value list

Remove ContactTitle by passing it in

Add a new ContactTitle to the collection

Add ContactTitle by passing it in

Check if item in collection

Check if item in deleted collection

Get item collection

Fetch children

Editable Root Collection Update

Locale key so that generic list editor UI code knows what title to give the list in a grid

Retrieve ContactTitle by index

Index

Criteria for identifying existing object

Contract

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

Create new Contract

Contract

Fetch existing Contract

Contract Contract Guid

Delete Contract

Contract GUID

Called by DataPortal to delete/add/update data into the database

Remove a Contract record from the database but only if you are an administrator

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Get /set active status of Contract If active = true then Contract is selectable for workorders etc If active = false then Contract in not selectable, but history can be viewed

Notes about Contract

Original sales Name number

Most businesses will enter in a discount that a unit receives that is applied to parts to cut down on the entry involved with this, as then you could enter in the discount % once, but it would get applied to any part selected for this unit without having to enter in the actual price for every single part. (note if client has a discount, and unit has a discount - the discount on the unit overrides if the unit is selected in the workorder)

Collection of rates that are accessible for this contract

Default = false If true user can select rate from general rateslist rather than the ones specifically set for this contract

Custom1

Custom2

Custom3

Custom4

Custom5

Custom6

Custom7

Custom8

Custom9

Custom0

Criteria for identifying existing object

Read only list of Contracts.

Check if item in collection

Get all Contract (filtered by crit)

Return an empty list used for initializing grid

Get item by index

Returns display text that matches passed in itemid value

Attributes are all that user could select to be displayed

@returns

Criteria for identifying existing object

Rate that is selected to be in a contract. By default only rates selected will be selectable within a service item, or can set to allow all but with these identified as part of contract

Guid ID of root object (contract)

ID of rate (this brings over the name, account number, etc check with john if need more

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Create item

Parent ID New Item

Retrieve item

Data reader item from database

Fetch from db

Persist object to database

Parent object Parents transaction object

Initial created date of this object

User ID of who initially created this object

Last modified date of this object

User ID of who last modified this object

Unique ID of this object

Guid ID of root object (contract)

ID of rate (this brings over the name, account number, etc check with john if need more

Contract rates collection

Remove ContractRate by passing it in

Remove ContractRate by string of id value

Remove by Guid value of ID

Add a new ContractRate to the collection

Check if item in collection

Check if item in collection by string of ID value

Check if item in deleted collection

Check if item in deleted collection by string of ID value

NewItems

GetItems

Fetch children

Populated data reader

Update children

Retrieve ContractRate by index

Index

Retrieve ContractRate by string containing Guid value

Decimal degrees (DDD.ddd°)

Degrees minutes (DDD° MM.mmm)

Degrees Minutes Seconds (DDD° MM' SS.sss')

Various DB helpers to save duplication in individual business objects

Return a reader based on query with no parameters

SQL query

Return a reader based on query and ID parameter

SQL with single ID paramter ID of record desired

Return a reader based on query and ID parameter and database transaction

SQL with single ID paramter ID of record desired Database transaction

Return a single object value based on query and ID parameter (returns first column of first row as Object)

SQL with single ID paramter ID of record desired

Return a single object value based on query and ID parameter (returns first column of first row as Object) Within the specified transaction

SQL with single ID paramter ID of record desired Database transaction

Return a single object value based on query (returns first column of first row as Object)

SQL

Return a DB generated sequential identity number

Field containing ID value Table name Guid of record desired 32bit sequential integer identity value

Insert keywords into search tables

if false then clears any existing keywords out of dictionary first

Used by every object indexed with keywords to delete that objects keywords from the search dictionary when that object is deleted under the same transaction

Used by every object with Assigned documents to delete that objects documents when that object is deleted under the same transaction

Check for record being changed by another user while they were editing it separately

Transaction version, called by editableroot collections to avoid timeout on conflict

Dispatch zone

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

Create new DispatchZone

DispatchZone

Fetch existing DispatchZone

DispatchZone Datareader

Populate this object from the values in the datareader passed to it

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Get /set active status of DispatchZone If active = true then DispatchZone is selectable for workorders etc If active = false then DispatchZone in not selectable, but history can be viewed

Description about DispatchZone

Original sales Name number

List of DispatchZones for building pick lists Includes inactive so that they can be shown on old records in a consistent format

Check if item in collection

Get all scheduleable users

Get item by index

Returns DispatchZonePickListInfo item that matches passed in itemid value

@returns

Criteria for identifying existing object

Remove DispatchZone by passing it in

Add a new DispatchZone to the collection

Add DispatchZone by passing it in

Check if item in collection

Check if item in deleted collection

Get item collection

Fetch children

Editable Root Collection Update

Locale key so that generic list editor UI code knows what title to give the list in a grid

Retrieve DispatchZone by index

Index

Criteria for identifying existing object

Manages a set of event windows for a week Serializable for easy saving to database / file etc Easily confirms if a given date/time is within an allowable window or not

Sets an event for day indicated.

int value of DayOfWeek enum (0=Sunday...6=Saturday) true=deliver any time of day if active True=day is enabled for deliver, false=no delivery on this day Starting time window for delivery (time only is used date is irrelevant) Ending time window for delivery (time only is used date is irrelevant)

Returns true if a given date/time is within an event window. False if not.

An event window structure this is added to an array of structures to cover a week of day windows

Generic name / value list

Get GenericNVList object

Fetch name value list

Criteria for identifying existing object

Generic name / value list

Get GenericSQLNVList object

Fetch name value list

Criteria for identifying existing object

Global settings

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Global Guid

Called by DataPortal to delete/add/update data into the database

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Get service address for this client

Get mailing address object for this client Returns GoToAddress object if MailToAddress is empty

Default is true (allow) False means if schedule coflicts occurs, it gives a pop up message indicating so that you need to change it. True means it gives a popup letting you know, but lets you go ahead with schedule. We do not have an option to turn off popup as should purchase enough licenses to cover all users.

Default is false If true, displays region settings and fields If false, still uses a default region behind the scenes so "ready" to go to use regions

Default tax for selling parts

Default purchase tax code for parts

Default tax for selling services / rates

Status that identifies when a workorder is completed Used internally by the program for some functions.

Reset starting number for auto incrementing workorder number Can only be set higher than current seed value

Reset starting number for auto incrementing quote number Can only be set higher than current seed value

write only Reset starting number for auto incrementing Purchase Order number Can only be set higher than current seed value

write only Reset starting number for auto incrementing InventoryAdjustment number Can only be set higher than current seed value

Template for displaying information about a workorder compactly in summary form on calendars and in lists and reports

Default is false If true, activates AyaNova inventory tracking and features

Indexing style to use for AyaNova internal search engine Default is false. If data entry is primarily in a language with no spacing or punctuation to identify the boundaries between words (Chinese, Japanese, Korean, Thai etc) then setting this value to true will use a 2 character segmentation system In all other languages with spacing and/or punctuation this value should be false to ensure most accurate word indexing

Default for how old in minutes a workorder has to be and not be closed before it's considered "stale" (for purposes of notification and display in some lists) This is used to catch forgotten workorders. This value is used to set the default CloseByDate by date/time in a service workorder.

Default is false If true, activates AyaNova notification feature and causes biz objects to check for notification events and process them as part of their normal updating routines

Criteria for identifying existing object

Global settings ex

Private constructor to prevent direct instantiation

Called by DataPortal to delete/add/update data into the database

Get/Set global data

View global data in human readable format

Criteria for identifying existing object

Object item representing a cell of data that is not directly read from a corresponding database record column. Used to redirect sorting and filtering in the grid to another sql field

A simple lightweight name/value item that can be inserted into a grid

A lightweight cell item that is used to display relative time and is identified as such so it can be sorted by it's base field

Head office

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

Returns a DataTable containing columns matching this business objects collection fields. This is used for report designer interface

Create new HeadOffice

HeadOffice

Fetch existing HeadOffice

HeadOffice HeadOffice Guid

Delete HeadOffice

HeadOffice GUID

Called by DataPortal to delete/add/update data into the database

Remove a HeadOffice record from the database but only if you are an administrator

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Set/get HeadOffice name

Get /set active status of HeadOffice If active = true then HeadOffice is selectable for workorders etc If active = false then HeadOffice in not selectable, but history can be viewed

Get service address for this HeadOffice

Get mailing address object for this HeadOffice Returns GoToAddress object if MailToAddress is empty

Get Contacts collection for this object

web address of HeadOffice if applicable can be null ties into hyerlink to web browser

Corresponds to clients.generalnotes in AyaNova v1

Custom1

Custom2

Custom3

Custom4

Custom5

Custom6

Custom7

Custom8

Custom9

Custom0

If true then banked service is tracked for this object (hours / money / incidents)

Contract that applies to this object or Guid.Empty if no contract

Date contract expires and no longer applies or null if contract does not expire ever

Returns a DataTable containing data from this object for a report

Criteria for identifying existing object

Read only list of HeadOffices.

Check if item in collection

Takes an xml column list and where criteria and returns a list filtered and sorted accordingly

Return an empty list used for initializing grid

Get item by index

Returns display text that matches passed in itemid value

Attributes are all that user could select to be displayed

@returns

Criteria for identifying existing object

LoanItem

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

Create new LoanItem

LoanItem

Fetch existing LoanItem

LoanItem LoanItem Guid

Delete LoanItem

LoanItem GUID

Called by DataPortal to delete/add/update data into the database

Remove a LoanItem record from the database but only if you are an administrator

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Get /set active status of LoanItem If active = true then LoanItem is selectable for workorders etc If active = false then LoanItem in not selectable, but history can be viewed

Notes about unit

Set/get Loan item name

Custom1

Custom2

Custom3

Custom4

Custom5

Custom6

Custom7

Custom8

Custom9

Custom0

Criteria for identifying existing object

List of Locales defined in localtextinfo table

Check if item in collection

Get item by index

Attributes are all that user could select to be displayed

Criteria for identifying existing object

Any text displayed to the user will be held here.

Calculated checksum of the data contained in the business object to handle mult- user concurrency

i.e English, French, Spanish, German

i.e "wo.category"

i.e "Category"

i.e "Workorder Category"

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property

Root version of new item

Child version of new item

Get Item - Editable root version

Get item - Child version

Delete LocalizedText Item

Populate this object from the values in the datareader passed to it

Called by DataPortal to delete/add/update data into the database Editable root version

Update - Child version

Remove a Localized Text record from the database

i.e "Category"

i.e "Workorder Category"

i.e "wo.category"

i.e English, French, Spanish, German

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Criteria for identifying existing object

Remove LocalizedText by passing it in

Add a new LocalizedText to the collection

Add LocalizedText by passing it in

Check if item in collection

Check if item in deleted collection

Get item collection (Root collection style) Gets all localized text in database (no filter)

Get custom field items only for object specified used when customizing custom fields for objects that have 'em (Root collection style)

Object to retrieve the custom fiels for

Fetch children root style

Editable Root Collection Update

Locale key so that generic list editor UI code knows what title to give the list in a grid

Retrieve LocalizedText by index

Index

Criteria for identifying existing object

Used internally by LocalizedTextTable for static get text direct method this ensures dataportal friendliness

Private constructor to prevent direct instantiation

Load the localized text string for the Key provided

Localized text key i.e. "Address.Label.City"

Load the localized text string for the Key provided from the Locale provided

Localized text key i.e. "Address.Label.City" Locale key, i.e. "English"

Criteria for identifying existing object

Holds the localized text for use by user interface

Private constructor to prevent direct instantiation

returns the localized text for the key provided from the in-memory Hashtable If key not found, returns key back

Load the localized text for the local provided

Text key of locale i.e. "English", "Francais", "Espanol", "Klingon" etc

Given a LocalizedText key queries the database and returns the localized text This is used by the biz objects for reporting errors and for retrieving object names for reporting purposes It is not used by the UI which has a copy of this entire object instatiated for the lifetime of the UI code This is necessary because in a Remote DataPortal situation the biz objects at the server will not have access to an in-memory copy of the entire localized text table. (note that this method subcontracts this call to a dataPortal friendly fetcher class

Given a LocalizedText key and Locale queries the database and returns the localized text string for that key and locale This is used by the biz objects for reporting errors and for retrieving object names for reporting purposes It is not used by the UI which has a copy of this entire object instatiated for the lifetime of the UI code This is necessary because in a Remote DataPortal situation the biz objects at the server will not have access to an in-memory copy of the entire localized text table. (note that this method subcontracts this call to a dataPortal friendly fetcher class

Criteria for identifying existing object

Perform common AyaNova maintenance work

Private constructor to prevent direct instantiation

Erases all optional data in the database except for required elements

Backs up database to path and file specified

Get internal id number Read only property because it's set internally, not externally

Criteria for ops

AyaNova Memo between AyaNova users used to create new Memo message only

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

Get new object

Memo Guid

Delete Memo

Memo GUID

Called by DataPortal to delete/add/update data into the database

Remove a Memo record from the database

Get internal id number Read only property because it's set internally, not externally

Get created date

Set created date only used for importing

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Set/get Subject of item Required, can't be empty

Set/get Subject of item

From whom

To whom

Viewed - user has read the message

Criteria for identifying existing object

Update eMemo messages

Used to quickly fetch a single lightweight read only Memo record from the db

Private constructor to prevent direct instantiation

Generate a new memo as a Reply or Forward based on this fetched read only memo

If true, this is a forward reply to don't set the toID just yet A memo object with fields filled in ready for typing reply/forward text

Fetch Memo of indicated ID, using specific language for formatting headers etc.

Fetch Memo of indicated ID

Get internal id number Read only property because it's set internally, not externally

Get created date

Get sent date as a relative time formatted object

Set/get Subject of item

Set/get Subject of item

From whom

Replied - user has replied to the message

Viewed - user has viewed the message

Consolidated header for display and replying

From name only for notification etc.

Criteria for identifying existing object

Read only list of Memos.

Check if item in collection

Get all Memo (filtered by crit)

Return an empty list used for initializing grid

Get item by index

Returns display text that matches passed in itemid value

Attributes are all that user could select to be displayed

@returns

Criteria for identifying existing object

Used to quickly fetch a single name record from the db

Private constructor to prevent direct instantiation

Criteria for identifying existing object

List of notifications formatted for delivery and screened to be deliverable Loops through all NotifyEvenRecords For pending type events, checks to see if within users selected notification window foreach NotifyEventRecord it adds a NotificationListInfo for each open delivery window for each subscriber to that event As it processes each deliverable notification it formats it to users locale and preferences for size etc and keeps track of the address and delivery type. End result is a list ready to deliver. As each one is delivered Ok it should be deleted from the NotifyEvent table by the delivery process that uses this list.

Get all available notifications for delivery

Process an event/subscription record and insert into list Gets all the info necessary for delivery as well as for removing the notify event after sucessful delivery

Get item by index

Criteria for identifying existing object

AyaNova NotifyDeliveryLog used to insert new notification delivery events in the database. Also removes all delivery log entries more than 30 days old

Private constructor to prevent direct instantiation

Called by DataPortal to delete/add/update data into the database

Read only list of NotifyDeliveryLogs.

Get all NotifyDeliveryLog entries

True for all entries for any user, false for current logged in user's ID

Return an empty list used for initializing grid

Get item by index

Log fields

Criteria for identifying existing object

Methods of formatting the notification message Used by the delivery procesor for the specific method chosen Basically used to determine how much to condense the message.

Most compact format Messages are formatted as compactly as possible using abbreviations and as little text as possible. Most critical information first followed by increasingly less critical information.

Most verbose format As much information as possible that is relevant is included in a full text format (no abbreviations, message formatted for viewing not compactness)

Methods of delivering an AyaNova event notification to the user.

Popup message box within AyaNova user interface

SMTP - Internet email

SMS device

AyaNova memo

Notification delivery setting

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Create new NotifyDeliverySetting

NotifyDeliverySetting

Fetch existing NotifyDeliverySetting

NotifyDeliverySetting Datareader

Populate this object from the values in the datareader passed to it

Get internal id number

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Descriptive Name of delivery method

AyaNova User ID of notification delivery subscriber

Physical delivery method from built in choices of NotifyDeliveryMethods

Address for delivery could be an SMS email address, internet mail address etc Not used by all delivery methods

Desired format for message that is sent to user via method chosen

Maximum characters after which message sent to user is cut off A value of zero indicates message should *not* be truncated at all

Event windows - object containing information about when delivery can be made for this notification delivery setting

List of NotifyDeliverySettings for building pick lists

Check if item in collection

Get all delivery methods for selected user

Get item by index

Returns NotifyDeliverySettingPickListInfo item that matches passed in itemid value

@returns

Criteria for identifying existing object

Remove NotifyDeliverySetting by passing it in

Add a new NotifyDeliverySetting to the collection

Add NotifyDeliverySetting by passing it in

Check if item in collection

Check if item in deleted collection

Get item collection

Fetch children

Editable Root Collection Update

Locale key so that generic list editor UI code knows what title to give the list in a grid

Retrieve NotifyDeliverySetting by index

Index

Retrieve NotifyDeliverySetting by Guid value

Criteria for identifying existing object

AyaNova NotifyEvent used to insert new notification events in the database. Event's are processed appropriately here according to their type and purpose. This class ensures that only events subscribed to are inserted and tags them with the correct user ID for user specific subscriptions.

Private constructor to prevent direct instantiation used by all shared Add/Update methods but not by any of the remove methods

Constructor for remove all / specific event method

Object's events to be removed regardless of status 0=all events, non-zero means specific event only

Constructor for RemoveDeliveredEvent method

NotifyEvent ID to be removed

Constructor for subscription related remove events methods

Add a new event if no matching one already exists or replaces a matching existing event.

Add a new pending event if no matching one already exists or replaces an unprocessed matching existing event. If the pending until date is empty then will simply remove any existing matching pending event, otherwise will add/update it Any pre-existing matching event found is replaced.

Removes all events for a given object ID This is used within objects when they are deleted to ensure no events remain related to them. It is also used for updating objects like schedule markers where a slight change, i.e. scheduleableusergroup change could render a lot of the user specific events meaningless since the entire group of users could change with a small change in the schedulemarker. In a case like that, this method is called to wipe out the entire event list for that object and a new one is created

ID of deleted object

Removes a specific event for a given object ID This is used within objects when they are changed in some way that renders the event meaningless, i.e. if a client's contractexpires is set to empty

Removes a specific event for a specific user This is used when a user unsubscribes from a specfic event to ensure that there are no event's for that event and subscriber left floating

Removes an event that has been delivered Used by notification delivery processor to remove events that have been delivered but not touch ones that are fresh since delivery

Called by DataPortal to delete/add/update data into the database

Used for determining if an event is of interest for notification purposes

Private constructor to prevent direct instantiation

Load a fetcher for event

Check to see if there is interest in the event and object specified

Called internally by the NotifySubscription class when a user deletes or creates a notification subscription. This ensures that the EventOfInterest table is kept up to date with subscriptions

Optional event specific data

Criteria for identifying existing object

Add events of interest / update subscriber count

User interface helper methods and properties for managing subscriptions to notification events Provides lists and data tables for managing notification through the user interface

Utility list of events that can be subscribed to

NotifySubscriber - used to flag already subscribed events DataTable containing events that can be subscribed to and already subscribed events flagged as subscribed

List of Workorder statuses not already chosen in a subscribers event subscriptions for building pick lists Ensures user doesn't subscribe to same workorder status event more than once.

Check if item in collection

Get all scheduleable users

Get item by index

Returns NotifyEventWorkorderStatusPickListInfo item that matches passed in itemid value

@returns

Criteria for identifying existing object

Notify message object used for transporting notification messages from a specific object that formatted it to a delivery provider

AyaNova NotifyPopUp used to insert new notification popup messages into the queue

Private constructor to prevent direct instantiation

paramaterless constructor used for DeleteItem static method call

Delete popup message

Called by DataPortal to delete/add/update data into the database

Remove a Client record from the database but only if you are an administrator

Criteria for identifying existing object

Read only list of NotifyPopUps. Used to display popup notifications in AyaNova user interface

Get all NotifyPopUp entries for current logged in user

Return an empty list used for initializing grid

Get item by index

Fields

Criteria for identifying existing object

A user who is subscribing to notification events

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Fetch existing NotifySubscriber for indicated user ID. If one doesn't exist it will automatically be created.

NotifySubscriber

Delete NotifySubscriber for indicated user

NotifySubscriber UserID

Called by DataPortal to delete/add/update data into the database

Remove a NotifySubscriber record from the database

Get internal id number Read only property because it's set internally, not externally

Get User id Read only property because it's set on creation / fetch, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Get /set active status of NotifySubscriber

Collection of Subscriptions selected for this subscriber

Criteria for identifying existing object

Switchable (child or root), As child it is part of collection under NotifySubscriber User's selection of events they want to subscribe to being notified about

Guid ID of root object (UserID from Subscriber parent object)

TAkes the date of an event and returns true if it's within the range the user set in this subscription Used by the NotificationList object for dated type events when generating notifications to send out to users

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Used by UI code to weed out already selected delivery methods in delivery method selector forms

Create item standalone editable root version

Subscriber ID New Item

Retrieve item - Editable root version

Delete NotifySubscription Item

Create item Child version

Parent subscriber object New Item

Retrieve item

Data reader item from database

Fetch from db

Persist object to database

Parent object Parents transaction object

Called by DataPortal to delete/add/update data into the database Editable root version

Remove a record from the database

This handles deleting a subscription record and updating notifyeventofinterest accordingly It's called internally here and also by the parent collection It also removes any events that might be present in the NotifyEvent queue

Initial created date of this object

Initial created date of this object as SmartDate (used by display list)

User ID of who initially created this object

Last modified date of this object

User ID of who last modified this object

Unique ID of this object

UserID (parent SubscriberID) of this object

Get /set event publisher root object type Read only once saved

Get /set event publisher's particulare event type subscribed to Read only once saved

Get /set time span units of SpanRange for calculating event date with pending type events Can be changed after saving

Get /set time span unit of time for calculating event date with pending type events Can be changed after saving

Returns the localized text key describing the currently set notification event

If the event associated with this subscription is a type of event that the user can select a time frame for (most pending type events, but not all)

If the event associated with this subscription uses the GuidValue property then returns true.

Used by some events where an additional Int value needs to be specified in the subscription can *not* be changed after saving

Criteria for identifying existing object

Collection of delivery methods for a notification subscription

Remove by Guid value of ID

Add a new NotifySubscriptionDelivery to the collection

NewItems

Get items - Grandchild style

Fetch children - grandchild style

Update children

Given a NotifySubscription item ID deletes all delivery items for that ID Called by Subscription delete

ID of parent NotifySubscription object Database transaction from ascendant item

Retrieve NotifySubscriptionDelivery by index

Index

User selected delivery method for a single notification subscription

New

Retrieve item

Data reader item from database

Fetch from db

Persist object to database

Parents transaction object

Initial created date of this object

User ID of who initially created this object

Last modified date of this object

User ID of who last modified this object

ID of parent subscription

ID of delivery method

Summary description for NotifySubscriptionList.

Get bindable list of notification subscriptions for display (only) in grid

Return an empty list used for initializing grid

Contains a subscription record

@returns

NotifySubscriber rates collection

Remove NotifySubscription by passing it in

Remove NotifySubscription by string of id value

Remove by Guid value of ID

Add a new NotifySubscription to the collection

Check if item in collection by it's event id and root object type

Check if item in collection by it's event id, root object type AND GuidValue

Check if item in collection by string of ID value

Check if item in deleted collection

Check if item in deleted collection by string of ID value

NewItems

GetItems

Fetch children

Populated data reader

Update children

Given a Subscriber ID retrieves all Subscription id values for that subscriber, then calls the subscription Shared static direct delete method to clear out those subscriptions This is done this way to handle updating the notifyeventofinterest table properly on deletion Called by subscriber delete

ID of parent subscriber item Database transaction from ascendant item

Retrieve NotifySubscription by index

Index

Retrieve NotifySubscription by string containing Guid value

Used by Windows forms user interface to hold settings pertaining to custom fields so we know how to display them

Private constructor to prevent direct instantiation

Get new object

GetItem

Fetch

Update

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

ObjectName

FieldName

Visible

FieldType

Remove ObjectCustomField by passing it in

Check if item in collection

Check if item in deleted collection

NewItems

Fetch children root style

Editable Root Collection Update

Locale key so that generic list editor UI code knows what title to give the list in a grid

Retrieve ObjectCustomField by index

Index

Retrieve ObjectCustomField by string containing form's name value

Criteria for identifying existing object

Summary description for SearchResult.

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

Create new Part

Part

Fetch existing Part

Part Part Guid

Called by DataPortal to delete/add/update data into the database

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Set/get Part name

Get /set active status of Part If active = true then Part is selectable for workorders etc If active = false then Part in not selectable, but history can be viewed

Corresponds to Parts.generalnotes in AyaNova v1

Display warning message when part selected

Alternative wholesaler to order from if first does not have

who made it - ie 3COM

Part is made part of a category for display purposes and reporting. A way of grouping

Displays on reports and Parts screen selection. (e.g. each, per 100, per box, MBF, etc)

Who distributes is - i.e Ingram

cost dollar amt per part

retail dollar charge for part

Part number as given by the wholesaler - i.e Ingram

Part number as given by the manufacturer - could be scanned in UPC code

15 or less numeric digits as text

default = false Indicates that this part is serialized Triggers prompting for serial number when part is received in via a purchase number

part is part of an assembly null = no assembly

Custom1

Custom2

Custom3

Custom4

Custom5

Custom6

Custom7

Custom8

Custom9

Custom0

Criteria for identifying existing object

Remove PartAssembly by passing it in

Add a new PartAssembly to the collection

Add PartAssembly by passing it in

Check if item in collection

Check if item in deleted collection

Get item collection

Fetch children

Editable Root Collection Update

Locale key so that generic list editor UI code knows what title to give the list in a grid

Retrieve PartAssembly by index

Index

Criteria for identifying existing object

Assembly is an object that has a name and id that parts can be assigned to to indicate this is an assembly of those parts. It itself does not have a price as it is for group parts together for assemblies (i.e parts of a bike) as opposed to PartCategory which is to group similar parts (i.e all bikes or all sporting equipment)

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

Create new PartAssembly

Fetch existing PartAssembly

Populate this object from the values in the datareader passed to it

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Set/get client group name

Get /set active status of client group If active = true then PartAssembly is selectable for workorders etc If active = false then PartAssembly in not selectable, but history can be viewed

Remove PartByWarehouseInventory by passing it in

Add a new PartByWarehouseInventory to the collection

Add PartByWarehouseInventory by passing it in

Check if item in collection

Check if item in deleted collection

Get item collection

Fetch children

PartID

Editable Root Collection Update

Retrieve PartByWarehouseInventory by index

Index

Criteria for identifying existing object

This identifies the physical parts in stock

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Get new object

Populate this object from the values in the datareader passed to it

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

if true, does show in select list; if false then is not selectable, but can still bring up history etc default is true

Used to quickly fetch a various inventory related values for a particular part / warehouse combination. WARNING to developer API users: There are potential concurrency issues using this value in a multi-user scenario. This value is intended for read only purposes when displaying in a user interface. The actual value stored in the database is subject to change by other users updating inventory *after* this value is retrieved so it should not be used in any calculations to affect inventory in the database, those should be done through the inventory updating methods provided in other classes which are done within a database transaction with an IsolationLevel of Serializeable.

Private constructor to prevent direct instantiation

Retrieve a snapshot of current inventory values

ID of part ID of warehouse (Use Guid.Empty for default warehouse) PartByWarehouseInventoryValuesFetcher object

Retrieve a snapshot of current inventory values frozen within a transaction

ID of part ID of warehouse (Use Guid.Empty for default warehouse) Database transaction

Criteria for identifying existing object

Remove PartCategory by passing it in

Add a new PartCategory to the collection

Add PartCategory by passing it in

Check if item in collection

Check if item in deleted collection

Get item collection

Fetch children

Editable Root Collection Update

Locale key so that generic list editor UI code knows what title to give the list in a grid

Retrieve PartCategory by index

Index

Criteria for identifying existing object

This is a selectable category that a Part can be a part of. Only one category per part For reporting and displaying purposes. A way of grouping

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Get new object

Populate this object from the values in the datareader passed to it

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

if true, does show in wo select list; if false then is not selectable, but can still bring up history etc default is true

Set/get Name of item

Manual inventory adjustment

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

called by UI on change of collection of items

Create new PartInventoryAdjustment

PartInventoryAdjustment

Fetch existing PartInventoryAdjustment

PartInventoryAdjustment PartInventoryAdjustment Guid

Called by DataPortal to delete/add/update data into the database

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user record ID of person who modified this record

Effective date of adjustment (may not be entry date)

Read only DB set unique identity number

Reason for adjustment

Criteria for identifying existing object

Set the DB generated visible ID number to a new user chosen starting point

PartInventoryAdjustmentItem item

Ensures that serial number collection has as many elements as absolute value of Quantity adjustment And also ensures that all serial number items have correct part ID and Adjustment item ID set This function tries to preserve existing serial number entries as much as possible unless a Major change is indicated. this is important because user may have just selected wrong part initially, but *had* correctly entered all serial numbers

If true, then wipe all serial numbers previously entered

Sets broken rule if quantity of adjustment is unacceptible (negative quantity but no accompanying stock available) Safe to call from anywhere

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Create new PartInventoryAdjustmentItem Sets RootObjectID, RootObjectType

Get an PartInventoryAdjustmentItem from passed in data reader

Update

Populate this object from the values in the datareader passed to it

Get internal id number Read only property because it's set internally, not externally

Parent

PartID

set by collection if this item is a duplicate of another in the collection so that broken rule will be set (duplicate meaning same part id and warehouse)

User ID who created this PartInventoryAdjustmentItem record

Date this PartInventoryAdjustmentItem was created

User ID who last modified this record

Last date this PartInventoryAdjustmentItem was modified

Serial numbers collection for adjusted part, 0 to many

GUID of Warehouse this adjustment is for (Defaults to "default" warehouse in any case)

Quantity change

Remove PartInventoryAdjustmentItem by passing it in

Remove PartInventoryAdjustmentItem by string of id value

Remove by Guid value of ID

Parent Adjustment object

Checks if grandchildren are dirty

Checks if grandchildren are valid

Remove empty items (qty zero)

Sets broken rule for item if it's a duplicate in collection Only one instance of same part / warehouse allowed in collection to avoid several potential ways of damaging integrity of serial numbers and inventory

Check if item in collection

Check if item in collection by string of ID value

Check if item in deleted collection

Check if item in deleted collection by string of ID value

NewItems

GetItems

Fetch children

Populated data reader

Retrieve PartInventoryAdjustmentItem by index

Index

Retrieve PartInventoryAdjustmentItem by string containing Guid value

Retrieve PartInventoryAdjustmentItem by Guid value

Read only list of PartInventoryAdjustments.

Check if item in collection

Get all PartInventoryAdjustment (filtered by crit)

Return an empty list used for initializing grid

Get item by index

Returns display text that matches passed in itemid value

Attributes are all that user could select to be displayed

@returns

Criteria for identifying existing object

General list of parts for display / reporting in UI

Check if item in collection

Get all Part (filtered by crit)

Return an empty list used for initializing grid

Get item by index

Returns display text that matches passed in itemid value

@returns

Criteria for identifying existing object

General purpose part list for filling pick lists, displaying information about parts in various UI forms to user and performing internal calculations for costs/taxes etc at UI level

Check if item in collection

Get all Parts

Get one part

Guid of part

Get all parts from a specific vendor

Guid of vendor

Get item by index

Returns PartPickListInfo item that matches passed in itemid value

Return name in selected format

@returns

Criteria for identifying existing object

Read only list of Parts that are below their restock level by vendor. Used in purchase order entry screen.

Return an empty list used for initializing grid

Get item by index

Log fields

Criteria for identifying existing object

Dispatch zone

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Create new PartSerial

PartSerial

Fetch existing PartSerial

PartSerial Datareader

Populate this object from the values in the datareader passed to it

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Part

Warehouse

SerialNumber

set by collection if this serial number is a duplicate of another in the collection so that broken rule will be set (assumes no two partID's that are the same will have the same serial number if serialized part)

DateReceived

DateReceived internal version used by inventory affecting objects

Date consumed

WorkorderItemPartID record indicates which workorder item part record this part was used on

ID of PartInventoryAdjustmentItem object that caused the adjustment to happen

Purchase order receipt record ID Indicates which receipt this was entered from

Available for consumption

Pick list for selecting parts (primarily for work order entry)

Check if item in collection

Get all serial numbers for part and optionally for parts in warehouse selected

Part ID Warehouse ID or Guid empty for any warehouse

Get item by index

Returns PartSerialPickListInfo item that matches passed in itemid value

@returns

Criteria for identifying existing object

Remove PartSerial by passing it in

Remove PartSerial by string of id value

Remove by Guid value of ID

Add a new PartSerial to the collection

Sets broken rule for serial number item if it's a duplicate in collection

Check if item in collection

Check if item in collection by string of ID value

Check if item in deleted collection

Check if item in deleted collection by string of ID value

NewItems

Get items - Grandchild style (root object can be WorkorderItem, PurchaseOrderItem, Warehouse etc)

Fetch children - grandchild style

Update children

Retrieve PartSerial by index

Index

Retrieve PartSerial by string containing Guid value

Retrieve PartSerial by Guid value

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

Create new PartWarehouse

Fetch existing PartWarehouse

Populate this object from the values in the datareader passed to it

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Set/get client group name

Get /set active status of client group If active = true then PartWarehouse is selectable for workorders etc If active = false then PartWarehouse in not selectable, but history can be viewed

Read only list of PartInventorys.

Check if item in collection

Get all PartByWarehouseInventory (filtered by crit)

Return an empty list used for initializing grid

Get item by index

Returns display text that matches passed in itemid value

Attributes are all that user could select to be displayed

@returns

Criteria for identifying existing object

PartWarehouse name / value list

Get PartWarehouseList object

Fetch name value list

Remove PartWarehouse by passing it in

Add a new PartWarehouse to the collection

Add PartWarehouse by passing it in

Check if item in collection

Check if item in deleted collection

Get item collection

Fetch children

Editable Root Collection Update

Locale key so that generic list editor UI code knows what title to give the list in a grid

Retrieve PartWarehouse by index

Index

Criteria for identifying existing object

Read only list of Parts that are below their restock level by vendor. Used in purchase order entry screen.

Return an empty list used for initializing grid

Get item by index

Log fields

Criteria for identifying existing object

Remove Priority by passing it in

Add a new Priority to the collection

Add Priority by passing it in

Check if item in collection

Check if item in deleted collection

Get item collection

Fetch children

Editable Root Collection Update

Locale key so that generic list editor UI code knows what title to give the list in a grid

Retrieve Priority by index

Index

Criteria for identifying existing object

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Get new object

Populate this object from the values in the datareader passed to it

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Set/get Name of item

Read only list of Priorities

Check if item in collection

Get all Priority (unfiltered as it's not bound)

Get item by index

Returns item that matches passed in itemid value

Attributes are all that user could select to be displayed

@returns

Set/get Name of item

Criteria for identifying existing object

Project

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

returns new item with null serial number that is a duplicate of the ID called originally

Project ID that you want to make a duplicate copy of

Create new Project

Project

Fetch existing Project

Project Project Guid

Delete Project

Project GUID

Called by DataPortal to delete/add/update data into the database

Remove a Project record from the database but only if you are an administrator

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Get /set active status of Project If active = true then Project is selectable for workorders etc If active = false then Project in not selectable, but history can be viewed

Notes about Project

Original sales Name number

AyaNova user (schedulable or non-scheduleable) selected to indicate who is "overseeing" the project

Custom1

Custom2

Custom3

Custom4

Custom5

Custom6

Custom7

Custom8

Custom9

Custom0

Criteria for identifying existing object

Read only list of Projects

Check if item in collection

Get all Project (filtered by crit)

Return an empty list used for initializing grid

Get item by index

Returns display text that matches passed in itemid value

Attributes are all that user could select to be displayed

@returns

Criteria for identifying existing object

Purchase order Once a purchase order status goes to anything beyond open not yet ordered (i.e. it's ordered) it can not be changed as it follows standard business practices for inventory control.

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

Create new PurchaseOrder

PurchaseOrder

Fetch existing PurchaseOrder

PurchaseOrder PurchaseOrder Guid

Delete PurchaseOrder

PurchaseOrder GUID

Called by DataPortal to delete/add/update data into the database

Remove a PurchaseOrder record from the database but only if you are an administrator

Purchase order items child collection

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Notes about PurchaseOrder

Status of purchase order

Notes that may be displayed or printied on po when sent to vendor

Expected date of receiving

Internal version giving access to smartdate object

Date PO was ordered. Defaults to date created, but may be edited

Internal version giving access to smartdate object

Readonly as generated by AyaNova itself Admin may set a starting number

Additional reference number for the PO to cooinside with PONumber

If a drop shipment to a client this is the client If Guid.Empty then it's a regular order

Custom1

Custom2

Custom3

Custom4

Custom5

Custom6

Custom7

Custom8

Custom9

Custom0

Criteria for identifying existing object

Set the DB generated visible ID number to a new user chosen starting point

Indivdual item (part) that is selected to be in the PO

Method to flag a quantity of PO items received and close if all received

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Create item

Parent ID New Item

Retrieve item

Data reader item from database

Fetch from db

Persist object to database

Parent object Parents transaction object

Initial created date of this object

User ID of who initially created this object

Last modified date of this object

User ID of who last modified this object

Unique ID of this object

GUID of Warehouse this ordered part(s) is destined for

Taxcode ID to use to apply against items Default value is taken from Part record

ID of part ordered

Quantity ordered

PurchaseOrderCost per indvidual or unit of part Updates Part object when received

Workorder number

ID of WorkorderItem from which this part was requested to be ordered used internally in code

ID of user who requested part on workorderitempartrequest replicated here in case original workorderitempartrequest record is removed *after* parts are ordered as an audit

ID of PO

Purchase order Items

Remove PurchaseOrderItem by passing it in

Remove PurchaseOrderItem by string of id value

Remove by Guid value of ID

Add a new PurchaseOrderItem to the collection

Set all items to read only

Check if item in collection

Check if item in collection by string of ID value

Check if item in deleted collection

Check if item in deleted collection by string of ID value

NewItems

GetItems

Fetch children

Populated data reader

Update children

Retrieve PurchaseOrderItem by index

Index

Retrieve PurchaseOrderItem by string containing Guid value

Read only list of PurchaseOrders.

Check if item in collection

Get all PurchaseOrder (filtered by crit)

Return an empty list used for initializing grid

Get item by index

Returns display text that matches passed in itemid value

Attributes are all that user could select to be displayed

@returns

Criteria for identifying existing object

Read only list of PurchaseOrders ready to be received for a particular vendor

Check if item in collection

Get all PurchaseOrder (filtered by crit)

Return an empty list used for initializing grid

Get item by index

Returns display text that matches passed in itemid value

Attributes are all that user could select to be displayed

@returns

Criteria for identifying existing object

Purchase order receipt This is a write once only object Once saved initially it can never be edited again as it follows standar business practices and involves many inventory affected other objects. Corrections must be made through an inventory adjustment as per standard practices.

Private constructor to prevent direct instantiation

Copy all line items from po indicated into items collection of this receiving

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Create new PurchaseOrderReceipt

PurchaseOrderReceipt

Fetch existing PurchaseOrderReceipt

PurchaseOrderReceipt PurchaseOrderReceipt Guid

Called by DataPortal to add data into the database

Purchase order items child collection

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Date items received

Criteria for identifying existing object

Item received

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Create item

Parent ID New Item

Retrieve item

Data reader item from database

Fetch from db

Persist object to database

Parent object Parents transaction object

Initial created date of this object

User ID of who initially created this object

Last modified date of this object

User ID of who last modified this object

Unique ID of this object

Serial numbers collection for received part, 0 to many

ID of parent

Part Guid

Warehouse guid

ID of PurchaseOrder

ID of PurchaseOrderItem

Actual vendor cost of item when received

Actual quantity received TODO: This updates the qty received in PO Item record when saved

Purchase order Items

Remove PurchaseOrderReceiptItem by passing it in

Remove PurchaseOrderReceiptItem by string of id value

Remove by Guid value of ID

Add a new PurchaseOrderReceiptItem to the collection

Checks if grandchildren are dirty

Checks if grandchildren are valid

Remove empty received items (qty zero)

Check if item in collection

Check if item in collection by string of ID value

Check if Purchase order item in collection by ID value

Check if item in deleted collection

Check if item in deleted collection by string of ID value

NewItems

GetItems

Fetch children

Populated data reader

Update children

Retrieve PurchaseOrderReceiptItem by index

Index

Retrieve PurchaseOrderReceiptItem by string containing Guid value

Read only list of PurchaseOrderReceipts

Check if item in collection

Get all PurchaseOrderReceipt (filtered by crit)

Return an empty list used for initializing grid

Get item by index

Returns display text that matches passed in itemid value

Attributes are all that user could select to be displayed

@returns

Criteria for identifying existing object

there can be two types of rates. We identify them as service and travel rates. User may customize as needed, but

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

Create new Rate

Fetch

Populate this object from the values in the datareader passed to it

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Set/get client group name

Get /set active status

Get/set accounting number for rate

get/set cost of rate internally in currancy if null, sets itself to 0.00

get/set charge of rate internally in currancy if null, sets itself to 0.00

GUID of ClientGroup this rate is only available for Default is null Null indicates avaialble to all clientgroups.

select type of unit of rate to charge - ie charge is per hour, per paper count, etc

If true then only shows for contract holders If false always displays

All rates with type

Check if item in collection

Get all non contract Rates

Get all Rates that are applicable to contract provided

Id of contract that might affect rates returned

Get all Rates regardless of whether they are contract only or not

Id of contract that might affect rates returned

Get item by index

Returns RatePickListInfo item that matches passed in itemid value

@returns

Criteria for identifying existing object

Remove Rate by passing it in

Add a new Rate to the collection

Add Rate by passing it in

Check if item in collection

Check if item in deleted collection

Get item collection

Fetch children

Editable Root Collection Update

Locale key so that generic list editor UI code knows what title to give the list in a grid

Retrieve Rate by index

Index

Criteria for identifying existing object

Type of rate per unit i.e per hour, per day, per gram, per KM, per nautical mile etc

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Get new object

Populate this object from the values in the datareader passed to it

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Set/get Name of item

Set/get Name of item

Get /set active status

Remove RateUnitChargeDescription by passing it in

Add a new RateUnitChargeDescription to the collection

Add RateUnitChargeDescription by passing it in

Check if item in collection

Check if item in deleted collection

Get item collection

Fetch children

Editable Root Collection Update

Locale key so that generic list editor UI code knows what title to give the list in a grid

Retrieve RateUnitChargeDescription by index

Index

Criteria for identifying existing object

Regional settings, a level between Global and User settings. User setting has priority over regional which has priority over company wide setting

Address of AyaNova company - used in PO's and reports

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Get new object

Region Guid

Delete Region

Region GUID

Called by DataPortal to delete/add/update data into the database

Remove a Region record from the database

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Set/get Name of item

Get mailing address object for this region (Note: this address is deliberately not indexed for searching)

Criteria for identifying existing object

Read only list of Regions

Check if item in collection

Get all mail (filtered by crit)

Return an empty list used for initializing grid

Get item by index

Returns display text that matches passed in itemid value

Attributes are all that user could select to be displayed

@returns

Criteria for identifying existing object

Used internally to turn a date and time object into a string representation which is localized and relative to current date/time

Private constructor to prevent direct instantiation

Convert relative date to string representation

Date used as "now". this is a parameter rather than getting current date/time here because in a lengthy operation it could vary the display incorrectly Date to be reformatted into a relative string String representation of relative date i.e. "3 days 34 minutes ago"

simple abs function

Convert relative SmartDate to string representation

Date used as "now". this is a parameter rather than getting current date/time here because in a lengthy operation it could vary the display incorrectly Date to be reformatted into a relative string String representation of relative date i.e. "3 days 34 minutes ago" Or an empty string if the date is empty

Criteria for identifying existing object

Report

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Create new Report

Fetch existing Report

Client Guid

Delete Report (if clients assigned to this group, should be notified)

Client GUID

Called by DataPortal to delete/add/update data into the database

Remove a Report record from the database

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Set/get name

Set/get ReportKey

Size of binary layout data content

If report is a master copy it cannot be deleted or modified. Reports marked as master copies are ones that were included as stock versions of reports in AyaNova and can be copied to customize but cannot be modified themselves

Criteria for identifying existing object

DataPortal friendly way to to fetch the data for a report from an instantiated business object

Private constructor to prevent direct instantiation

Criteria for identifying existing object

Read only list of Reports

Check if item in collection

Get all Report (unfiltered as it's not bound)

Get item by index

Returns item that matches passed in itemid value

Attributes are all that user could select to be displayed

@returns

Set/get Name of item

Criteria for identifying existing object

RootObject types. Note that some items here are not strictly root objects, but are included because they need to be identified for other purposes such as indexed keywords etc.

ScheduleableUserGroup - a preselected group of individual scheduleable users. Used for dispatching and display purposes

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

Create new ScheduleableUserGroup

Fetch existing ScheduleableUserGroup

Client Guid

Delete ScheduleableUserGroup (if clients assigned to this group, should be notified)

Client GUID

Called by DataPortal to delete/add/update data into the database

Remove a ScheduleableUserGroup record from the database

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Set/get client group name

Get /set active status of client group If active = true then ScheduleableUserGroup is selectable for workorders etc If active = false then ScheduleableUserGroup in not selectable, but history can be viewed

ScheduleableUsers collection

Default guid to indicate All Users pseudo group This is not an actual group stored in the database Used in lists with ScheduleableUserGroups as the item that will return all users regardless of group membership

Criteria for identifying existing object

List of scheduleable user groups for picking in combo boxes etc Includes inactive so that they can be shown on old records in a consistent format

Check if item in collection

Get all scheduleable users

Get item by index

Returns ScheduleableUserGroupPickListInfo item that matches passed in itemid value

@returns

Criteria for identifying existing object

Individual ScheduleableUser assignment to a ScheduleableUser group

ID of ScheduleableUserGroup this ScheduleableUser belongs with

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Create item

Parent ID New Item

Retrieve item

Data reader item from database

Fetch from db

Persist object to database

Parent object Parents transaction object

Initial created date of this object

User ID of who initially created this object

Last modified date of this object

User ID of who last modified this object

Unique ID of this object

ID of ScheduleableUserGroup this ScheduleableUser belongs with

Collection of ScheduleableUserGroupUser items in a task group

Remove ScheduleableUserGroupUser by passing it in

Remove ScheduleableUserGroupUser by string of id value

Remove by Guid value of ID

Add a new ScheduleableUserGroupUser to the collection

Check if item in collection

Check if item in collection by string of ID value

Check if item in deleted collection

Check if item in deleted collection by string of ID value

NewItems

GetItems

Fetch children

Populated data reader

Update children

Retrieve ScheduleableUserGroupUser by index

Index

Retrieve ScheduleableUserGroupUser by string containing Guid value

Lightweight Read only list of Scheduleable user ID values in specified ScheduleableUserGroup

Check if item in collection

Check if item in collection

Check if item in collection

Get all Parts

Get item by index

Returns ScheduleableUserGroupUsersListInfo item that matches passed in itemid value

@returns

ID

Criteria for identifying existing object

Schedulemarker will have list of schedulable users, regions or Global to select from

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

Create new ScheduleMarker

Fetch existing ScheduleMarker

Client Guid

Delete ScheduleMarker (if clients assigned to this group, should be notified)

Client GUID

Called by DataPortal to delete/add/update data into the database

Remove a ScheduleMarker record from the database

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Set/get client group name

Start date of this schedulemarker

Start date of this schedulemarker as Date/Time object for use outside of UI binding

Stop date of this scheulde marker

Stop date of this scheulde marker as DateTime for use outside of form binding

ARGB color for display in UI

ID of source, whether global, a specific region or a specific user

Source that the schedulemarker applies to whether a global schedulemarker, a selected region or an indivudal user

Returns an arraylist containing the scheduleable user Guid ID values of all users affected by / included in this schedulemarker. So, for example, if it's one user, only that user will be in the arraylist, however if it's a schedulemarker for a dispatchzone then all Guid's for active scheduleable users in that dispatchzone will be in the arraylist.

Criteria for identifying existing object

Source that the schedulemarker applies to

If selected, than the Regions group list is populated

If selected, than the user group list (schedulable and active only) is populated

Read only collection of search results

Check if item in collection

Process search and return list of results

Return an empty list used for initializing grid

Get item by index

Returns SearchResultListInfo item that matches passed in itemid value

@returns

Object to open to view this search results original record If this object is not a child or grandchild, then this is the same as RootObjectID

Criteria for identifying existing object

Security group

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Get new object

SecurityGroup Guid

Delete SecurityGroup

SecurityGroup GUID

Called by DataPortal to delete/add/update data into the database

Remove a SecurityGroup record from the database

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Set/get Name of item

Rights collection

Indicator if current security group is Built-in AyaNova Administrator group (AyaNova Administrator group properties are all read only check this before attempting to set)

Guid of built in Administrator account

Criteria for identifying existing object

Read only list of SecurityGroups

Check if item in collection

Get all mail (filtered by crit)

Return an empty list used for initializing grid

Get item by index

Returns display text that matches passed in itemid value

Attributes are all that user could select to be displayed

@returns

Criteria for identifying existing object

Security access rights

Service bank This is a write only object and can not be deleted or modified once saved to protect the integrity of the service bank balances. Adjustments may be made by entering them in as another entry not by changing existing data. This follows standard accounting practices to ensure balance integrity

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

Get new object

ServiceBank Guid

Called by DataPortal to delete/add/update data into the database

Get internal id number Read only property because it's set internally, not externally

Get created date

Get user record ID of person who created this record

Criteria for identifying existing object

Read only list of ServiceBanks.

Check if item in collection

Return an empty list used for initializing grid

Get item by index

Returns display text that matches passed in itemid value

Attributes are all that user could select to be displayed

@returns

Criteria for identifying existing object

Custom attribute used to indicate the underlying sql column name for a business object property. Used internally for sorting and filtering in grids.

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

Get new object

Populate this object from the values in the datareader passed to it

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

if true, does show in wo select list; if false then is not selectable, but can still bring up history etc default is true

Set/get Name of item

TaskGroup - a preselected group of individual tasks that can be used to quickly select a slew of tasks with one selection

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

Create new TaskGroup

Fetch existing TaskGroup

Client Guid

Delete TaskGroup (if clients assigned to this group, should be notified)

Client GUID

Called by DataPortal to delete/add/update data into the database

Remove a TaskGroup record from the database

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Set/get client group name

Get /set active status of client group If active = true then TaskGroup is selectable for workorders etc If active = false then TaskGroup in not selectable, but history can be viewed

Tasks collection

Criteria for identifying existing object

Individual task assignment to a task group

ID of TaskGroup this task belongs with

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Create item

Parent ID New Item

Retrieve item

Data reader item from database

Fetch from db

Persist object to database

Parent object Parents transaction object

Initial created date of this object

User ID of who initially created this object

Last modified date of this object

User ID of who last modified this object

Unique ID of this object

ID of TaskGroup this task belongs with

Collection of TaskGroupTask items in a task group

Remove TaskGroupTask by passing it in

Remove TaskGroupTask by string of id value

Remove by Guid value of ID

Add a new TaskGroupTask to the collection

Check if item in collection

Check if item in collection by string of ID value

Check if item in deleted collection

Check if item in deleted collection by string of ID value

NewItems

GetItems

Fetch children

Populated data reader

Update children

Retrieve TaskGroupTask by index

Index

Retrieve TaskGroupTask by string containing Guid value

List of Tasks for building pick lists Includes inactive so that they can be shown on old records in a consistent format

Check if item in collection

Get all scheduleable users

Get item by index

Returns TaskPickListInfo item that matches passed in itemid value

@returns

Criteria for identifying existing object

Remove Task by passing it in

Add a new Task to the collection

Add Task by passing it in

Check if item in collection

Check if item in deleted collection

Get item collection

Fetch children

Editable Root Collection Update

Locale key so that generic list editor UI code knows what title to give the list in a grid

Retrieve Task by index

Index

Criteria for identifying existing object

Used in PO's, invoices, parts, services to determine if an item has tax applied or not.

if true, does show in wo select list; if false then is not selectable, but can still bring up history etc default is true

Decimal amount for this tax

decimal amount for this tax

default is false True indicates that where this is applied is tax exempt

default is false True indicates that where this is applied is tax exempt

Default is false If true, than the TaxB amount is determined from the total of itemcost + TaxA amount X TaxB

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Get new object

Populate this object from the values in the datareader passed to it

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Set/get Name of item

Get /set active status of TaxCode If active = true then taxcode is selectable If active = false then texcode in not selectable

Decimal amount for this tax

decimal amount for this tax

default is false True indicates that where this is applied is tax exempt

default is false True indicates that where this is applied is tax exempt

Default is false If true, than the TaxB amount is determined from the total of itemcost + TaxA amount X TaxB

Read only list of TaxCodes

Check if item in collection

Get all TaxCode (unfiltered as it's not used in an interface but for calcs)

Get item by index

Returns item that matches passed in itemid value

Attributes are all that user could select to be displayed

Decimal amount for this tax

decimal amount for this tax

default is false True indicates that where this is applied is tax exempt

default is false True indicates that where this is applied is tax exempt

Default is false If true, than the TaxB amount is determined from the total of itemcost + TaxA amount X TaxB

@returns

Get internal id number Read only property because it's set internally, not externally

Criteria for identifying existing object

Remove TaxCode by passing it in

Add a new TaxCode to the collection

Add TaxCode by passing it in

Check if item in collection

Check if item in deleted collection

Get item collection

Fetch children

Editable Root Collection Update

Locale key so that generic list editor UI code knows what title to give the list in a grid

Retrieve TaxCode by index

Index

Criteria for identifying existing object

Type and ID object Used to pass identification of objects around User interface in tag properties of menu items etc

User interface grid layout preferences Used to store and retreive user and default layouts for all grid objects in user interface

Private constructor to prevent direct instantiation

Get Document binary data

Set document binary data

Get new object

Fetch Grid layout requested If there is no customized version for the user then the default one will be fetched (UserID=Guid.Empty)

Called by DataPortal to delete/add/update data into the database

User ID this layout applies to, if Guid.Empty then it's the default layout for the gridkey specified

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Size of binary layout data content

Set/get GridKey of item

Set/get GridSubKey of item

Set/get description of item Optional property

Criteria for identifying existing object

Used by Windows forms user interface to hold settings pertaining to a forms last size and other pertinent display variables. Used to ensure that the forms appear the same as the user last left them in.

Private constructor to prevent direct instantiation

Get new object

GetItem

Fetch

Update

User ID number

Size of binary layout data content

Remove UIUserFormSetting by passing it in

Remove UIUserFormSetting by string of form name

Add a new UIUserFormSetting to the collection

Check if item in collection

Check if item in collection by form name

Check if item in deleted collection

NewItems

Get item collection (Root collection style)

Fetch children root style

Editable Root Collection Update

Locale key so that generic list editor UI code knows what title to give the list in a grid

Retrieve UIUserFormSetting by index

Index

Retrieve UIUserFormSetting by string containing form's name value

Criteria for identifying existing object

Unit

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

Return unitname in selected format

Return unitname in default (Global setting) format

returns new item with null serial number that is a duplicate of the ID called originally

Unit ID that you want to make a duplicate copy of

Create new Unit

Unit

Fetch existing Unit

Unit Unit Guid

Delete Unit

Unit GUID

Called by DataPortal to delete/add/update data into the database

Remove a Unit record from the database but only if you are an administrator

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Get /set active status of Unit If active = true then Unit is selectable for workorders etc If active = false then Unit in not selectable, but history can be viewed

Get service address for this Unit can be used to override client address if unit is not at client's site

Notes about unit

Overrides any other warranty terms from unitmodel

Terms for the unit's warranty

Client unit assigned to

Vendor ID where purchased from

ID of unit this unit is to be grouped as a child under (null or empty id = no parent)

default is false if true, unit address is specified in GoToAddress

Original sales receipt number

default is true if false, than select PurchasedFrom vendor id

Date unit was purchased Utilized to determine warranty info

Description of unit to display if no model chosen

If a unit is replaced while in warranty (WorkorderItemOutsideService) sets this unit to inactive, and enters in new units serialnumber that replaced it

Custom1

Custom2

Custom3

Custom4

Custom5

Custom6

Custom7

Custom8

Custom9

Custom0

If true then banked service is tracked for this object (hours / money / incidents)

If true then meter readings can be entered for this unit

Lifetime warranty which never expires

Warranty length in months Ignored if LifeTimeWarranty selected

Returns status of warranty ("resolved" because it checks all possible sources of a warranty to determine status)

Resolved warranty expiry date (definitive date from either unit model or this unit's overriden properties) If there is a lifetime warranty it returns DateTime.MaxValue If there is no warranty expiry date determineable then it returns null. Otherwise it returns a DateTime set to warranty expiry date.

Warranty terms resolved (either from unit model or this units overriden warranty properties as required) Returns text of warranty terms or an empty string if none found or no warranty applicb

Criteria for identifying existing object

Read only list of Units.

Check if item in collection

Get all Unit (filtered by crit)

Return an empty list used for initializing grid

Get item by index

Returns display text that matches passed in itemid value

Attributes are all that user could select to be displayed

@returns

Criteria for identifying existing object

Unit meter reading entry

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

Create new UnitMeterReading

Fetch existing UnitMeterReading

Client Guid

Delete UnitMeterReading (if clients assigned to this group, should be notified)

Client GUID

Called by DataPortal to delete/add/update data into the database

Remove a UnitMeterReading record from the database

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Date meterreading taken

If a meter reading is entered via the workorder screen then the workorder item is stored here as a back reference

Criteria for identifying existing object

Read only list of UnitMeterReadings.

Check if item in collection

Return an empty list used for initializing grid

Get item by index

Returns display text that matches passed in itemid value

Attributes are all that user could select to be displayed

@returns

Criteria for identifying existing object

UnitModel object

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

Create new UnitModel

UnitModel

Fetch existing UnitModel

UnitModel UnitModel Guid

Delete UnitModel

UnitModel GUID

Called by DataPortal to delete/add/update data into the database

Remove a UnitModel record from the database but only if you are an administrator

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Get /set active status of UnitModel If active = true then UnitModel is selectable for workorders etc If active = false then UnitModel in not selectable, but history can be viewed

Notes about UnitModel

Name

For reporting and grouping purposes. For example, washing maching and dryer would be in category "Appliances" whereas a printer or scanner would be in "Computer Equipment"

Default is false If true, can not have LifeTimeWarranty Notifies user of this and DiscontinuedDate when unit with this unitmodel is selected in a workorder

If Discontinued selected, able to enter in discontinued date

Default is false If true, DiscontinuedWarranty not applicable

Warranty length in months Ignored if LifeTimeWarranty selected

Information on warranty terms Displays in workorder when unit with this unitmodel selected

String as mixed numbers and letters

Date unitmodel introduced/released

Custom1

Custom2

Custom3

Custom4

Custom5

Custom6

Custom7

Custom8

Custom9

Custom0

Criteria for identifying existing object

Remove UnitModelCategory by passing it in

Add a new UnitModelCategory to the collection

Add UnitModelCategory by passing it in

Check if item in collection

Check if item in deleted collection

Get item collection

Fetch children

Editable Root Collection Update

Locale key so that generic list editor UI code knows what title to give the list in a grid

Retrieve UnitModelCategory by index

Index

Criteria for identifying existing object

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

Create new UnitModelCategory

Fetch existing UnitModelCategory

Datareader

Populate this object from the values in the datareader passed to it

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Set/get client group name

Get /set active status of client group If active = true then UnitModelCategory is selectable for workorders etc If active = false then UnitModelCategory in not selectable, but history can be viewed

Read only list of UnitModels.

Check if item in collection

Get all UnitModel (filtered by crit)

Return an empty list used for initializing grid

Get item by index

Returns display text that matches passed in itemid value

Attributes are all that user could select to be displayed

@returns

Criteria for identifying existing object

Used to quickly fetch a single saved Unit's name from the database in the currently selected UnitNameFormat style

Private constructor to prevent direct instantiation

Fetches and formats a unit name

Guid value of existing unit in database Unit name formatted to current global UnitNameFormat setting

Fetches and formats a workorder item's unit name

Guid value of existing WorkorderItem record in database Unit name formatted to current global UnitNameFormat setting, empty if no unit on workorderitem

Fetches and formats a workorder item outside service's unit name

Guid value of existing WorkorderItemOutsideService record in database Unit name formatted to current global UnitNameFormat setting, empty if no unit on workorderitem

Criteria for identifying existing object

Displays on reports and Parts screen selection. (e.g. each, per 100, per box, MBF, etc) to identify units of measure for the part

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Get new object

Populate this object from the values in the datareader passed to it

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Set/get Name of item

Get /set active status

UnitOfMeasure name / value list

Get UnitOfMeasureList object

Fetch name value list

Remove UnitOfMeasure by passing it in

Add a new UnitOfMeasure to the collection

Add UnitOfMeasure by passing it in

Check if item in collection

Check if item in deleted collection

Get item collection

Fetch children

Editable Root Collection Update

Locale key so that generic list editor UI code knows what title to give the list in a grid

Retrieve UnitOfMeasure by index

Index

Criteria for identifying existing object

List of units for criteria formatted according to user prefs

Check if item in collection

Get a list of units owned by a specific client or self owned.

Client Guid for units owned by a specific client only or Guid.Empty for all units that are self-owned

Get a list of all units

Get item by index

Returns UnitPickListInfo item that matches passed in itemid value

Return unitname in selected format

@returns

Criteria for identifying existing object

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

Create new UnitServiceType

Fetch existing UnitServiceType

Datareader

Populate this object from the values in the datareader passed to it

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Set/get name

Get /set active status If active = true then UnitServiceType is selectable for workorders etc If active = false then UnitServiceType in not selectable, but history can be viewed

Remove UnitServiceType by passing it in

Add a new UnitServiceType to the collection

Add UnitServiceType by passing it in

Check if item in collection

Check if item in deleted collection

Get item collection

Fetch children

Editable Root Collection Update

Locale key so that generic list editor UI code knows what title to give the list in a grid

Retrieve UnitServiceType by index

Index

Criteria for identifying existing object

User - anyone with access to AyaNova

Private constructor to prevent direct instantiation responsible for setting object default values

Set the MD5 hashes for the password and login

Return name in selected format

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

Return name in selected format

Create new user

Fetch existing user

Client Guid

Delete user

User GUID

Used to quickly retrieve a user's language setting

User ID Users language setting string

Called by DataPortal to delete/add/update data into the database

Remove a user record from the database but only if you are an administrator

Login account

Login password

Default language to present to user. Corresponds to the Locale field in the LocalizedText table in AyaNova database

Guid of default Purchase order template to use on new work orders Note that this may be overriden by similar option in other objects (depending on situation)

Guid of default WorkorderQuote template to use on new work orders Note that this may be overriden by similar option in other objects (depending on situation)

Guid of default work order template to use on new work orders Note that this may be overriden by similar option in other objects (depending on situation)

Type of user. This property can affect license consumption, use with care or you may lockout all users of AyaNova.

If usertype is a client login then this is the ID of thier client record ID otherwise is empty

If usertype is a HeadOffice login then this is the ID of thier HeadOffice record ID otherwise is empty

Security group Guid this user is a member of

Date record created

Last record modification date

User record ID of person who created this record

User ID of person who modified this record

Users unique identifier (used internally) Read only

Users first (given) name

Users last (family) name

Initials to idientify user used in places where a full name can't be fit

Get /set active status of user If active = true then user is selectable for workorders if a tech or can log in etc If active = false then user in not selectable, but history can be viewed

May be used for accounting Some businesses may use employee number for lists rather than the first and last name - need to be able to have manager set which is desired.

Email address for sending text messages

Maximum number of text in a single message this pager can handle

Users primary contact phone number

Users second / alternative phone

Users email address

Collection of certifications this user posesses

Collection of skills assigned to user

Notes

If user is a subcontractor, than this field would contain ID of vendor that is specified as a SubContractor

Collection of assigned documents assigned to this user

Region GUID that user is assigned to.

Dispatch zone GUID

If true, than scheduleable user is a subcontractor

Default warehouse for this user to select parts from

Custom1

Custom2

Custom3

Custom4

Custom5

Custom6

Custom7

Custom8

Custom9

Custom0

Selected color is used for background behind users' schedule in calendar displays

LastView - key of last view (form) user was viewing when they last closed the program. This is used to ensure they start with the same view they had before. If this is blank or invalid then the UI will start with the first view they have rights to see.

Used internally here to weed out attempts to set properties when read only or administrator or a utility account

Indicator if user is Built-in Administrator account (Administrator user properties are almost all read only check this before attempting to set)

Indicator if user is a Notification server account (Notification server user properties are almost all read only check this before attempting to set)

Guid of built in Administrator account

Criteria for identifying existing object

Certificate or training a schedulable user has achieved

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

Get new object

Populate this object from the values in the datareader passed to it

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Set/get Name of item

A user certification assigned to a specific user

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

NewItem

Retrieve item

Data reader item from database

Fetch from db

Update

Initial created date of this object

User ID of who initially created this object

Last modified date of this object

User ID of who last modified this object

Unique ID of this object

Certification ID

User ID

Date certificate or training validation begins

Date certificate or training is valid until

Remove UserCertificationAssigned by passing it in

Remove UserCertificationAssigned by string of id value

Remove by Guid value of ID

Add a new UserCertificationAssigned to the collection

Check if item in collection

Check if item in collection by string of ID value

Check if item in collection by string of Certification ID value

Check if item in deleted collection

Check if item in deleted collection by string of ID value

NewItems

GetItems

Fetch children

Populated data reader

Update children

Retrieve UserCertificationAssigned by index

Index

Retrieve UserCertificationAssigned by string containing Guid value

UserCertification name / value list

Get UserCertificationList object

Fetch name value list

Remove UserCertification by passing it in

Add a new UserCertification to the collection

Add UserCertification by passing it in

Check if item in collection

Check if item in deleted collection

Get item collection

Fetch children

Editable Root Collection Update

Locale key so that generic list editor UI code knows what title to give the list in a grid

Retrieve UserCertification by index

Index

Criteria for identifying existing object

Read only list of Users

Check if item in collection

Get all User (filtered by crit)

Return an empty list used for clearing a grid

Get item by index

Returns display text that matches passed in itemid value

Attributes are all that user could select to be displayed

@returns

Criteria for identifying existing object

List of users for picking from formatted according to various templates

Get all scheduleable users

Get item by index

@returns

Criteria for identifying existing object

List of users for picking from formatted according to various templates

Check if item in collection

Get all scheduleable users

Get item by index

Returns UserListScheduleableInfo item that matches passed in itemid value

Return name in selected format

@returns

Criteria for identifying existing object

List of users for picking from formatted according to various templates

Get all scheduleable users

Get item by index

@returns

Criteria for identifying existing object

Basic name value list of all AyaNova users (or one specific) formatted to current users preferred user name display format

Check if item in collection

Get all Users

Get one specific user only but with all the pick list info

Get item by index

Returns display text that matches passed in itemid value

Attributes are all that user could select to be displayed

@returns

Criteria for identifying existing object

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Get new object

GetItem

Fetch

Update

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Guid ID of securitygroup this right belongs to

Get / Set the abbreviated right code for this UserRight. Setting is validated to conform to list of potential rights.

Remove UserRight by passing it in

Remove UserRight by string of id value

Remove by Guid value of ID

Add a new UserRight to the collection

Add a new UserRight and set it's right name and security level to the collection

Check if item in collection

Check if item in collection by string of ID value

Check if item in deleted collection

Check if item in deleted collection by string of ID value

NewItems

GetItems

Fetch children

Populated data reader

Update children

Retrieve UserRight by index

Index

Retrieve UserRight by string containing Right name value

List of skills this schedulable user has. Than when determining who to schedule for a specific task or workorder where this skill is required, person displatching can bring up all techs with this skill

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

Get new object

Populate this object from the values in the datareader passed to it

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Set/get Name of item

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

NewItem

Retrieve item

Data reader item from database

Fetch from db

Update

Initial created date of this object

User ID of who initially created this object

Last modified date of this object

User ID of who last modified this object

Unique ID of this object

User skill ID

User ID

Remove UserSkillAssigned by passing it in

Remove UserSkillAssigned by string of id value

Remove by Guid value of ID

Add a new UserSkillAssigned to the collection

Check if item in collection

Check if item in collection by string of ID value

Check if item in collection by string of Skill ID value

Check if item in deleted collection

Check if item in deleted collection by string of ID value

NewItems

GetItems

Fetch children

Populated data reader

Update children

Retrieve UserSkillAssigned by index

Index

Retrieve UserSkillAssigned by string containing Guid value

UserSkill name / value list

Get UserSkillList object

Fetch name value list

Remove UserSkill by passing it in

Add a new UserSkill to the collection

Add UserSkill by passing it in

Check if item in collection

Check if item in deleted collection

Get item collection

Fetch children

Editable Root Collection Update

Locale key so that generic list editor UI code knows what title to give the list in a grid

Retrieve UserSkill by index

Index

Criteria for identifying existing object

This is the special account used only for updates, for customizing layout, etc

This is a user that can be assigned to a workorder or schedule. identified by (tech) next to name

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

Returns a DataTable containing columns matching this business objects collection fields. This is used for report designer interface

Create new Vendor

Vendor

Fetch existing Vendor

Vendor Vendor Guid

Delete Vendor

Vendor GUID

Called by DataPortal to delete/add/update data into the database

Remove a Vendor record from the database but only if you are an administrator

Localized text of Vendor type

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Set/get Vendor name

Get /set active status of Vendor If active = true then Vendor is selectable for workorders etc If active = false then Vendor in not selectable, but history can be viewed

Get service address for this Vendor

Get mailing address object for this Vendor Returns GoToAddress object if MailToAddress is empty

web address of Vendor if applicable can be null ties into hyerlink to web browser

Corresponds to Vendors.generalnotes in AyaNova v1

Get Contacts collection for this object

Custom1

Custom2

Custom3

Custom4

Custom5

Custom6

Custom7

Custom8

Custom9

Custom0

Returns a DataTable containing data from this object for a report

Criteria for identifying existing object

this is a localizable, data grid bindable, read only list of clients.

Check if item in collection

Takes an xml column list and where criteria and returns a list filtered and sorted accordingly

Return an empty list used for initializing grid

Get item by index

Returns display text that matches passed in itemid value

Attributes are all that user could select to be displayed

@returns

Criteria for identifying existing object

simple Vendor name / value list

Get VendorNVList object

Fetch name value list

List of Vendors for building pick lists Includes inactive so that they can be shown on old records in a consistent format

Check if item in collection

Get all scheduleable users

Get item by index

Returns VendorPickListInfo item that matches passed in itemid value

@returns

Criteria for identifying existing object

Client name / value list

Get VendorsWithReceivablePONVList object

Fetch name value list

No current or past warranty

Expired - had a warranty but has now expired

Active warranty / in-warranty

Workorder

Private constructor to prevent direct instantiation

Returns populated TypeAndID if the client or head office for this workorder is bankable (If the unit is bankable that's handled separately) Returns null if not bankable

Returns Contract that is most specific or null if no contract

Move workorderItem from current workorder to another (Requires full rights and not a closed or read only workorder)

Sets all parts to used = true on entire workorder

Create a labor object from a scheduled user object to save entry time

Find the workorder item ID that contains the object passed in

Type of workorder item descendant object ID of descendant of workorder item

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

Create new Workorder

Workorder

Fetch existing Workorder

Workorder Workorder Guid

Fetch existing Workorder by Labor item ID

Workorder WorkorderItemLabor Guid

Fetch existing Workorder by Travel item ID

Workorder WorkorderItemTravel Guid

Fetch existing Workorder by Workorder item ID

Workorder WorkorderItem Guid

Fetch existing Workorder by WorkorderItemScheduledUser ID

Workorder WorkorderItemScheduledUser Guid

Fetch existing Workorder by WorkorderItemOutsideService ID

Workorder WorkorderItemOutsideService Guid

Fetch existing Workorder by WorkorderItemPartRequest ID

Workorder WorkorderItemPartRequest Guid

Delete Workorder

Workorder GUID

Called by DataPortal to delete/add/update data into the database

Remove a Workorder record from the database but only if you are an administrator

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Category of workorder

To include main contact phone number, contact name, address and email if applicable to display in brief and link to customer info If null, indicates that this workorder is for internal use - access to internal units etc.

Corresponds to the "notes" field in 1.9 database table wo Brief description of the workorder itself

Need to flesh out a lot more as refers to a collection etc ID of the FormLayout which is object describing the field positions and field titles of a workorder input form as designed by a user

GUID of project selected

ID of the source template workorder that this workorder is copied from (template, quote or PM) Not from a simple copy of a workorder

Indicates that the workroder object is a template

In addition to Workorder number - may have letters in it, therefore used in addition to numerial wo number

Onsite indicates at client site Default is true Can be set in regional settings

Takes as default name in client contact list when client first selected, but can be edited by user

Determines if a workorder is a template, a quote, a PM item, a workorder for a client or an internal workorder

To identify for reporting and displaying if for a specific Region

If not a WorkorderPreventiveMaintenance, is null If a WorkorderPreventiveMaintenance contains the WorkorderPreventiveMaintenance child object

If not a WorkorderService, is null If a WorkorderService contains the WorkorderService child object

Workorder items collection

If not a quote, is null If a quote, contains the WorkorderQuote child object

Custom1

Custom2

Custom3

Custom4

Custom5

Custom6

Custom7

Custom8

Custom9

Custom0

Mirror of global object's UseInventory setting

Flag to indicate that service has been completed for this workorder When true it means that all but workorder header items will become read only this property can only be set from true to false by someone with full rights to the workorder object

Used to close a workorder. A closed workorder can never be re-opened, so this is a write once setting. A closed workorder can no longer be edited in any manner permanently.

False if any outstanding parts (not set to "Used in service") True if all parts are set to used in service.

Criteria for identifying existing object

Remove WorkorderCategory by passing it in

Add a new WorkorderCategory to the collection

Add WorkorderCategory by passing it in

Check if item in collection

Check if item in deleted collection

Get item collection

Fetch children

Editable Root Collection Update

Locale key so that generic list editor UI code knows what title to give the list in a grid

Retrieve WorkorderCategory by index

Index

Criteria for identifying existing object

Workorder categories are used to “group” workorders into your defined categories. You can then use the category for printing aggregate totals on management reports. It can also be useful for many other purposes and can be used in any way you choose or not at all.

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

Create new WorkorderCategory

Fetch existing WorkorderCategory

Populate this object from the values in the datareader passed to it

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Set/get client group name

Get /set active status of client group If active = true then WorkorderCategory is selectable for workorders etc If active = false then WorkorderCategory in not selectable, but history can be viewed

Used to quickly fetch a count of all workorders in database

Private constructor to prevent direct instantiation

Counts workorders

Count

Criteria for identifying existing object

Used to quickly fetch descriptive information for identifying a service workorder to user during notification processing

Private constructor to prevent direct instantiation

Criteria for identifying existing object

Guid ID of root object (Workorder which may be a Service, ServiceTemplate, WorkorderQuote, QuoteTemplate, PM, or PMTemplate

This is a user definable date and time in the event the request came many hours previously, but was created at a later date and they wish to identify "actual" response time from when the request actually occurred - not via the Created attribute. Default value is the WorkorderItem mCreated attribute

Brief summary of what the service item is for For display on lists, reports, schedule screen etc Corresponds to probs.brief in AyaNova 1.9.4.4

Used to identify for the dispatched technican what service is to be performed Corresponds to probs.notes in AyaNova v1

ID of WorkorderItemType

Status selected for WorkorderItems - uses object Status which is also used by WorkorderStatus - this allows reports to be based on either or WorkorderStatus from Workorder object able to update this field When this WorkorderItem Status is marked as closed any parts set to Reserved results in a popup alerting user that there are parts yet reserved and not yet set to UsedIService - can't closed until changed

WorkorderItemParts child collection

WorkorderItemScheduledUsers child collection

WorkorderItemLabors child collection

WorkorderItemMiscExpenses child collection

WorkorderItemTravels child collection

WorkorderItemTasks child collection

0..1 ratioWorkorderItemOutsideService object

WorkorderItemLoans child collection

ID of unit being serviced can be null

If UnitID has a value, than this is available

If a unit selected, service provided under warranty for this unit

Private constructor to prevent direct instantiation

Called by workorder items collection object when called in turn by workorder object that is read only due to security or closed or service completed

Either true or the rights allowed for the current user

Sets all parts for this workorder item to part status "UsedInService"

Helper for GUI, if user selects more parts than are in stock and indicates they want to request them from the purchaser this function will move the quantity indicated to the request line

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

New item

Get Item

Update child

Called by collection and by the Update method in this object to remove all child collections and workorder item itself

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Used to identify for the dispatched technican what service is to be performed

WorkorderItemMiscExpenses child collection

WorkorderItemLoans child collection

WorkorderItemLabors child collection

0..1 ratioWorkorderItemOutsideService object

WorkorderItemParts child collection

WorkorderItemPartRequests child collection

WorkorderItemScheduledUsers child collection

WorkorderItemTasks child collection

WorkorderItemTravels child collection

If UnitID has a value, than this is available

Status selected for WorkorderItems - uses object Status which is also used by WorkorderStatus - this allows reports to be based on either or WorkorderStatus from Workorder object able to update this field When this WorkorderItem Status is marked as closed any parts set to Reserved results in a popup alerting user that there are parts yet reserved and not yet set to UsedIService - can't closed until changed

ID of unit being serviced

If a unit selected, service provided under warranty for this unit

This is a user definable date and time in the event the request came many hours previously, but was created at a later date and they wish to identify "actual" response time from when the request actually occurred - not via the Created attribute. Default value is the WorkorderItem mCreated attribute

ID of WorkorderItemType

Brief summary of what the service item is for For display on lists, reports, schedule screen etc Corresponds to prob.brief in AyaNova v1

Custom1

Custom2

Custom3

Custom4

Custom5

Custom6

Custom7

Custom8

Custom9

Custom0

Private constructor to prevent direct instantiation

Attempts to apply this labor entry to service bank and sets ServiceBankID

Populate TypeAndID object Rate currency per unit for banked currency calcs

Called by parent collection object when called in turn by workorder object that is read only due to security or closed or service completed

Either true or the rights allowed for the current user

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

New item

Get Item

Update child

ID of service bank record created from this labor record Is set when apply service bank is called

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

UserID selected must be schedulable and active. If displaying historical information, would show a N/A (non-active) next to the displayed name, but would not be able to reselect an active and schedulable user

if a rate that is set as a flat is selected, this field "disappears"?

Details of service performed, prints on reports given to customers

Guid ID of root object (WorkorderItem)

Sales tax code for rates

this is the collection of labor objects (actual labor and service performed) in relation to this service item.

Remove WorkorderItemLabor by passing it in

Remove WorkorderItemLabor by string of id value

Remove by Guid value of ID

Add a new WorkorderItemLabor to the collection

Sets all items to read / write status used by workorder object when it's closed or service completed is true

true=Set to read only explicitly, false=set to whatever rights allowed

Check if item in collection

Check if item in collection by string of ID value

Check if item in deleted collection

Check if item in deleted collection by string of ID value

NewItems

Get items - Grandchild style

Fetch children - grandchild style

Update children

Given a workorder item ID deletes all items for that ID Called by workorderitems delete

ID of parent workorder item Database transaction from ascendant item

Retrieve WorkorderItemLabor by index

Index

Retrieve WorkorderItemLabor by string containing Guid value

Read only list of UserSchedules.

Check if item in collection

Get all UserSchedule (filtered by crit)

Return an empty list used for initializing grid

Get item by index

Returns display text that matches passed in itemid value

Attributes are all that user could select to be displayed

@returns

Not for viewing directly, sets the color of the priority flag

Not for viewing directly, sets the color of the status button

Criteria for identifying existing object

Private constructor to prevent direct instantiation

Called by parent collection object when called in turn by workorder object that is read only due to security or closed or service completed

Either true or the rights allowed for the current user

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

New item

Get Item

Update child

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Notes

GUID of Tax code used for charges

Guid ID of root object (WorkorderItem)

Retail amount to charge client Can be 0

ReturnDate

Date expected to be returned

Date loaned out

ID of loan item being loaned

this is the collection of items loaned to client during the course of the service - these may be charged to the client, or may be for internal use only

Remove WorkorderItemLoan by passing it in

Remove WorkorderItemLoan by string of id value

Remove by Guid value of ID

Add a new WorkorderItemLoan to the collection

Sets all items to read / write status used by workorder object when it's closed or service completed is true

true=Set to read only explicitly, false=set to whatever rights allowed

Check if item in collection

Check if item in collection by string of ID value

Check if item in deleted collection

Check if item in deleted collection by string of ID value

NewItems

Get items - Grandchild style

Fetch children - grandchild style

Update children

Given a workorder item ID deletes all items for that ID Called by workorderitems delete

ID of parent workorder item Database transaction from ascendant item

Retrieve WorkorderItemLoan by index

Index

Retrieve WorkorderItemLoan by string containing Guid value

Guid ID of root object (WorkorderItem)

Descriptive name for miscelaneous expense

Description regarding this miscellaneous expense such as explanation i.e Hotel overnight, store bought as part out of stock, etc

Actual total cost dollar amount including taxes if any of item

Tax dollar portion of TotalCost If company needs to separate taxes paid on it (i.e tech purchased part from a store for use at the client site, need to identify sales tax separately from cost of item for accounting purposes)

Retail amount to charge client Can be null

If true, than ChargeAmount is to be charged back to customer If false, than internal data only

ID of tax code for this item Identifies the tax to be applied to the expense if to be charged to the client

TotalCost was paid by schedulable User and they need to be reimbursed

GUID of schedulable and active User to be reimbursed If displaying historical information, would show a N/A (non-active) next to the displayed name, but would not be able to reselect an active and schedulable user Can assign to a scheduleable User without setting a scheduled time and date - for those that let tech decide when to schedule User can be null (unassigned)

Private constructor to prevent direct instantiation

Called by parent collection object when called in turn by workorder object that is read only due to security or closed or service completed

Either true or the rights allowed for the current user

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

New item

Get Item

Update child

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Description regarding this miscellaneous expense such as explanation i.e Hotel overnight, store bought as part out of stock, etc

GUID of schedulable and active User to be reimbursed

Guid ID of root object (WorkorderItem)

TotalCost was paid by schedulable User and they need to be reimbursed

Retail amount to charge client Can be null

ID of tax code for this item Identifies the tax to be applied to the expense if to be charged to the client

If true, than ChargeAmount is to be charged back to customer If false, than internal data only

Descriptive name for miscelaneous expense

Tax dollar portion of TotalCost If company needs to separate taxes paid on it (i.e tech purchased part from a store for use at the client site, need to identify sales tax separately from cost of item for accounting purposes)

Actual total cost dollar amount including taxes if any of item

this is the collection of miscelaneous expenses incurred during the course of the service - these may be charged to the client, or may be for internal use - up to the user whether appears on Workorder report etc

Remove WorkorderItemMiscExpense by passing it in

Remove WorkorderItemMiscExpense by string of id value

Remove by Guid value of ID

Add a new WorkorderItemMiscExpense to the collection

Sets all items to read / write status used by workorder object when it's closed or service completed is true

true=Set to read only explicitly, false=set to whatever rights allowed

Check if item in collection

Check if item in collection by string of ID value

Check if item in deleted collection

Check if item in deleted collection by string of ID value

NewItems

Get items - Grandchild style

Fetch children - grandchild style

Update children

Given a workorder item ID deletes all items for that ID Called by workorderitems delete

ID of parent workorder item Database transaction from ascendant item

Retrieve WorkorderItemMiscExpense by index

Index

Retrieve WorkorderItemMiscExpense by string containing Guid value

General comments

By default, displays list of vendors marked with enumeration of Manufactuer or ThirdpartyRepair - but can select to show all vendors to select from

By default, displays list of vendors marked with enumeration of Shipper - but can select to show all vendors to select from

Referred to as RMA or repair number - usually provided by the repair center shipped to

Number used to track the shipping number when sent

Cost of repair

Price charged to customer for repair.

Cost to ship

Price charged to client for shipping

Date expected to be returned

Actual date of return Derives from shipping/receiving screen or can be edited by user here

Private constructor to prevent direct instantiation

Sets all to read / write status used by workorder object when it's closed or service completed is true

true=Set to read only explicitly, false=set to whatever rights allowed

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

New item (Note: requires rights to Workorder object *not* WorkorderItemOutsideService object)

Get item

Fetch

Update Grandchild

Given a workorder item ID deletes this item for that ID Called by workorderitems delete

ID of parent workorder item Database transaction from ascendant item

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Guid ID of root object (WorkorderItem)

Actual date of return Derives from shipping/receiving screen or can be edited by user here

Number used to track the shipping number when sent

By default, displays list of vendors marked with enumeration of Shipper - but can select to show all vendors to select from

Date expected to be returned

Cost of repair

Price charged to customer for repair.

Referred to as RMA or repair number - usually provided by the repair center shipped to

Cost to ship

Price charged to client for shipping

By default, displays list of vendors marked with enumeration of Manufactuer or ThirdpartyRepair - but can select to show all vendors to select from

WorkorderItemPart

If user using inventory, can select from pre-entered list of serial numbers, or can enter in manually here or use for what have U

If Part is serialized, quantity must always be 1

Default taken from part inventory - not editable by user

Default taken from part inventory, but can be edited by user

Percentage discount to be applied to the WorkorderItemPart When set discount reason is also set indicating why the discount was given

If discount is entered or is obtained from Contract, than type occurs. Can be null if no discount

Warehouse GUID that part was reserved from, or taken out of inventory from, as well as when specifiy ToBeOrdered, PO knows it is needed for a specific warehouse

Private constructor to prevent direct instantiation

Called by parent collection object when called in turn by workorder object that is read only due to security or closed or service completed

Either true or the rights allowed for the current user

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

New item

Get Item

Update child

This handles deleting a part record and updating inventory accordingly It's called internally here and also by the collection

Update inventory and serials as a result of part being added / removed from a workorderitem

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Guid ID of root object (WorkorderItem)

Warehouse GUID that part was reserved from, or taken out of inventory from, as well as when specifiy ToBeOrdered, PO knows it is needed for a specific warehouse

Sales tax code for parts

If using AyaNova inventory, this is the serial number record for this part

If not using inventory can store serial number here or what have U

Default taken from part inventory - should not editable by user but needs to be editable for purposes of importing from old AyaNova

Default taken from part inventory, but can be edited by user

If Part is serialized, quantity must always be 1

Can be null if no discount

Percentage discount to be applied to the WorkorderItemPart When set discount reason is also set indicating why the discount was given

True = Part has been consumed False = Part is only "suggested", not actually consumed yet

True = Part has been removed from inventory False = Part has not yet affected inventory

Part when selected shows quantity and location and alternativepartnumber if needed (so they can select that instead) If part is to be used - select "reserved" and it shows location so can select where it is (if was previously in store stock, may now be in techs truck while alloted) If part has been used - select " UsedInService" - means its ready to be billed If a part selected displays as outofstock - select "ToBeOrdered" Purchaser can run report to see items "ToBeOrdered" and place a PO based on those - than changes "ToBeOrdered" to "OnOrder" showing ETAdate of PO When order comes in, receiver can than change part to "Reserved" and notifiy tech part is now available.

User enters a discount to be applied to part at time of data entry

Discount applied as specified by contract

Discount applied for other reason. Review notes as to why.

WorkorderItemPartRequest

ID of purchase order item if part is OnOrder

Warehouse GUID

Private constructor to prevent direct instantiation

Called by parent collection object when called in turn by workorder object that is read only due to security or closed or service completed

Either true or the rights allowed for the current user

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

New item

Get Item

Called by PurchaseOrderReceipt when parts are received against a request this method ensures that the request record get's updated accordingly notification is sent if subscribed to and finally creates a part record for the workorder item ready for the tech

Update child

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Guid ID of root object (WorkorderItem)

Warehouse GUID

ID of purchase order item if part is OnOrder

Quantity of parts requested

Quantity of parts received to date against this request

Handle receipt of inventory that fulfills request

Used internally to confirm the existance of a workorder item part request for the various inventory related objects

Private constructor to prevent direct instantiation

Criteria for identifying existing object

Read only list of WorkorderItemPartRequests.

Check if item in collection

Get all WorkorderItemPartRequest (filtered by crit)

Return an empty list used for initializing grid

Get item by index

Read only list of parts requested on workorders

@returns

Criteria for identifying existing object

Used to quickly fetch descriptive information for identifying a work order item part request and service workorder to user during notification processing

Private constructor to prevent direct instantiation

Criteria for identifying existing object

this is the collection of parts for this service item that are requested by the user due to being out of stock

Remove WorkorderItemPartRequest by passing it in

Remove WorkorderItemPartRequest by string of id value

Remove by Guid value of ID

Add a new WorkorderItemPartRequest to the collection

Sets all items to read / write status used by workorder object when it's closed or service completed is true

true=Set to read only explicitly, false=set to whatever rights allowed

Check if item in collection

Check if item in collection by string of ID value

Check if item in deleted collection

Check if item in deleted collection by string of ID value

NewItems

Get items - Grandchild style

Fetch children - grandchild style

Update children

Given a workorder item ID deletes all items for that ID Called by workorderitems delete

ID of parent workorder item Database transaction from ascendant item

Retrieve WorkorderItemPartRequest by index

Index

Retrieve WorkorderItemPartRequest by string containing Guid value

this is the collection of parts for this service item - whether they are reserved (not yet used), used in service, on order, or needs to be ordered.

Remove WorkorderItemPart by passing it in

Remove WorkorderItemPart by string of id value

Remove by Guid value of ID

Add a new WorkorderItemPart to the collection

Sets all items to read / write status used by workorder object when it's closed or service completed is true

true=Set to read only explicitly, false=set to whatever rights allowed

Check if item in collection

Check if item in collection by string of ID value

Check if item in deleted collection

Check if item in deleted collection by string of ID value

NewItems

Get items - Grandchild style

Fetch children - grandchild style

Update children

Given a workorder item ID deletes all items for that ID Called by workorderitems delete

ID of parent workorder item Database transaction from ascendant item

Retrieve WorkorderItemPart by index

Index

Retrieve WorkorderItemPart by string containing Guid value

Retrieve WorkorderItemPart by Guid value

this is the collection of WorkorderItems for a specific workorder

Called by any one of the delete methods if there is only one left then it throws and exception (UI should ensure this never happens)

Remove WorkorderItem by passing it in Will throw an exception if attempt to delete the last workorder item. A workorder must have at last one workorder item and the UI should ensure the user can not even attempt to delete it.

Remove WorkorderItem by string of id value Will throw an exception if attempt to delete the last workorder item. A workorder must have at last one workorder item and the UI should ensure the user can not even attempt to delete it.

Remove by Guid value of ID Will throw an exception if attempt to delete the last workorder item. A workorder must have at last one workorder item and the UI should ensure the user can not even attempt to delete it.

Add a new WorkorderItem to the collection

Sets all items to read / write status used by workorder object when it's closed or service completed is true

true=Set to read only explicitly, false=set to whatever rights allowed

Check if item in collection

Check if item in collection by string of ID value

Check if item in deleted collection

Check if item in deleted collection by string of ID value

NewItems

GetItems

Fetch children

Populated data reader

Update children

Given a workorder ID retrieves all workorder item id values for that workorder, then calls the child and grandchild Shared static direct delete methods to clear out those collections, then finally removes all workorder items of that workorder ID Called by Workorder delete

ID of parent workorder item Database transaction from ascendant item

Retrieve WorkorderItem by index

Index

Retrieve WorkorderItem by string containing Guid value

Scheduled user on workorder item. Can select a time and no user or a user and not time

Private constructor to prevent direct instantiation

Set a broken rule if there is not at *least* one of the following: A start date AND end date or a ScheduleableUser entered.

true if broken rule

Called by parent collection object when called in turn by workorder object that is read only due to security or closed or service completed

Either true or the rights allowed for the current user

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

New item

Get Item

Update child

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Empty ID indicates there is a scheduled time slot but no active user yet

Estimated amount of minutes that technician service would be required Useful when no Scheduled daterange specified and tech needs to determine when best to slot in

Starting date and time

Ending date and time

Pre-selected service rate

Guid ID of root object (WorkorderItem)

Used to quickly fetch descriptive information for a workorderitemscheduleduser notification during notification processing

Private constructor to prevent direct instantiation

Criteria for identifying existing object

this is the collection of scheduled Users that is selected for a WorkorderItem to display along with start and stop dates (and times)

Remove WorkorderItemScheduledUser by passing it in

Remove WorkorderItemScheduledUser by string of id value

Remove by Guid value of ID

Add a new WorkorderItemScheduledUser to the collection

Sets all items to read / write status used by workorder object when it's closed or service completed is true

true=Set to read only explicitly, false=set to whatever rights allowed

Check if item in collection

Check if item in collection by string of ID value

Check if item in deleted collection

Check if item in deleted collection by string of ID value

NewItems

Get items - Grandchild style

Fetch children - grandchild style

Update children

Given a workorder item ID deletes all items for that ID Called by workorderitems delete

ID of parent workorder item Database transaction from ascendant item

Retrieve WorkorderItemScheduledUser by index

Index

Retrieve WorkorderItemScheduledUser by string containing Guid value

This is a single check item - but a WorkorderItem may have multiples of checks For example, a checklist is a list of all the checks needed to confirm before closing the WorkorderItemTask item and workorder - each is a "checkitem" This way a manager can tie the workorder to these - can't close unless checked off by user logged in -check=Backup all data on harddrive YES/NO -check=Confirm backup is accessible YES/NO -check=install hard drive YES/NO -check=install operating system YES/NO -check=connection to internet YES/NO -check=update windows updates YES/NO -check=restore data from old harddrive YES/NO -check=install program......

ID of WorkorderItem this task belongs with

Whether completed, incomplete, not applicable Default is 0 (incomplete)

Back reference to group it came from

Called by parent collection object when called in turn by workorder object that is read only due to security or closed or service completed

Either true or the rights allowed for the current user

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Create item

Parent ID New Item

Retrieve item

Data reader item from database

Fetch from db

Persist object to database

Parent object Parents transaction object

Initial created date of this object

User ID of who initially created this object

Last modified date of this object

User ID of who last modified this object

Unique ID of this object

Whether completed, incomplete, not applicable Default is 0 (incomplete)

ID of WorkorderItem this task belongs with

Remove WorkorderItemTask by passing it in

Remove WorkorderItemTask by string of id value

Remove by Guid value of ID

Add a new WorkorderItemTask to the collection

Sets all items to read / write status used by workorder object when it's closed or service completed is true

true=Set to read only explicitly, false=set to whatever rights allowed

Check if item in collection

Check if item in collection by string of ID value

Check if item in deleted collection

Check if item in deleted collection by string of ID value

NewItems

Get items - Grandchild style

Fetch children - grandchild style

Update children

Given a workorder item ID deletes all items for that ID Called by workorderitems delete

ID of parent workorder item Database transaction from ascendant item

Retrieve WorkorderItemTask by index

Index

Retrieve WorkorderItemTask by string containing Guid value

Used to track travel for service both for billing back to client and for techs to track their own travel for re-imbursement etc

Private constructor to prevent direct instantiation

Called by parent collection object when called in turn by workorder object that is read only due to security or closed or service completed

Either true or the rights allowed for the current user

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

New item

Get Item

Update child

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Notes about WorkorderItemTravel This is additional information for the tech themselves - Appended to the details, not usually shows on Detailed reports given to client.

UserID selected must be schedulable and active. If displaying historical information, would show a N/A (non-active) next to the displayed name, but would not be able to reselect an active and schedulable user

if a rate that is set as a flat is selected, this field "disappears"?

Guid ID of root object (WorkorderItem)

Sales tax code for rates

this is the collection of actual travel incurred in relation to this WorkorderItem

Remove WorkorderItemTravel by passing it in

Remove WorkorderItemTravel by string of id value

Remove by Guid value of ID

Add a new WorkorderItemTravel to the collection

Sets all items to read / write status used by workorder object when it's closed or service completed is true

true=Set to read only explicitly, false=set to whatever rights allowed

Check if item in collection

Check if item in collection by string of ID value

Check if item in deleted collection

Check if item in deleted collection by string of ID value

NewItems

Get items - Grandchild style

Fetch children - grandchild style

Update children

Given a workorder item ID deletes all items for that ID Called by workorderitems delete

ID of parent workorder item Database transaction from ascendant item

Retrieve WorkorderItemTravel by index

Index

Retrieve WorkorderItemTravel by string containing Guid value

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Returns a search result object based on search terms for the ID specified

Create new WorkorderItemType

Fetch existing WorkorderItemType

Datareader

Populate this object from the values in the datareader passed to it

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Set/get client group name

Get /set active status of client group If active = true then WorkorderItemType is selectable for workorders etc If active = false then WorkorderItemType in not selectable, but history can be viewed

Remove WorkorderItemType by passing it in

Add a new WorkorderItemType to the collection

Add WorkorderItemType by passing it in

Check if item in collection

Check if item in deleted collection

Get item collection

Fetch children

Editable Root Collection Update

Locale key so that generic list editor UI code knows what title to give the list in a grid

Retrieve WorkorderItemType by index

Index

Criteria for identifying existing object

List of active Service Workorders for client specified (active meaning not closed and not set to service completed and type of Service)

Check if item in collection

Get all Workorders owned by client specified

Client owning Workorders

Get item by index

Returns WorkorderPickListInfo item that matches passed in itemid value

@returns

Criteria for identifying existing object

ID of root object this belongs to (workorder)

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Create item

Parent ID New Item

Retrieve item

Data reader item from database

Fetch from db

Persist object to database

Parent object Parents transaction object

Initial created date of this object

User ID of who initially created this object

Last modified date of this object

User ID of who last modified this object

Unique ID of this object

Incremental number from sql server

ID of Status this PM object will set to when initially converted to a Service Object from a PM object

ID of root object this belongs to (workorder)

Default is false If true, than no Client field as it defaults to scheduling internally with access to internal owned units (rental and non-rental) for service etc.

First start date of the range

Date range will stop at - takes precedence over totalreocurrences number

Number of CALENDAR months before reocurrence

Number of weeks before reocurrence

Number of days before reocurrence

number of recurrences Zero indicates a non-recurring item, in effect turning this off Only in effect if RangeStopDate not specified

True=included in pm and makes workorders etc False=on hold, not used, not included in automatic pm stuff

When to create a work order in advance For meter or if time based then it means days

When service is desired next/first

Frequency to repeat service on for meter based items Does apply to both UNIT and MODEL

UNIT that this applies to if not MODEL or CLIENT based Here so that when the workorder is made it knows which unit to enter on WorkorderItem.Unit (Also so knows which unit on a workorder is the one being pm'd for frequency etc)

For MODEL based PM ONLY A model PM is used only to generate unit based PM's i.e. user creates a unit, if there is a pm for that unit's model type then it prompts to create a pm, if yes then it copies this Model PM to a unit pm and changes type to unit and inserts unit id etc A workorder is *never* generated directly from a model pm as it is with other types

True=User cannot bypass creating a unit pm off this model False=User is prompted to create a pm for a unit if it has a model PM for it's type but the user can choose to do so or not

Unit, or Model or CLient (If model it's only a template, never gets converted to workorder but is copied over to make a unit PM only)

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

New quote

Called by DataPortal to delete/add/update data into the database

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

ID of user that is responsible for this quote Will take as default the mCreator ID, but user can select from list of schedulable and non-schedulable users

ID of Workorder (type = Service) object this WorkorderQuote created when approved

ID of root object this address belongs to (workorder)

When you present your quote to your customer, it helps to add some words introducing the quote to the customer, or maybe even reminding them what the quote is for and what it will cover. Very useful if you have to re-send to the client This is in addition to the Workorder object Summary field as that is limited in lenght

Incremental number from sql server

Date quote requested initially

Defaults to one month from mCreated date, but user can edit if needed Date quote details are still able to be approved and converted to a Service object

DateSubmitted - date quote submitted to client

Date client approves the quote if empty then client has not approved quote (this is set when the quote is converted to a workorder if empty)

Set the DB generated visible ID number to a new user chosen starting point

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Create item

Parent ID New Item

Retrieve item

Data reader item from database

Fetch from db

Persist object to database

Parent object Parents transaction object

Initial created date of this object

User ID of who initially created this object

Last modified date of this object

User ID of who last modified this object

Unique ID of this object

ID of Workorder (type = WorkorderPreventiveMaintenance) that this WorkorderService object was created from If not made from a PreventiveMaintenanc can be null

ID of Workorder (type WorkorderQuote) that this WorkorderService object was created from If not made from a quote, than can be null

ID of ClientRequest that this WorkorderService object was created from If not made from a ClientRequest can be null Not editable by the user

Incremental number from sql server

Default is false If true, than no Client field as it defaults to scheduling internally with access to internal owned units (rental and non-rental) for service etc.

Takes first the created date but than can be overwritten by the user i.e WorkorderService info was obtained yesterday, but not actually created til today. this way user can edit the ServiceDate and use for response time etc

Status of entire service workorder

One invoice number for entire workorder and all of its service items - if indivdual service items invoiced out separately, they should move the items to their own workorder.

ID of root object this address belongs to (workorder)

This is a user definable date and time used to indicate when a service workorder should be closed by. It's used to identify workorders that have been left to languish and not serviced promptly. A user needs the special Object.WorkorderService.CloseByDate right to be able to modify this even if they have full rights to the workorder object itself

Smart date version used by workorder notification processor

Set the DB generated visible ID number to a new user chosen starting point

Read only list of WorkorderService items

Check if item in collection

Get all WorkorderService (filtered by crit)

Return an empty list used for initializing grid

Get item by index

Returns display text that matches passed in itemid value

Attributes are all that user could select to be displayed

@returns

Not for viewing directly, sets the color of the status button

Criteria for identifying existing object

Private constructor to prevent direct instantiation

Throw an error when a read only user tries to set a property (this should normally never be called since the UI should prevent it from happening initially)

Get new object

Populate this object from the values in the datareader passed to it

Get internal id number Read only property because it's set internally, not externally

Get created date

Get modified date

Get user record ID of person who created this record

Get user ID of person who modified this record

Set/get Name of item

Description

ARGB color

Remove WorkorderStatus by passing it in

Add a new WorkorderStatus to the collection

Add WorkorderStatus by passing it in

Check if item in collection

Check if item in deleted collection

Get item collection

Fetch children

Editable Root Collection Update

Locale key so that generic list editor UI code knows what title to give the list in a grid

Retrieve WorkorderStatus by index

Index

Criteria for identifying existing object

A single workorder for a client

Used by PM system for recurring service.

An estimate provided to a client for approval that if approved gets copied to a Service

List of LoanItems for choosing in UI

Check if item in collection

Get a list of all LoanItems

Get item by index

Returns LoanItemPickListInfo item that matches passed in itemid value

@returns

Criteria for identifying existing object