Package com.storedobject.core

Class InventoryVirtualLocation

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.core.InventoryLocation

com.storedobject.core.InventoryVirtualLocation

All Implemented Interfaces:

Displayable, StringFiller, HasChildren, HasId

public final class InventoryVirtualLocation
extends InventoryLocation
implements HasChildren

Represents all types of virtual locations for inventory items. These are auto-created by the platform as and when needed.

Author:

Syam

Field Summary

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
InventoryVirtualLocation()

Method Summary

Modifier and Type	Method	Description
static String[]	browseColumns()
static void	columns(Columns columns)
String	getCode()
static InventoryVirtualLocation	getConsumptionLocation(Entity entity)
static InventoryVirtualLocation	getConsumptionLocation(SystemEntity systemEntity)
Entity	getEntity()
Id	getEntityId()
static InventoryVirtualLocation	getForConsumer(Id consumerId)
static InventoryVirtualLocation	getForExternalOwner(Id ownerId)
static InventoryVirtualLocation	getForLoanFrom(Id lenderId)
static InventoryVirtualLocation	getForLoanTo(Id loaneeId)
static InventoryVirtualLocation	getForRepairOrganization(Id supplierId)
static InventoryVirtualLocation	getForSupplier(Id supplierId)
static InventoryVirtualLocation	getRecycleLocation()
static InventoryVirtualLocation	getScrapLocation(SystemEntity systemEntity)
static InventoryVirtualLocation	getShortageLocation(SystemEntity systemEntity)
int	getStatus()
String	getStatusValue()
static String	getStatusValue(int value)
static String[]	getStatusValues()
int	getType()	Get the type of this location.
static void	indices(Indices indices)
boolean	isActive()
static String[]	links()
static String[]	protectedColumns()
void	setCode(String code)
void	setEntity(Entity entity)
void	setEntity(Id entityId)
void	setEntity(BigDecimal idValue)
void	setStatus(int status)
void	setType(int type)
String	toDisplay()	Display representation of the instance used for human-friendly display.
String	toString()	String representation of the instance.
void	validateChildAttach(StoredObject child, int linkType)	Do validation when a child is attached.
void	validateData(TransactionManager tm)	The system will invoke this whenever the object is saved to the DB.

Methods inherited from class com.storedobject.core.InventoryLocation

canBin, canBin, canResurrect, canStore, displayColumns, getCategoryId, getIssueText, getName, getReceiptText, getReturnPolicy, getReturnPolicyValue, getReturnPolicyValue, getReturnPolicyValues, getTypeValue, getTypeValue, getTypeValues, isInspectionRequired, isScrapAllowed, setCategory, setName, setReturnPolicy, validate

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, transacting, undelete, undelete, undeleted, updated, user, userId, validateChildDetach, validateChildUpdate, validateDelete, validateInsert, validateParentAttach, validateParentDetach, validateParentUpdate, validateUndelete, validateUpdate, valueEquals

Methods inherited from class java.lang.Object

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

Constructor Details

InventoryVirtualLocation

public InventoryVirtualLocation()

Method Details

columns

public static void columns(Columns columns)

indices

public static void indices(Indices indices)

browseColumns

public static String[] browseColumns()

protectedColumns

public static String[] protectedColumns()

links

public static String[] links()

setEntity

public void setEntity(Id entityId)

setEntity

public void setEntity(BigDecimal idValue)

setEntity

public void setEntity(Entity entity)

getEntityId

@SetNotAllowed
@Column(order=200)
public Id getEntityId()

Specified by:

getEntityId in class InventoryLocation

getEntity

public Entity getEntity()

getType

@SetNotAllowed
@Column(order=300)
public int getType()

Description copied from class: InventoryLocation

Get the type of this location. Location type values are as follows:

0: Inventory store bins InventoryBin

1: Supplier locations (purchased items are coming from supplier locations)

2: Consumer/customer locations (items sold to a customer go here)

3: Repair/Maintenance organization (items sent for repair or maintenance work will be located here)

4: Production unit

5: Maintenance unit (within the organization)

6: Scrap

7: Inventory shortage is booked here

8: Rented/Loaned out to (an outside organization)

9: Rented/Leased from (an outside organization)

10: Service Unit or Work Centers (providing services to external customers)

11: Repair unit (within the organization)

12: Initial inventory (used as a source for data pick-up)

13: Service/Subscription

14: Assembly (fitment positions on assembled items) InventoryFitmentPosition

15: Thrash - used for keeping items that were entered with incorrect details

16: Internal consumption (Consume the item internally - typically consumables)

17: External owner (Can receive stock from these locations but the ownership is still theirs)

18: Custody (In the custody of someone. Mostly used for tools)

19: Packaged (Packaged in a package for sending it out)

20: Fixed asset

21: Consumption by external entities

Specified by:

getType in class InventoryLocation

Returns:

Location type.

setType

public void setType(int type)

setCode

public void setCode(String code)

getCode

@Column(order=400,
        required=false,
        style="(code)")
public String getCode()

setStatus

public void setStatus(int status)

getStatus

@Column(order=500,
        required=false)
public int getStatus()

getStatusValues

public static String[] getStatusValues()

getStatusValue

public static String getStatusValue(int value)

getStatusValue

public String getStatusValue()

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 InventoryLocation

Parameters:

tm - Current transaction manager.

Throws:

Exception - If data is invalid.

toString

public String toString()

Description copied from class: StoredObject

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

Overrides:

toString in class InventoryLocation

Returns:

String representation of the instance.

toDisplay

public String toDisplay()

Description copied from class: StoredObject

Display representation of the instance used for human-friendly display.

Specified by:

toDisplay in interface Displayable

Overrides:

toDisplay in class StoredObject

Returns:

Display representation of the instance.

getForExternalOwner

public static InventoryVirtualLocation getForExternalOwner(Id ownerId)

getForLoanFrom

public static InventoryVirtualLocation getForLoanFrom(Id lenderId)

getForLoanTo

public static InventoryVirtualLocation getForLoanTo(Id loaneeId)

getForSupplier

public static InventoryVirtualLocation getForSupplier(Id supplierId)

getForRepairOrganization

public static InventoryVirtualLocation getForRepairOrganization(Id supplierId)

getForConsumer

public static InventoryVirtualLocation getForConsumer(Id consumerId)

getScrapLocation

public static InventoryVirtualLocation getScrapLocation(SystemEntity systemEntity)

getShortageLocation

public static InventoryVirtualLocation getShortageLocation(SystemEntity systemEntity)

getConsumptionLocation

public static InventoryVirtualLocation getConsumptionLocation(SystemEntity systemEntity)

getConsumptionLocation

public static InventoryVirtualLocation getConsumptionLocation(Entity entity)

getRecycleLocation

public static InventoryVirtualLocation getRecycleLocation()

validateChildAttach

public void validateChildAttach(StoredObject child,
 int linkType)
                         throws Exception

Description copied from class: StoredObject

Do validation when a child is attached.

Note: This method will be invoked only if this class implements HasChildren.

Overrides:

validateChildAttach in class StoredObject

Parameters:

child - Child to validate.

linkType - Link type.

Throws:

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

isActive

public boolean isActive()

Overrides:

isActive in class InventoryLocation