com.sage.orion.sdata.servlet
Class ServiceField

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

Direct Known Subclasses:

ServiceFieldBoolean, ServiceFieldDecimal, ServiceFieldString

public class ServiceField
extends ResourceField

Service field class

Nested Class Summary

static class	ServiceField.ServiceFieldPresentationType Indicates the type of presentation information defined for a field.
static class	ServiceField.ServiceFieldType Service field types enum

Constructor Summary

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

ServiceField(java.lang.String name, ServiceField.ServiceFieldType type)
Constructing with name for the service field

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

ServiceField(java.lang.String name, java.lang.String description, boolean required, ServiceField.ServiceFieldType type, java.util.List<ServiceFieldPresentItem> presentsList)
Constructing with all the other parameters except value, length and digits attributes.

ServiceField(java.lang.String name, java.lang.String description, boolean required, ServiceField.ServiceFieldType type, java.util.List<ServiceFieldPresentItem> presentsList, java.lang.String value)
Constructing with all the parameters.

ServiceField(java.lang.String name, java.lang.String description, boolean required, ServiceField.ServiceFieldType type, java.lang.String value)
Constructing with all the parameters.

Method Summary

java.lang.String	getPresentationMask() Gets the presentation mask for the service field.
ServiceField.ServiceFieldPresentationType	getPresentationType() Gets the presentation type for the service field.
java.util.List<ServiceFieldPresentItem>	getPresentsList() Gets the presentation list for the service field.
ServiceField.ServiceFieldType	getType() Gets the type for the field.
java.lang.String	getValue() Gets the value for the service field.
boolean	isRequired() Gets the required for the service field.
void	setPresentationMask(java.lang.String presentationMask) Sets the presentation mask for the service field.
void	setPresentationType(ServiceField.ServiceFieldPresentationType presentationType) Sets the presentation type for the service field.
void	setPresentsList(java.util.List<ServiceFieldPresentItem> presentsList) Sets the presentation list for the service field.
void	setRequired(boolean required) Sets required for the field.
void	setType(ServiceField.ServiceFieldType type) Sets the type for the service field.
void	setValue(java.lang.String value) Sets the value for the service field.

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

ServiceField

public ServiceField(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 = ""

Parameters:

name - of the service field

ServiceField

public ServiceField(java.lang.String name,
                    ServiceField.ServiceFieldType type)

Constructing with name for the service field

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

Parameters:

name - of the service field.

type - type of the service field ServiceField.ServiceFieldType

ServiceField

public ServiceField(java.lang.String name,
                    java.lang.String description,
                    boolean required,
                    ServiceField.ServiceFieldType type)

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

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.

type - ServiceField.ServiceFieldType is the type of the service field.

ServiceField

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

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

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.

type - ServiceField.ServiceFieldType is the type of the service field.

presentsList - is a list of ServiceFieldPresentItem.

ServiceField

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

Constructing with all the 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.

type - ServiceField.ServiceFieldType is the type of the service field.

presentsList - is a list of ServiceFieldPresentItem.

value - of the service field.

ServiceField

public ServiceField(java.lang.String name,
                    java.lang.String description,
                    boolean required,
                    ServiceField.ServiceFieldType type,
                    java.lang.String value)

Constructing with all the 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.

type - ServiceField.ServiceFieldType is the type of the service field.

value - of the service field.

Method Detail

isRequired

public boolean isRequired()

Gets the required for the service field.

Returns:

if the value of the service field is required.

setRequired

public void setRequired(boolean required)

Sets required for the field.

Parameters:

required - is true when the value of the service field is required.

getPresentsList

public java.util.List<ServiceFieldPresentItem> getPresentsList()

Gets the presentation list for the service field.

Returns:

list of ServiceFieldPresentItem

setPresentsList

public void setPresentsList(java.util.List<ServiceFieldPresentItem> presentsList)

Sets the presentation list for the service field.

Parameters:

presentsList - list of ServiceFieldPresentItem

getType

public ServiceField.ServiceFieldType getType()

Gets the type for the field.

Returns:

service field type

setType

public void setType(ServiceField.ServiceFieldType type)

Sets the type for the service field.

Parameters:

type - ServiceField.ServiceFieldType

getPresentationType

public ServiceField.ServiceFieldPresentationType getPresentationType()

Gets the presentation type for the service field.

Returns:

ServiceField.ServiceFieldPresentationType

setPresentationType

public void setPresentationType(ServiceField.ServiceFieldPresentationType presentationType)

Sets the presentation type for the service field.

Parameters:

presentationType - ServiceField.ServiceFieldPresentationType

getPresentationMask

public java.lang.String getPresentationMask()

Gets the presentation mask for the service field.

Returns:

presentation mask.

setPresentationMask

public void setPresentationMask(java.lang.String presentationMask)

Sets the presentation mask for the service field.

Parameters:

presentationMask - presentation mask

getValue

public java.lang.String getValue()

Gets the value for the service field.

Returns:

value of the service field.

setValue

public void setValue(java.lang.String value)

Sets the value for the service field.

Parameters:

value - of the service field.