Package com.storedobject.core

Class InventoryAssembly

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.core.InventoryAssembly

All Implemented Interfaces:

Displayable, StringFiller, HasId, HasInventoryItemType

public final class InventoryAssembly
extends StoredObject
implements HasInventoryItemType

An item can be an assembly, composed of one or more subitems, and each subitem can also be an assembly.

This class represents the definition of an assembly node.

Author:

Syam

Field Summary

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
InventoryAssembly()

Method Summary

Modifier and Type	Method	Description
boolean	canFit(Id partNumberId)	Is the given part number Id compatible for this assembly position?
boolean	canFit(InventoryItemType partNumber)	Is the given part number compatible for this assembly position?
static void	columns(Columns columns)
static InventoryAssembly	get(String pn)
boolean	getAccessory()
int	getDisplayOrder()
InventoryItemType	getInventoryItemType()	Returns the InventoryItemType (P/N) associated with this object.
InventoryItemType	getItemType()
Id	getItemTypeId()
int	getLevel()	Get the level number for this assembly.
boolean	getOptional()
InventoryItemType	getParentItemType()
Id	getParentItemTypeId()
String	getPosition()
Quantity	getQuantity()
static void	indices(Indices indices)
static ObjectIterator<InventoryAssembly>	list(String pn)
ObjectIterator<InventoryAssembly>	listAssemblies()	List of all assemblies (includes full-tree) defined under this assembly.
ObjectIterator<InventoryAssembly>	listImmediateAssemblies()	List of assemblies defined under this assembly.
static String[]	searchColumns()
void	setAccessory(boolean accessory)
void	setDisplayOrder(int displayOrder)
void	setItemType(Id itemTypeId)
void	setItemType(InventoryItemType itemType)
void	setItemType(BigDecimal idValue)
void	setOptional(boolean optional)
void	setParentItemType(Id parentItemTypeId)
void	setParentItemType(InventoryItemType itemType)
void	setParentItemType(BigDecimal idValue)
void	setPosition(String position)
void	setQuantity(Quantity quantity)
void	setQuantity(Object value)
String	toString()	String representation of the instance.
void	validateData(TransactionManager tm)	The system will invoke this whenever the object is saved to the DB.
void	validateDelete()	This method will be invoked whenever an existing instance is deleted from the database.

Methods inherited from class com.storedobject.core.StoredObject

addLink, addLink, addLink, addLink, addLink, addLink, addLink, addLink, checkCurrency, checkCurrency, checkForDuplicate, checkForDuplicate, checkTimeZone, checkTransaction, clearObjectLinks, contemporary, copy, copy, count, count, count, count, count, count, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, create, created, delete, delete, delete, deleted, directUpdate, equals, exists, exists, exists, exists, exists, existsFileData, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsMaster, existsMaster, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, family, family, family, family, fill, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, getActor, getAttachment, getAttachmentId, getChildren, getContemporaryOf, getDeleted, getDeleted, getExistsCondition, getExistsCondition, getFileData, getFileData, getHistorical, getId, getKeyIndex, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getNotExistsCondition, getNotExistsCondition, getParent, getParent, getParent, getParentId, getParentId, getParentId, getRelated, getRelated, getTransaction, getTransactionId, getTransactionIP, getUnique, getUniqueCondition, hashCode, inserted, isModified, isVirtual, list, list, list, list, list, list, list, list, list, list, list, list, list, listDeletedIds, listFileData, listFileData, listHistory, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listTree, listTree, listTree, listTree, listViaQuery, listViaQuery, load, load, load, load, loadAttributesFrom, loaded, loading, makeNew, makeVirtual, migrate, moduleName, nextVersion, objectLink, objectLink, objectLink, objectLinks, objectLinks, old, person, previousVersion, previousVersion, query, query, query, query, query, query, query, query, query, query, query, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, reload, reload, reloaded, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeReverseLinks, removeReverseLinks, save, save, save, save, save, save, save, save, save, save, save, save, save, save, save, saved, saving, setMaster, setRawValue, setTransaction, stringify, tableName, timestamp, toCode, toDisplay, transacting, undelete, undelete, undeleted, updated, user, userId, validate, validateChildAttach, validateChildDetach, validateChildUpdate, validateInsert, validateParentAttach, validateParentDetach, validateParentUpdate, validateUndelete, validateUpdate, valueEquals

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

