com.sage.orion.sdata.servlet.accpac
Class OptionalResourceField

java.lang.Object
  extended by com.sage.orion.sdata.servlet.ResourceField
      extended by com.sage.orion.sdata.servlet.accpac.OptionalResourceField

public final class OptionalResourceField
extends ResourceField

A ResourceField reflecting a custom or optional field in a view


Constructor Summary
OptionalResourceField(SDataView mainView, com.sage.accpac.sm.View detail, com.sage.orion.sdata.servlet.accpac.OptionalFieldsMaster master)
          constructs an OptionalResourceField from the current record of the application's optional fields details
 
Method Summary
 boolean allowsNull()
          returns whether or not the field allows null values
 java.lang.String getDefaultValue()
          returns the default value for the field
 java.lang.String getInternalName()
          gets the name of the field, as see from the Accpac side
 com.sage.orion.sdata.servlet.accpac.OptionalFieldType getType()
          returns the type of the field
 boolean isSetInitially()
          returns whether the field is supposed to be set to the default value automatically.
 boolean isSetRequired()
          returns whether the field is required.
 boolean isValidated()
          returns whether or not the field has validation switched on
 
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

OptionalResourceField

public OptionalResourceField(SDataView mainView,
                             com.sage.accpac.sm.View detail,
                             com.sage.orion.sdata.servlet.accpac.OptionalFieldsMaster master)
constructs an OptionalResourceField from the current record of the application's optional fields details

Parameters:
mainView - the main view that this is an optional or custom field on
detail - The application optional field detail record
master - The master list of optional fields
Method Detail

allowsNull

public boolean allowsNull()
returns whether or not the field allows null values

Returns:
true if and only if the field allows null values

getDefaultValue

public java.lang.String getDefaultValue()
returns the default value for the field

Returns:
the default value for the field, or null if there is no default

getType

public com.sage.orion.sdata.servlet.accpac.OptionalFieldType getType()
returns the type of the field

Returns:
the type of the field

isValidated

public boolean isValidated()
returns whether or not the field has validation switched on

Returns:
true if and only if the field has validation switched on

isSetInitially

public boolean isSetInitially()
returns whether the field is supposed to be set to the default value automatically.

Returns:
true if the field value is automatically set initially

isSetRequired

public boolean isSetRequired()
returns whether the field is required.

Returns:
true if and only if the field is required to be not null

getInternalName

public java.lang.String getInternalName()
gets the name of the field, as see from the Accpac side

Returns:
the internal name of the field


Copyright © 2011 Sage Software, Inc. All rights reserved.