Package com.storedobject.core

Class InventoryTransfer

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.core.InventoryTransfer

All Implemented Interfaces:

Displayable, StringFiller, HasId, HasReference, OfEntity

Direct Known Subclasses:

InventoryReturn, InventorySale, MaterialReturned, MaterialTransferred

public abstract class InventoryTransfer
extends StoredObject
implements OfEntity, HasReference

Nested Class Summary

Nested classes/interfaces inherited from interface com.storedobject.core.HasReference

HasReference.Amend<T extends StoredObject>

Field Summary

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
InventoryTransfer()

Method Summary

Modifier and Type	Method	Description
Id	amend(Transaction transaction)	Amend this.
static void	columns(Columns columns)
String	getActionDescription(ActionType actionType)	Returns the action description based on the specified action type.
final <O extends StoredObject> HasReference.Amend<O>	getAmend()
final int	getAmendment()
boolean	getApprovalRequired()
Date	getDate()
final Entity	getEntityFrom()
final Entity	getEntityTo()
InventoryLocation	getFromLocation()
Id	getFromLocationId()
String	getFromLocationName()	Get the name of the location from which the items are being transferred.
int	getFromLocationType()	Get the type of the location from which the items are being transferred.
Date	getInvoiceDate()
String	getInvoiceNumber()
int	getNo()
final String	getReference()
String	getReferenceNumber()
String	getRemark()
int	getStatus()
String	getStatusValue()
static String	getStatusValue(int value)
static String[]	getStatusValues()
SystemEntity	getSystemEntity()
Id	getSystemEntityId()
String	getTagPrefix()	Get the prefix of the tag to be used for generating the reference.
InventoryLocation	getToLocation()
Id	getToLocationId()
String	getToLocationName()	Get the name of the location to which the items are being transferred.
int	getToLocationType()	Get the type of the location to which the items are being transferred.
static void	indices(Indices indices)
static String[]	protectedColumns()
void	receive(Transaction transaction)
static String[]	searchColumns()
void	send(Transaction transaction)
final void	setAmendment(int amendment)
void	setApprovalRequired(boolean approvalRequired)
void	setDate(Date date)
void	setFromLocation(Id fromLocationId)
void	setFromLocation(InventoryLocation fromLocation)
void	setFromLocation(BigDecimal idValue)
void	setInvoiceDate(Date invoiceDate)
void	setInvoiceNumber(String invoiceNumber)
void	setNo(int no)
void	setReferenceNumber(String referenceNumber)
void	setRemark(String remark)
void	setStatus(int status)
void	setSystemEntity(Id systemEntityId)
void	setSystemEntity(SystemEntity systemEntity)
void	setSystemEntity(BigDecimal idValue)
void	setToLocation(Id toLocationId)
void	setToLocation(InventoryLocation toLocation)
void	setToLocation(BigDecimal idValue)
String	toDisplay()	Display representation of the instance used for human-friendly display.
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, toString, 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

Methods inherited from interface com.storedobject.core.HasReference

getTagSuffix, serialTag

Methods inherited from interface com.storedobject.core.OfEntity

check, findSystemEntityId

Constructor Details

InventoryTransfer

public InventoryTransfer()

Method Details

columns

public static void columns(Columns columns)

indices

public static void indices(Indices indices)

protectedColumns

public static String[] protectedColumns()

searchColumns

public static String[] searchColumns()

setSystemEntity

public void setSystemEntity(Id systemEntityId)

Specified by:

setSystemEntity in interface OfEntity

setSystemEntity

public void setSystemEntity(BigDecimal idValue)

setSystemEntity

public void setSystemEntity(SystemEntity systemEntity)

getSystemEntityId

@SetNotAllowed
@Column(order=10,
        caption="Of")
public Id getSystemEntityId()

Specified by:

getSystemEntityId in interface HasReference

Specified by:

getSystemEntityId in interface OfEntity

getSystemEntity

public SystemEntity getSystemEntity()

Specified by:

getSystemEntity in interface HasReference

Specified by:

getSystemEntity in interface OfEntity

setNo

public void setNo(int no)

getNo

@SetNotAllowed
@Column(style="(serial)",
        order=10)
public int getNo()

Specified by:

getNo in interface HasReference

getTagPrefix

public String getTagPrefix()

