com.sage.orion.sdata.servlet
Class ServiceFieldString

java.lang.Object
  com.sage.orion.sdata.servlet.ResourceField
      com.sage.orion.sdata.servlet.ServiceField
          com.sage.orion.sdata.servlet.ServiceFieldString

public class ServiceFieldString
extends ServiceField

ServiceFieldString contains information of the ServiceField related to only String field types.

Nested Class Summary

Nested classes/interfaces inherited from class com.sage.orion.sdata.servlet.ServiceField

ServiceField.ServiceFieldPresentationType, ServiceField.ServiceFieldType

Constructor Summary

ServiceFieldString(java.lang.String name)
Constructing with name for the service field

ServiceFieldString(java.lang.String name, java.lang.String description, boolean required)
Constructing ServiceFieldString.

ServiceFieldString(java.lang.String name, java.lang.String description, boolean required, int maxLength, int lengthEstimate)
Constructing ServiceFieldString.

ServiceFieldString(java.lang.String name, java.lang.String description, boolean required, java.util.List<ServiceFieldPresentItem> presentsList)
Constructing ServiceFieldString.

ServiceFieldString(java.lang.String name, java.lang.String description, boolean required, java.util.List<ServiceFieldPresentItem> presentsList, java.lang.String value)
Constructing ServiceFieldString.

ServiceFieldString(java.lang.String name, java.lang.String description, boolean required, java.util.List<ServiceFieldPresentItem> presentsList, java.lang.String value, int maxLength, int lengthEstimate)
Constructing ServiceFieldString for all String field parameters.

ServiceFieldString(java.lang.String name, java.lang.String description, boolean required, java.lang.String value)
Constructing with all the other parameters except presentsList, value, length and digits attributes.

Method Summary

int	getLengthEstimate() Gets the length estimate for the field.
int	getMaxLength() Gets the maximum length for the field.
void	setLengthEstimate(int lengthEstimate) Sets length estimate for the field.
void	setMaxLength(int maxLength) Sets maximum length for the field.

Methods inherited from class com.sage.orion.sdata.servlet.ServiceField

getPresentationMask, getPresentationType, getPresentsList, getType, getValue, isRequired, setPresentationMask, setPresentationType, setPresentsList, setRequired, setType, setValue

Methods inherited from class com.sage.orion.sdata.servlet.ResourceField

equals, getDescription, getName, hashCode, setDescription, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceFieldString

public ServiceFieldString(java.lang.String name)

Constructing with name for the service field

The description will be defaulted to the name. And required = true; type = STRING; presentsList = null; value = ""; maxLength =0; lengthEstimate=0;

Parameters:

name - name

ServiceFieldString

public ServiceFieldString(java.lang.String name,
                          java.lang.String description,
                          boolean required,
                          java.lang.String value)

Constructing with all the other parameters except presentsList, value, length and digits attributes.

The attribute values for lengths and digits will be defaulted to 0; presentationList = null;

Parameters:

name - of the service field

description - of the service field.

required - is true when a value is required for this service field, false otherwise.

value - of the service field.

ServiceFieldString

public ServiceFieldString(java.lang.String name,
                          java.lang.String description,
                          boolean required)

Constructing ServiceFieldString.

The value of the field will be defaulted to "" The attribute values for lengths and digits will be defaulted to 0;

Parameters:

name - of the service field

description - of the service field.

required - is true when a value is required for this service field, false otherwise.

ServiceFieldString

public ServiceFieldString(java.lang.String name,
                          java.lang.String description,
                          boolean required,
                          java.util.List<ServiceFieldPresentItem> presentsList)

Constructing ServiceFieldString.

The value of the field will be defaulted to "" The attribute values for lengths and digits will be defaulted to 0;

Parameters:

name - of the service field

description - of the service field.

required - is true when a value is required for this service field, false otherwise.

presentsList - is a list of ServiceFieldPresentItem

ServiceFieldString

public ServiceFieldString(java.lang.String name,
                          java.lang.String description,
                          boolean required,
                          int maxLength,
                          int lengthEstimate)

Constructing ServiceFieldString.

The value of the field will be defaulted to ""

Parameters:

name - of the service field

description - of the service field.

required - is true when a value is required for this service field, false otherwise.

maxLength - is the maximum length of the service field string.

lengthEstimate - is the estimated average length of the service field string.

ServiceFieldString

public ServiceFieldString(java.lang.String name,
                          java.lang.String description,
                          boolean required,
                          java.util.List<ServiceFieldPresentItem> presentsList,
                          java.lang.String value,
                          int maxLength,
                          int lengthEstimate)

Constructing ServiceFieldString for all String field parameters.

Parameters:

name - of the service field

description - of the service field.

required - is true when a value is required for this service field, false otherwise.

presentsList - is a list of ServiceFieldPresentItem

value - is the value of the service field.

maxLength - is the maximum length of the service field string.

lengthEstimate - is the estimated average length of the service field string.

ServiceFieldString

public ServiceFieldString(java.lang.String name,
                          java.lang.String description,
                          boolean required,
                          java.util.List<ServiceFieldPresentItem> presentsList,
                          java.lang.String value)

Constructing ServiceFieldString.

maxLength defaults to 0; lengthEstimate defaults to 0;

Parameters:

name - of the service field

description - of the service field.

required - is true when a value is required for this service field, false otherwise.

presentsList - is a list of ServiceFieldPresentItem

value - is the value of the service field.

Method Detail

getMaxLength

public int getMaxLength()

Gets the maximum length for the field.

Returns:

max length

setMaxLength

public void setMaxLength(int maxLength)

Sets maximum length for the field.

Parameters:

maxLength - max lenght

getLengthEstimate

public int getLengthEstimate()

Gets the length estimate for the field.

Returns:

length estimate

setLengthEstimate

public void setLengthEstimate(int lengthEstimate)

Sets length estimate for the field.

Parameters:

lengthEstimate - length estimate