com.jamasoftware.contour.ws.v3.domain
Class WsLookup

java.lang.Object
  extended by com.jamasoftware.contour.ws.v3.domain.WsLookup

public class WsLookup
extends java.lang.Object

This object represents an entry in a Pick List.

Author:
Dylan
See Also:
WsLookupType

Constructor Summary
WsLookup()
          Creates an empty WsLookup object.
WsLookup(java.lang.String name, java.lang.String description, WsLookupType lookupType)
          Creates a new WsLookup with the given values.
 
Method Summary
 java.lang.String getColor()
          Gets the color hex string for this lookup
 java.lang.String getDataValue()
          Gets the value for this lookup.
 java.lang.String getDescription()
          Gets the lookup's description.
 java.lang.Long getId()
          Gets the lookup's id.
 java.lang.String getImage()
          Gets the image associated with this lookup.
 WsLookupType getLookupType()
          Gets the lookup type.
 java.lang.String getName()
          Gets the lookup's name.
 java.lang.Integer getSortOrder()
          Gets the sort order for this lookup.
 boolean isActive()
          Is this lookup active?
 boolean isDefault()
          Is this the default value for the associated lookup type?
 void setActive(boolean active)
          Sets whether or not this is lookup is active.
 void setColor(java.lang.String color)
          Sets the color hex string for this lookup
 void setDataValue(java.lang.String dataValue)
          Sets the value for this lookup.
 void setDefault(boolean isDefault)
          Sets whether or not this is the default value for the associated lookup type.
 void setDescription(java.lang.String description)
          Sets the lookup's description.
 void setId(java.lang.Long id)
          Sets the lookup's id.
 void setImage(java.lang.String image)
          Sets the image associated with this lookup.
 void setLookupType(WsLookupType lookupType)
          Sets the lookup type.
 void setName(java.lang.String name)
          Sets the lookup's name.
 void setSortOrder(java.lang.Integer sortOrder)
          Sets the sort order for this lookup.
 java.lang.String toString()
          Gets a string representation of this lookup.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

WsLookup

public WsLookup()
Creates an empty WsLookup object.


WsLookup

public WsLookup(java.lang.String name,
                java.lang.String description,
                WsLookupType lookupType)
Creates a new WsLookup with the given values.

Parameters:
name - name of the lookup entry
description - description of the lookup entry (can be null)
lookupType - lookupType this lookup entry is associated with
Method Detail

getId

public java.lang.Long getId()
Gets the lookup's id.

Returns:
the id

setId

public void setId(java.lang.Long id)
Sets the lookup's id.

Parameters:
id - the id to set

getName

public java.lang.String getName()
Gets the lookup's name.

Returns:
the name

setName

public void setName(java.lang.String name)
Sets the lookup's name.

Parameters:
name - the name to set

getDescription

public java.lang.String getDescription()
Gets the lookup's description.

Returns:
the description

setDescription

public void setDescription(java.lang.String description)
Sets the lookup's description.

Parameters:
description - the description to set

getLookupType

public WsLookupType getLookupType()
Gets the lookup type.

Returns:
the lookupType

setLookupType

public void setLookupType(WsLookupType lookupType)
Sets the lookup type.

Parameters:
lookupType - the lookupType to set

getImage

public java.lang.String getImage()
Gets the image associated with this lookup.

Returns:
the image

setImage

public void setImage(java.lang.String image)
Sets the image associated with this lookup.

Parameters:
image - the image to set

getSortOrder

public java.lang.Integer getSortOrder()
Gets the sort order for this lookup.

Returns:
the sortOrder

setSortOrder

public void setSortOrder(java.lang.Integer sortOrder)
Sets the sort order for this lookup.

Parameters:
sortOrder - the sortOrder to set

isDefault

public boolean isDefault()
Is this the default value for the associated lookup type?

Returns:
whether or not this is the default value

setDefault

public void setDefault(boolean isDefault)
Sets whether or not this is the default value for the associated lookup type.

Parameters:
isDefault - whether or not this should be the default value

isActive

public boolean isActive()
Is this lookup active?

Returns:
whether or not this lookup is active

setActive

public void setActive(boolean active)
Sets whether or not this is lookup is active.

Parameters:
active - whether or not this lookup should be active

getDataValue

public java.lang.String getDataValue()
Gets the value for this lookup.

Returns:
the dataValue

setDataValue

public void setDataValue(java.lang.String dataValue)
Sets the value for this lookup.

Parameters:
dataValue - the dataValue to set

getColor

public java.lang.String getColor()
Gets the color hex string for this lookup

Returns:
the color

setColor

public void setColor(java.lang.String color)
Sets the color hex string for this lookup

Parameters:
color - color to set

toString

public java.lang.String toString()
Gets a string representation of this lookup.

Overrides:
toString in class java.lang.Object
Returns:
String


Copyright (c) 2010 Jama Software, Inc. All Rights Reserved.