Open Business Objects for EDI
v3.6.0

com.americancoders.edi
Class TimeDE

java.lang.Object
  |
  +--com.americancoders.edi.DataElement
        |
        +--com.americancoders.edi.TimeDE
All Implemented Interfaces:
IContainedObject, IIdentifier

public class TimeDE
extends DataElement
implements IContainedObject

class for Data Elements defined as Time

OBOE - Open Business Objects for EDI

Part of the OBOE Basic Extended Package
An EDI and XML Translator Written In Java
Copyright 1998-2009 - American Coders, LTD - Raleigh NC USA
All rights reserved
American Coders, Ltd
P. O. Box 97462
Raleigh, NC 27624 USA
1-919-846-2014
http://www.americancoders.com

Version:
3.6.0
Author:
Joe McVerry - American Coders, Ltd.

Field Summary
protected  int cursor
           
protected  java.lang.String[] value
           
 
Fields inherited from class com.americancoders.edi.DataElement
parent
 
Constructor Summary
TimeDE(com.americancoders.edi.TemplateDE inTDE, com.americancoders.edi.IContainedObject inParent)
          constructs from its template
 
Method Summary
 java.lang.String get()
          returns the date stored in HHMMSSmmm format where HH is hour MM is minutes SS is seconds mmm is milliseconds
 java.lang.String get(int inPos)
          returns the value for the Data Element
 java.lang.String getFormattedText(int formatType)
          formats text of data element
Short Description of DataElement is defined in the class
value is the current value set in the object
 int getLength()
          gets the current length for the Data Element
 void set(byte[] inValue)
          sets the fields contents, not formatted
 void set(java.lang.String inTime)
          sets the value (sets cursor to zero) stored using an input string in the format HHMMSS where HH is hour MM is minutes SS is seconds,
 void setNext(java.lang.String inTime)
          sets the value (by moving cursor, cursor will wrap around) stored using an input string in the format HHMMSS where HH is hour MM is minutes SS is seconds,
 boolean validate(com.americancoders.edi.DocumentErrors inDErr)
          sets error in DocumentErrors
 java.lang.String validate(java.lang.String inText)
          returns error responses of contents
 
Methods inherited from class com.americancoders.edi.DataElement
getDescription, getFixedLengthFormattedText, getID, getMaxLength, getMinLength, getName, getOccurs, getParent, getRequired, getSequence, getTemplate, getType, getXMLTag, isUsed, setParent, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.americancoders.edi.IContainedObject
getParent, setParent
 
Methods inherited from interface com.americancoders.edi.IIdentifier
getID, getXMLTag
 

Field Detail

value

protected java.lang.String[] value

cursor

protected int cursor
Constructor Detail

TimeDE

public TimeDE(com.americancoders.edi.TemplateDE inTDE,
              com.americancoders.edi.IContainedObject inParent)
constructs from its template

Parameters:
inTDE - TemplateDE
inParent - owning Object
Method Detail

get

public java.lang.String get()
returns the date stored in HHMMSSmmm format where

Specified by:
get in class DataElement
Returns:
String in format HHMMSSmmm

get

public java.lang.String get(int inPos)
returns the value for the Data Element

Parameters:
inPos - int position in array
Returns:
String

set

public void set(java.lang.String inTime)
sets the value (sets cursor to zero) stored using an input string in the format HHMMSS where

Specified by:
set in class DataElement
Parameters:
inTime - String field in format HHMMSS

setNext

public void setNext(java.lang.String inTime)
sets the value (by moving cursor, cursor will wrap around) stored using an input string in the format HHMMSS where

Specified by:
setNext in class DataElement
Parameters:
inTime - String field in format HHMMSS

set

public void set(byte[] inValue)
         throws OBOEException
sets the fields contents, not formatted

Specified by:
set in class DataElement
Parameters:
inValue - byte array, converted to string and set(String) is called
Throws:
OBOEException - inValue contains format characters if field defined with type of N#

getLength

public int getLength()
gets the current length for the Data Element

Specified by:
getLength in class DataElement
Returns:
int retuns length of set value, can have a null exception if value is not set.

getFormattedText

public java.lang.String getFormattedText(int formatType)
formats text of data element
Short Description of DataElement is defined in the class
value is the current value set in the object

Specified by:
getFormattedText in class DataElement
Parameters:
formatType - int x12, edifact...
Returns:
String formatted string

validate

public java.lang.String validate(java.lang.String inText)
returns error responses of contents

Specified by:
validate in class DataElement
Parameters:
inText - String text
Returns:
String

validate

public boolean validate(com.americancoders.edi.DocumentErrors inDErr)
sets error in DocumentErrors

Specified by:
validate in class DataElement
Parameters:
inDErr - DocumentErrors object
Returns:
boolean false = error.

Open Business Objects for EDI
v3.6.0


OBOE is a trademark or registered trademark of American Coders, Ltd. in the US and other countries.
Copyright 1999-2004 American Coders, Ltd.
POB 97462
Raleigh NC 27624 USA
All Rights Reserved.