org.openwms.common.domain
Class LocationType

java.lang.Object
  extended by org.openwms.core.domain.AbstractEntity
      extended by org.openwms.common.domain.LocationType
All Implemented Interfaces:
Serializable, DomainObject<Long>

public class LocationType
extends AbstractEntity
implements DomainObject<Long>

A LocationType is the type of Locations with same characteristics.

Since:
0.1
Version:
$Revision: 1594 $
Author:
Heiko Scherrer
See Also:
Location, Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class org.openwms.core.domain.AbstractEntity
AbstractEntity.AbstractEntityListener
 
Field Summary
static String DEF_TYPE_DESCRIPTION
          Default value of the description, by default * "--" .
static String NQ_FIND_ALL
          Query to find all LocationTypes.
static String NQ_FIND_BY_UNIQUE_QUERY
          Query to find one LocationType by its natural key.
 
Fields inherited from class org.openwms.core.domain.AbstractEntity
FIND_ALL, FIND_BY_ID
 
Constructor Summary
LocationType(String type)
          Create a new LocationType with an unique natural key.
 
Method Summary
 String getDescription()
          Returns the description of this LocationType.
 int getHeight()
          Returns the height of the LocationType.
 Long getId()
          Return the technical key value.
 int getLength()
          Returns the length of the LocationType.
 String getType()
          Returns the unique identifier of the LocationType.
 long getVersion()
          Return the value of the optimistic locking field.
 int getWidth()
          Returns the width of this LocationType.
 boolean isNew()
          Check whether the instance is a transient or persisted one.
 void setDescription(String description)
          Set the description of the LocationType.
 void setHeight(int height)
          Set the height of this LocationType.
 void setLength(int length)
          Set the length of this LocationType.
 void setWidth(int width)
          Set the width of this LocationType.
 String toString()
          Return the type 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

NQ_FIND_ALL

public static final String NQ_FIND_ALL
Query to find all LocationTypes.

See Also:
Constant Field Values

NQ_FIND_BY_UNIQUE_QUERY

public static final String NQ_FIND_BY_UNIQUE_QUERY
Query to find one LocationType by its natural key.

See Also:
Constant Field Values

DEF_TYPE_DESCRIPTION

public static final String DEF_TYPE_DESCRIPTION
Default value of the description, by default * "--" .

See Also:
Constant Field Values
Constructor Detail

LocationType

public LocationType(String type)
Create a new LocationType with an unique natural key.

Parameters:
type - Unique type
Method Detail

getId

public Long getId()
Return the technical key value.

Specified by:
getId in interface DomainObject<Long>
Returns:
The technical, unique key

isNew

public boolean isNew()
Check whether the instance is a transient or persisted one.

Specified by:
isNew in interface DomainObject<Long>
Returns:
true if transient (not persisted before), otherwise false

getType

public String getType()
Returns the unique identifier of the LocationType.

Returns:
type The Type

getLength

public int getLength()
Returns the length of the LocationType.

Returns:
length The Length

setLength

public void setLength(int length)
Set the length of this LocationType.

Parameters:
length - The length of this type

getWidth

public int getWidth()
Returns the width of this LocationType.

Returns:
width The Width

setWidth

public void setWidth(int width)
Set the width of this LocationType.

Parameters:
width - The width of this type

getDescription

public String getDescription()
Returns the description of this LocationType.

Returns:
description The description text

setDescription

public void setDescription(String description)
Set the description of the LocationType.

Parameters:
description - The description text of this type

getHeight

public int getHeight()
Returns the height of the LocationType.

Returns:
height The Height

setHeight

public void setHeight(int height)
Set the height of this LocationType.

Parameters:
height - The height of this type

getVersion

public long getVersion()
Return the value of the optimistic locking field.

Specified by:
getVersion in interface DomainObject<Long>
Returns:
the version number

toString

public String toString()
Return the type as String.

Overrides:
toString in class Object
Returns:
String
See Also:
Object.toString()


Copyright © 2005-2011 openwms.org. All Rights Reserved.