com.jamasoftware.contour.ws.domain

Class WsPropertyEntry

java.lang.Object

com.jamasoftware.contour.ws.domain.WsPropertyEntry

public class WsPropertyEntry
extends Object

This object represents a property entry. Property entries are used to store several kinds of system variables.

Author:

Dylan

Field Summary

Fields

Modifier and Type	Field and Description
static Integer	PROPERTY_TYPE_BOOLEAN This declares that the value of the property entry is a boolean value and should be parsed accordingly.
static Integer	PROPERTY_TYPE_STRING This declares that the value of the property entry is a string value.

Constructor Summary

Constructors

Constructor and Description
WsPropertyEntry() Creates an empty WsPropertyEntry object.
WsPropertyEntry(Integer scope, Integer refId, String propertyName, String propertyValue, Integer propertyType) Creates a new WsPropertyEntry object from the given scope, refId, name, value and type.

Method Summary

Methods

Modifier and Type	Method and Description
Integer	getId() Gets this property entry's id.
String	getPropertyName() Gets the full name of the property entry (i.e.
Integer	getPropertyType() Gets the type of the property entry.
String	getPropertyValue() Gets the value for the property entry.
Integer	getRefId() Gets the reference id of this property entry.
Integer	getScope() Gets the scope of this property entry.
void	setId(Integer id) Sets this property entry's id.
void	setPropertyName(String propertyName) Sets the full name of the property entry.
void	setPropertyType(Integer propertyType) Sets the type of the property entry.
void	setPropertyValue(String propertyValue) Sets the value for the property entry.
void	setRefId(Integer refId) Sets the reference id of this property entry.
void	setScope(Integer scope) Sets the scope of this property entry.
String	toString() Gets a string representation of this property entry.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PROPERTY_TYPE_STRING

public static final Integer PROPERTY_TYPE_STRING

This declares that the value of the property entry is a string value. This can be used to store dates, integers, and anything else that can be parsed from a string. The value is 0.

PROPERTY_TYPE_BOOLEAN

public static final Integer PROPERTY_TYPE_BOOLEAN

This declares that the value of the property entry is a boolean value and should be parsed accordingly. The value is 1.

Constructor Detail

WsPropertyEntry

public WsPropertyEntry()

Creates an empty WsPropertyEntry object.

WsPropertyEntry

public WsPropertyEntry(Integer scope,
               Integer refId,
               String propertyName,
               String propertyValue,
               Integer propertyType)

Creates a new WsPropertyEntry object from the given scope, refId, name, value and type.

Parameters:

scope - scope of the property entry

refId - reference id

propertyName - name of the property entry

propertyValue - value of the property entry

propertyType - type of the property entry

Method Detail

getId

public Integer getId()

Gets this property entry's id.

Returns:

property entry id

setId

public void setId(Integer id)

Sets this property entry's id.

Parameters:

id - property entry id

getScope

public Integer getScope()

Gets the scope of this property entry.

Returns:

property entry scope

See Also:

WsScope

setScope

public void setScope(Integer scope)

Sets the scope of this property entry.

Parameters:

scope - property entry scope

See Also:

WsScope

getRefId

public Integer getRefId()

Gets the reference id of this property entry.

Returns:

property entry reference id

setRefId

public void setRefId(Integer refId)

Sets the reference id of this property entry.

Parameters:

refId - property entry reference id

getPropertyName

public String getPropertyName()

Gets the full name of the property entry (i.e. jama.project.maxPageSize).

Returns:

property entry name

setPropertyName

public void setPropertyName(String propertyName)

Sets the full name of the property entry.

Parameters:

propertyName - property entry name

getPropertyValue

public String getPropertyValue()

Gets the value for the property entry.

Returns:

property entry value (may need to be parsed)

setPropertyValue

public void setPropertyValue(String propertyValue)

Sets the value for the property entry.

Parameters:

propertyValue - a string of the property entry value

getPropertyType

public Integer getPropertyType()

Gets the type of the property entry. If the type is "1" then the property entry's value is boolean and should be parsed accordingly. If the type is "0" then the property entry's value is not boolean.

Returns:

property entry type

setPropertyType

public void setPropertyType(Integer propertyType)

Sets the type of the property entry. If the type is "1" then the property entry's value is boolean and should be parsed accordingly. If the type is "0" then the property entry's value is not boolean.

Parameters:

propertyType - the type of the property entry

toString

public String toString()

Gets a string representation of this property entry.

Overrides:

toString in class Object

Returns:

String