Package com.storedobject.core

Class MaterialRequest

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.core.MaterialRequest

All Implemented Interfaces:

Displayable, StringFiller, HasId, HasReference, OfEntity

public class MaterialRequest
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
MaterialRequest()

Method Summary

Modifier and Type	Method	Description
static String[]	browseColumns()
static void	columns(Columns columns)
void	foreclose(Transaction transaction)
Date	getDate()
InventoryLocation	getFromLocation()
Id	getFromLocationId()
String	getIssueReference()
int	getNo()
Person	getPerson()
Id	getPersonId()
MaterialRequestPriority	getPriority()
Id	getPriorityId()
boolean	getReceived()
String	getReference()
String	getReferenceNumber()	Deprecated.
String	getRemarks()
Timestamp	getRequiredBefore()
boolean	getReserved()
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()
int	getType()
static void	indices(Indices indices)
static String[]	links()
static String[]	protectedColumns()
void	reduceRequestedQuantity(Transaction transaction, InventoryItemType partNumber, Quantity reduceBy)
void	releaseReservation(Transaction transaction)	Release all reserved items.
void	request(Transaction transaction)
void	requestForIssuance(Transaction transaction)
void	reserve(Transaction transaction)
static String[]	searchColumns()
void	setDate(Date date)
void	setFromLocation(Id fromLocationId)
void	setFromLocation(InventoryLocation fromLocation)
void	setFromLocation(BigDecimal idValue)
void	setNo(int no)
void	setPerson(Id personId)
void	setPerson(Person person)
void	setPerson(BigDecimal idValue)
void	setPriority(Id priorityId)
void	setPriority(MaterialRequestPriority priority)
void	setPriority(BigDecimal idValue)
void	setReceived(boolean received)
void	setReferenceNumber(String referenceNumber)	Deprecated.
void	setRemarks(String remarks)
void	setRequiredBefore(Timestamp requiredBefore)
void	setReserved(boolean reserved)
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	validate()	The system invokes this method internally whenever the object gets saved to the DB (that means, while doing transactions).
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.
void	validateUpdate()	This method will be invoked whenever an existing instance is updated in 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, validateChildAttach, validateChildDetach, validateChildUpdate, validateInsert, validateParentAttach, validateParentDetach, validateParentUpdate, validateUndelete, valueEquals

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.storedobject.core.HasReference

getAmend, getTagSuffix, serialTag

Methods inherited from interface com.storedobject.core.OfEntity

check, findSystemEntityId

Constructor Details

MaterialRequest

public MaterialRequest()

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()

searchColumns

public static String[] searchColumns()

links

public static String[] links()

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

setDate

public void setDate(Date date)

getDate

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

Specified by:

getDate in interface HasReference

setReferenceNumber

@Deprecated
public void setReferenceNumber(String referenceNumber)

Deprecated.

getReferenceNumber

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

Deprecated.

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 String getReference()

Specified by:

getReference in interface HasReference

getIssueReference

public String getIssueReference()

setFromLocation

public void setFromLocation(Id fromLocationId)

setFromLocation

public void setFromLocation(BigDecimal idValue)

setFromLocation

public void setFromLocation(InventoryLocation fromLocation)

getFromLocationId

@SetNotAllowed
@Column(style="(any)",
        order=300)
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

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

getToLocation

public InventoryLocation getToLocation()

setStatus

public void setStatus(int status)

getStatus

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

getStatusValues

public static String[] getStatusValues()

getStatusValue

public static String getStatusValue(int value)

getStatusValue

public String getStatusValue()

setPriority

public void setPriority(Id priorityId)

setPriority

public void setPriority(BigDecimal idValue)

setPriority

public void setPriority(MaterialRequestPriority priority)

getPriorityId

@Column(order=600)
public Id getPriorityId()

getPriority

public MaterialRequestPriority getPriority()

setRequiredBefore

public void setRequiredBefore(Timestamp requiredBefore)

getRequiredBefore

@Column(order=700)
public Timestamp getRequiredBefore()

setRemarks

public void setRemarks(String remarks)

getRemarks

@Column(style="(large)",
        required=false,
        order=800)
public String getRemarks()

setPerson

public void setPerson(Id personId)

setPerson

public void setPerson(BigDecimal idValue)

setPerson

public void setPerson(Person person)

getPersonId

@SetNotAllowed
@Column(caption="Requested by",
        order=900)
public Id getPersonId()

getPerson

public Person getPerson()

setReserved

public void setReserved(boolean reserved)

getReserved

@SetNotAllowed
@Column(order=1000)
public boolean getReserved()

setReceived

public void setReceived(boolean received)

getReceived

@SetNotAllowed
@Column(order=1100)
public boolean getReceived()

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.

validate

public void validate()
              throws Exception

Description copied from class: StoredObject

The system invokes this method internally whenever the object gets saved to the DB (that means, while doing transactions). It will be invoked in all cases (while creating new objects and updating/deleting/undeleting existing objects). If this method raises any exceptions, the process of saving to the DB will be abandoned.

This method is not usually used for validating data (For that purpose, StoredObject.validateData(TransactionManager) is recommended). It is mainly used for validating the state of the object. Methods such as StoredObject.created(), StoredObject.updated(), StoredObject.deleted(), StoredObject.undeleted() etc., are used to check the specific states, but overridden methods may check for other "application-specific"/"business-specific" states.

This method is invoked only after one of the other operation-specific validate-methods is invoked depending on the save operation - StoredObject.validateInsert(), StoredObject.validateUpdate(), StoredObject.validateDelete(), StoredObject.validateUndelete().

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

Overrides:

validate in class StoredObject

Throws:

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

validateUpdate

public void validateUpdate()
                    throws Exception

Description copied from class: StoredObject

This method will be invoked whenever an existing instance is updated in 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 updated in the database.

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

Also, see StoredObject.validate().

Overrides:

validateUpdate in class StoredObject

Throws:

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

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.

releaseReservation

public void releaseReservation(Transaction transaction)
                        throws Exception

Release all reserved items.

Parameters:

transaction - Transaction.

Throws:

Exception - if any error occurs.

request

public void request(Transaction transaction)
             throws Exception

Throws:

Exception

reserve

public void reserve(Transaction transaction)
             throws Exception

Throws:

Exception

requestForIssuance

public void requestForIssuance(Transaction transaction)
                        throws Exception

Throws:

Exception

foreclose

public void foreclose(Transaction transaction)
               throws Exception

Throws:

Exception

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.

reduceRequestedQuantity

public void reduceRequestedQuantity(Transaction transaction,
 InventoryItemType partNumber,
 Quantity reduceBy)
                             throws Exception

Throws:

Exception

getType

public int getType()