Description copied from interface: HasReference

Get the prefix of the tag to be used for generating the reference.

Warning: This should be a fixed string value.

Specified by:

getTagPrefix in interface HasReference

Returns:

A fixed tag value to be used as the prefix.

getReference

public final String getReference()

Specified by:

getReference in interface HasReference

getAmend

public final <O extends StoredObject>
HasReference.Amend<O> getAmend()

Specified by:

getAmend in interface HasReference

setAmendment

public final void setAmendment(int amendment)

getAmendment

@SetNotAllowed
@Column(order=1000)
public final int getAmendment()

setDate

public void setDate(Date date)

getDate

@Column(order=100)
public Date getDate()

Specified by:

getDate in interface HasReference

setInvoiceNumber

public void setInvoiceNumber(String invoiceNumber)

getInvoiceNumber

public String getInvoiceNumber()

setReferenceNumber

public void setReferenceNumber(String referenceNumber)

getReferenceNumber

@Column(style="(code)",
        order=200,
        required=false,
        caption="Other Reference")
public String getReferenceNumber()

setInvoiceDate

public void setInvoiceDate(Date invoiceDate)

getInvoiceDate

@Column(order=300)
public Date getInvoiceDate()

setFromLocation

public void setFromLocation(Id fromLocationId)

setFromLocation

public void setFromLocation(BigDecimal idValue)

setFromLocation

public void setFromLocation(InventoryLocation fromLocation)

getFromLocationId

@Column(style="(any)",
        order=400)
public Id getFromLocationId()

getFromLocation

public InventoryLocation getFromLocation()

setToLocation

public void setToLocation(Id toLocationId)

setToLocation

public void setToLocation(BigDecimal idValue)

setToLocation

public void setToLocation(InventoryLocation toLocation)

getToLocationId

@Column(style="(any)",
        order=500)
public Id getToLocationId()

getToLocation

public InventoryLocation getToLocation()

setStatus

public void setStatus(int status)

getStatus

@SetNotAllowed
@Column(order=600)
public int getStatus()

getStatusValues

public static String[] getStatusValues()

getStatusValue

public static String getStatusValue(int value)

getStatusValue

public String getStatusValue()

setRemark

public void setRemark(String remark)

getRemark

@Column(order=700,
        required=false)
public String getRemark()

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.

getFromLocationType

public int getFromLocationType()

Get the type of the location from which the items are being transferred.

Note: An overridden class should always return a constant value.

Returns:

Location type. A negative value means that the location type is not known.

getFromLocationName

public String getFromLocationName()

Get the name of the location from which the items are being transferred.

Note: An overridden class should always return a constant value.

Returns:

Location name.

getToLocationType

public int getToLocationType()

Get the type of the location to which the items are being transferred.

Note: An overridden class should always return a constant value.

Returns:

Location type. A negative value means that the location type is not known.

getToLocationName

public String getToLocationName()

Get the name of the location to which the items are being transferred.

Note: An overridden class should always return a constant value.

Returns:

Location name.

getActionDescription

public String getActionDescription(ActionType actionType)

Returns the action description based on the specified action type.

Parameters:

actionType - The type of the action, represented as an instance of ActionType. It could be one of the following: NOUN, VERB_PRESENT, VERB_PAST, or VERB_PAST_PARTICIPLE.

Returns:

A string representing the action description. Returns "Transfer" for NOUN and VERB_PRESENT. Returns "Transferred" for VERB_PAST and VERB_PAST_PARTICIPLE.

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.

send

public void send(Transaction transaction)
          throws Exception

Throws:

Exception

receive

public void receive(Transaction transaction)
             throws Exception

Throws:

Exception

amend

public Id amend(Transaction transaction)
         throws Exception

Amend this. This entry will be closed (marked with status as "returned"), and another entry will be created with all the items under it. Any new item added to it will be added with a new amendment number.

Parameters:

transaction - Transaction.

Returns:

The id of the newly created (and saved) entry.

Throws:

Exception - If any exception occurs while carrying out the transaction.

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.

setApprovalRequired

public void setApprovalRequired(boolean approvalRequired)

getApprovalRequired

public boolean getApprovalRequired()

getEntityFrom

public final Entity getEntityFrom()

getEntityTo

public final Entity getEntityTo()