InventoryAssembly

public InventoryAssembly()

Method Details

columns

public static void columns(Columns columns)

indices

public static void indices(Indices indices)

searchColumns

public static String[] searchColumns()

setPosition

public void setPosition(String position)

getPosition

@Column(required=false,
        order=200,
        caption="Position/Label")
public String getPosition()

setItemType

public void setItemType(Id itemTypeId)

setItemType

public void setItemType(BigDecimal idValue)

setItemType

public void setItemType(InventoryItemType itemType)

getItemTypeId

@SetNotAllowed
@Column(style="(any)",
        order=300)
public Id getItemTypeId()

getItemType

public InventoryItemType getItemType()

setParentItemType

public void setParentItemType(Id parentItemTypeId)

setParentItemType

public void setParentItemType(BigDecimal idValue)

setParentItemType

public void setParentItemType(InventoryItemType itemType)

getParentItemTypeId

@SetNotAllowed
@Column(order=100,
        style="(any)",
        caption="Next Hierarchy of")
public Id getParentItemTypeId()

getParentItemType

public InventoryItemType getParentItemType()

setQuantity

public void setQuantity(Quantity quantity)

setQuantity

public void setQuantity(Object value)

getQuantity

@Column(order=400)
public Quantity getQuantity()

setAccessory

public void setAccessory(boolean accessory)

getAccessory

@Column(order=500)
public boolean getAccessory()

setOptional

public void setOptional(boolean optional)

getOptional

@Column(order=600,
        caption="Optional/Add-on")
public boolean getOptional()

setDisplayOrder

public void setDisplayOrder(int displayOrder)

getDisplayOrder

@Column(order=700,
        required=false)
public int getDisplayOrder()

validateData

public void validateData(TransactionManager tm)
                  throws Exception

Description copied from class: StoredObject

The system will invoke this whenever the object is saved to the DB. It will be invoked in all cases while creating new objects and updating/deleting/undeleting existing objects. If any exception is raised by this method, the process of saving to the DB will be abandoned.

Note: This method is mainly used to validate the data of all attributes of the object, and it may be used by others for validating the object. For example, front-end data-entry systems can use this method for validating the object.

Overrides:

validateData in class StoredObject

Parameters:

tm - Current transaction manager.

Throws:

Exception - If data is invalid.

validateDelete

public void validateDelete()
                    throws Exception

Description copied from class: StoredObject

This method will be invoked whenever an existing instance is deleted from the database. So, it will be called within an active transaction. Child classes can override this method to do validation when an existing instance is deleted from the database.

Note: When overridden "super" should be called, otherwise, a "design error" will occur.

Also, see StoredObject.validate().

Overrides:

validateDelete in class StoredObject

Throws:

Exception - By raising an exception from this method, the current transaction can be abandoned.

toString

public String toString()

Description copied from class: StoredObject

String representation of the instance. Mostly used for logging purposes.

Overrides:

toString in class StoredObject

Returns:

String representation of the instance.

get

public static InventoryAssembly get(String pn)

list

public static ObjectIterator<InventoryAssembly> list(String pn)

canFit

public boolean canFit(InventoryItemType partNumber)

Is the given part number compatible for this assembly position?

Parameters:

partNumber - Part number to check.

Returns:

True or false.

canFit

public boolean canFit(Id partNumberId)

Is the given part number Id compatible for this assembly position?

Parameters:

partNumberId - Id of the part number to check.

Returns:

True or false.

listImmediateAssemblies

public ObjectIterator<InventoryAssembly> listImmediateAssemblies()

List of assemblies defined under this assembly. This instance is not included.

Returns:

List of assemblies.

listAssemblies

public ObjectIterator<InventoryAssembly> listAssemblies()

List of all assemblies (includes full-tree) defined under this assembly. This instance is not included.

Returns:

List of assemblies.

getLevel

public int getLevel()

Get the level number for this assembly. (Level numbers will be correctly set only if assemblies are retrieved via listAssemblies() or listImmediateAssemblies() methods).

Returns:

Level number in the hierarchy.

getInventoryItemType

public InventoryItemType getInventoryItemType()

Description copied from interface: HasInventoryItemType

Returns the InventoryItemType (P/N) associated with this object.

Specified by:

getInventoryItemType in interface HasInventoryItemType

Returns:

the InventoryItemType representing the type of the inventory item (P/N).