com.americancoders.edi
Interface IDListProcessor

All Superinterfaces:

java.io.Externalizable, java.io.Serializable

All Known Implementing Classes:

IDList, IDList103Processor

public interface IDListProcessor

extends java.io.Externalizable

An interface for classes that process ID lists

OBOE - Open Business Objects for EDI

Part of the OBOE Basic Extended Package
An EDI and XML Translator Written In Java
Copyright 1998-2007 - 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.5.2

Author:

Joe McVerry - American Coders, Ltd.

Method Summary

void	add(java.lang.String inCode, java.lang.String inDescribe) Add code and description An optional method.
java.lang.String	describe(java.lang.String inCode) returns the descriptive value of the code, if it is not found then the code is returned
java.lang.String	getCode(java.lang.String inValue) returns the code value for a descriptive value.
java.lang.String	getCodeByPos(int pos) returns a code at a specific position in vector An optional method.
java.util.Vector	getCodes() returns the code vector
java.util.Vector	getValues() returns the value vector
boolean	isCodeValid(java.lang.String inCode) tests if the passed code is valid

Methods inherited from interface java.io.Externalizable

readExternal, writeExternal

Method Detail

add

public void add(java.lang.String inCode,
                java.lang.String inDescribe)
         throws java.lang.UnsupportedOperationException

Add code and description
An optional method.

Parameters:

inCode - String code

inDescribe - String descriptive value

Throws:

java.lang.UnsupportedOperationException

isCodeValid

public boolean isCodeValid(java.lang.String inCode)

tests if the passed code is valid

Parameters:

inCode - String to test

Returns:

boolean

describe

public java.lang.String describe(java.lang.String inCode)

returns the descriptive value of the code, if it is not found then the code is returned

Parameters:

inCode - String to test

Returns:

String

getCode

public java.lang.String getCode(java.lang.String inValue)

returns the code value for a descriptive value. if it is not found the value is returned

Parameters:

inValue - String to test

Returns:

String

getCodeByPos

public java.lang.String getCodeByPos(int pos)
                              throws java.lang.UnsupportedOperationException

returns a code at a specific position in vector
An optional method.

Parameters:

pos - int String position

Returns:

String

Throws:

java.lang.UnsupportedOperationException

getCodes

public java.util.Vector getCodes()

returns the code vector

Returns:

Vector

getValues

public java.util.Vector getValues()

returns the value vector

Returns:

Vector