InventAvailabilitySearch Class [AX 2012]

The InventAvailabilitySearch class is a builder of the search criteria that can be used to find the on hand availability.

Syntax

class InventAvailabilitySearch implements SysPackable

Run On

Called

Methods

	Method	Description
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	canDetermineInventDimCriteria
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	inventDimCriteria	The inventory dimensions criteria.
	inventDimCriteriaParm	An InventDimParm record that defines which of the dimension criteria values should be used when searching for the availability.
	inventSum	The InventSum record that matches the search criteria.
	inventTable	The item criteria.
	isInventSumSet	Returns true if the InventSum record has been set for this search criteria.
	isItemWHSEnabled	Determines if the criteria item is WHS-enabled.
	isValid	Determines if the search criteria is valid or not.
	itemId	The ID of the criteria item.
	new	Initializes a new instance of the InventAvailabilitySearch class.
	notify	Releases the hold on an object that has called the wait method on this object. (Inherited from Object.)
	notifyAll	Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.)
	objectOnServer	Determines whether the object is on a server. (Inherited from Object.)
	owner	Returns the instance that owns the object. (Inherited from Object.)
	pack	Serializes the current instance of the InventAvailabilitySearch class.
	setInventDimCriteria	Sets the inventory dimensions criteria.
	setInventSum	Sets the InventSum record that matches the search criteria.
	setInventTable	Sets the InventTable record for the criteria item.
	setItemId	Sets the ID of the criteria item.
	setItemIsWHSEnabled	Sets the value indicating whether the criteria item is WHS-enabled.
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	toString	Returns a string that represents the current object. (Inherited from Object.)
	unpack	Deserializes the _packed parameter value to an instance of the InventAvailabilitySearch class.
	usageCount	Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
	wait	Pauses a process. (Inherited from Object.)
	xml	Returns an XML string that represents the current object. (Inherited from Object.)
	::construct	Initializes a new instance of the InventAvailabilitySearch class.
	::create	Creates an instance of the InventAvailabilitySearch class based on the container that contains a serialized InventAvailabilitySearch object.
	::newFromItemDim	Creates search criteria based on the specified item and dimension criteria.
	::newFromItemIdDim	Creates search criteria based on the specified item ID and dimension criteria.
	::newFromItemSumDim	Creates search criteria based on the specified item, the specified InventSum and the dimensions that were used as a filter to find this record.
	::newFromSum	Creates a search criteria based on the specified InventSum.
	::newFromSumDim	Creates search criteria based on the specified InventSum and the dimensions that were used as a filter to find this record.

Top

Remarks

The InventAvailabilitySearch has a number of setter methods that allow you to specify as much information about the desired on hand as you have. The more information you can provide the better performance you will get. E.g. providing an InventTable record instead of ItemId will result in better performance.

If you don't specify some of the mandatory parameters your search criteria will be invalid (see more in the documentation to the isValid method.

Note that the InventAvailabilitySearch should only be used to instantiate a single search criteria. Reusing the same search criteria for different searches is not supported. I.e. you should never do the following: - create a search criteria - run the availability search - change the same search criteria (e.g. the dimension criteria) - run the availability search again. Always create a new criteria insted.

Inheritance Hierarchy

Object Class
  InventAvailabilitySearch Class