|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.openwms.core.domain.AbstractEntity
org.openwms.common.domain.Location
public class Location
A Location, represents some physical as well as virtual place in a warehouse.
Could be something like a storage location in the stock or a location on a conveyer. Also virtual or error locations can be modeled with a Location entity.
Multiple Locations are grouped to a LocationGroup.
LocationGroup
,
Serialized FormNested Class Summary |
---|
Nested classes/interfaces inherited from class org.openwms.core.domain.AbstractEntity |
---|
AbstractEntity.AbstractEntityListener |
Field Summary | |
---|---|
static String |
NQ_FIND_ALL
Query to find all Location s. |
static String |
NQ_FIND_ALL_EAGER
Query to find all Location s with all Message s and
LocationType s (eager loaded). |
static String |
NQ_FIND_BY_UNIQUE_QUERY
Query to find one Location by its natural
key. |
Fields inherited from class org.openwms.core.domain.AbstractEntity |
---|
FIND_ALL, FIND_BY_ID |
Constructor Summary | |
---|---|
Location(LocationPK locationId)
Create a new Location with the business key. |
Method Summary | |
---|---|
boolean |
addMessage(Message message)
Add a new Message to this Location . |
String |
getCheckState()
Returns the checkState to indicate the stock check procedure. |
String |
getDescription()
Returns the description of the Location . |
Long |
getId()
Return the technical key. |
Date |
getLastAccess()
Return the date when the Location was updated the last time. |
LocationGroup |
getLocationGroup()
Return the LocationGroup where the
Location belongs to. |
LocationPK |
getLocationId()
Returns the locationId (natural key) of the Location . |
LocationType |
getLocationType()
Returns the type of Location . |
BigDecimal |
getMaximumWeight()
Return the maximum allowed weight on the Location . |
Set<Message> |
getMessages()
Returns an unmodifiable Set of Message s stored for the
Location . |
short |
getNoMaxTransportUnits()
Returns the maximum number of TransportUnit s allowed on the
Location . |
short |
getPlcState()
Return the current set plc state. |
long |
getVersion()
Return the value of the optimistic locking field. |
boolean |
isConsideredInAllocation()
Determine whether the Location is considered during
allocation. |
boolean |
isCountingActive()
Determine whether TransportUnit s should
be counted on this Location or not. |
boolean |
isIncomingActive()
Determine whether incoming mode is activated and TransportUnit s can be put on this
Location . |
boolean |
isInfeedBlocked()
Check whether infeed is blocked and moving TransportUnit s to here
is forbidden. |
boolean |
isLocationGroupCountingActive()
Determine whether the Location is part of the parent
LocationGroup s calculation procedure of
TransportUnit s. |
boolean |
isNew()
Check whether the instance is a transient or persisted one. |
boolean |
isOutfeedBlocked()
Check whether outfeed is blocked and moving TransportUnit s from
here is forbidden. |
boolean |
isOutgoingActive()
Determine whether outgoing mode is activated and TransportUnit s can leave this
Location . |
protected void |
preUpdate()
On update or insert the lastAccess is updated to the current date. |
boolean |
removeMessages(Message... messages)
Remove one or more Message s from this Location . |
void |
setCheckState(String checkState)
Change the checkState of the Location . |
void |
setConsideredInAllocation(boolean consideredInAllocation)
Change the behavior whether the Location shall be considered
in the allocation procedure or not. |
void |
setCountingActive(boolean countingActive)
Change the behavior whether the Location shall be considered
in the calculation of TransportUnit s or
not. |
void |
setDescription(String description)
Change the description of the Location . |
void |
setIncomingActive(boolean incomingActive)
Change the incoming state of the Location . |
void |
setLastAccess(Date lastAccess)
Change the date when the Location was updated the last time. |
void |
setLocationGroup(LocationGroup locationGroup)
Add this Location to the locationGroup . |
void |
setLocationGroupCountingActive(boolean locationGroupCountingActive)
Define whether or not the Location shall be considered in
counting TransportUnit s of the parent
LocationGroup . |
void |
setLocationType(LocationType locationType)
Change the type of the Location . |
void |
setMaximumWeight(BigDecimal maximumWeight)
Change the maximum allowed weight of the Location . |
void |
setNoMaxTransportUnits(short noMaxTransportUnits)
Change the maximum number of TransportUnit s allowed on the
Location . |
void |
setOutgoingActive(boolean outgoingActive)
Change the outgoing state of the Location . |
void |
setPlcState(short plcState)
Change the current plc state. |
String |
toString()
Return the LocationPK as String. |
Methods inherited from class org.openwms.core.domain.AbstractEntity |
---|
equals, hashCode |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String NQ_FIND_ALL
Location
s.
public static final String NQ_FIND_ALL_EAGER
Location
s with all Message
s and
LocationType
s (eager loaded).
public static final String NQ_FIND_BY_UNIQUE_QUERY
Location
by its natural
key. Location
to search for
Constructor Detail |
---|
public Location(LocationPK locationId)
Location
with the business key.
locationId
- The unique natural key of the Location
Method Detail |
---|
public boolean addMessage(Message message)
Message
to this Location
.
message
- The Message
to be added
true
if the Message
is new in the collection
of messages, otherwise false
public String getCheckState()
public boolean isConsideredInAllocation()
Location
is considered during
allocation.
true
when considered in allocation, otherwise
false
public boolean isCountingActive()
TransportUnit
s should
be counted on this Location
or not.
true
when counting is active, otherwise
false
public String getDescription()
Location
.
public Long getId()
getId
in interface DomainObject<Long>
public boolean isIncomingActive()
TransportUnit
s can be put on this
Location
.
true
when incoming mode is activated, otherwise
false
public boolean isInfeedBlocked()
TransportUnit
s to here
is forbidden.
true
is blocked, otherwise false
public Date getLastAccess()
Location
was updated the last time.
public LocationGroup getLocationGroup()
LocationGroup
where the
Location
belongs to.
LocationGroup
of the
Location
public boolean isLocationGroupCountingActive()
Location
is part of the parent
LocationGroup
s calculation procedure of
TransportUnit
s.
true
if calculation is activated, otherwise
false
public LocationPK getLocationId()
Location
.
public LocationType getLocationType()
Location
.
public BigDecimal getMaximumWeight()
Location
.
public Set<Message> getMessages()
Message
s stored for the
Location
.
public short getNoMaxTransportUnits()
TransportUnit
s allowed on the
Location
.
TransportUnit
spublic boolean isOutgoingActive()
TransportUnit
s can leave this
Location
.
true
when outgoing mode is activated, otherwise
false
public boolean isOutfeedBlocked()
TransportUnit
s from
here is forbidden.
true
is blocked, otherwise false
public short getPlcState()
public long getVersion()
getVersion
in interface DomainObject<Long>
public boolean isNew()
isNew
in interface DomainObject<Long>
true
if transient (not persisted before), otherwise
false
public boolean removeMessages(Message... messages)
Message
s from this Location
.
messages
- An array of Message
s to be removed
true
if the Message
s were found and removed,
otherwise false
IllegalArgumentException
- when messages is null
public void setCheckState(String checkState)
Location
.
checkState
- The new state to setpublic void setConsideredInAllocation(boolean consideredInAllocation)
Location
shall be considered
in the allocation procedure or not.
consideredInAllocation
- true
allocation active, otherwise
false
public void setCountingActive(boolean countingActive)
Location
shall be considered
in the calculation of TransportUnit
s or
not.
countingActive
- true
counting active, otherwise
false
public void setDescription(String description)
Location
.
description
- The new description textpublic void setIncomingActive(boolean incomingActive)
Location
.
incomingActive
- true
The Location
can pick up
TransportUnit
s, otherwise
false
public void setLastAccess(Date lastAccess)
Location
was updated the last time.
lastAccess
- The date of change.public void setLocationGroup(LocationGroup locationGroup)
Location
to the locationGroup
. When
the argument is null
an existing LocationGroup
is
removed from the Location
.
locationGroup
- The LocationGroup
to be assignedpublic void setLocationGroupCountingActive(boolean locationGroupCountingActive)
Location
shall be considered in
counting TransportUnit
s of the parent
LocationGroup
.
locationGroupCountingActive
- true
if considered, otherwise false
public void setLocationType(LocationType locationType)
Location
.
locationType
- The new type to setpublic void setMaximumWeight(BigDecimal maximumWeight)
Location
.
maximumWeight
- The new weight to setpublic void setNoMaxTransportUnits(short noMaxTransportUnits)
TransportUnit
s allowed on the
Location
.
noMaxTransportUnits
- The number of TransportUnit
s
to setpublic void setOutgoingActive(boolean outgoingActive)
Location
.
outgoingActive
- true
TransportUnit
s can be moved
away from the Location
, otherwise
false
public void setPlcState(short plcState)
plcState
- The new state to setpublic String toString()
LocationPK
as String.
toString
in class Object
LocationPK.toString()
protected void preUpdate()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |