com.portal.pcm

Class Element

java.lang.Object

com.portal.pcm.Field

com.portal.pcm.Element

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

ArrayField

public class Element
extends Field

The element class contains information pertaining to fields that belong to an FList array.

Version:

1.0 12/2/97

Author:

Larry Lynch-Freshner

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	ELEMID_ANY 'Any' Element ID - matches all element IDs.
static int	ELEMID_ASSIGN 'Assign' Element ID - Used to request element ID assignment.
static int	ELEMID_MAX Maximum element ID value.

Fields inherited from class com.portal.pcm.Field

OPFLG_CUST_FLDS_ONLY, PIN_DD_FLDS_CUST_FLDS_MAX_RANGE1, PIN_DD_FLDS_CUST_FLDS_MIN_RANGE1, PIN_DD_FLDS_CUST_FLDS_MIN_RANGE2, TYPE_ARRAY, TYPE_BINSTR, TYPE_BUF, TYPE_DECIMAL, TYPE_ENUM, TYPE_ERR, TYPE_INT, TYPE_NUM, TYPE_OBJ, TYPE_POID, TYPE_STR, TYPE_SUBSTRUCT, TYPE_TEXTBUF, TYPE_TIME, TYPE_TSTAMP, TYPE_UINT, TYPE_UNUSED

Constructor Summary

Constructors

Constructor and Description
Element(int nameID, int typeID, int elementID) Constructs an instance of Element from a name ID, a type ID, and an element ID.
Element(int nameID, int typeID, int elementID, String name)

Method Summary

Modifier and Type	Method and Description
int	getElementID() Returns the element ID.
void	setElementID(int elementID) Sets the element ID.
String	toString() Returns a string representation of field.

Methods inherited from class com.portal.pcm.Field

clone, equals, fromName, fromName, fromPINName, getName, getNameID, getNameString, getNameString, getPINType, getTypeID, hashCode, macroToClass

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ELEMID_ANY

public static final int ELEMID_ANY

'Any' Element ID - matches all element IDs.

See Also:

Constant Field Values

ELEMID_ASSIGN

public static final int ELEMID_ASSIGN

'Assign' Element ID - Used to request element ID assignment.

See Also:

Constant Field Values

ELEMID_MAX

public static final int ELEMID_MAX

Maximum element ID value.

See Also:

Constant Field Values

Constructor Detail

Element

public Element(int nameID,
               int typeID,
               int elementID)

Constructs an instance of Element from a name ID, a type ID, and an element ID.

Parameters:

nameID - A valid Portal field name.

typeID - A valid Portal storable class type name.

elementID - A valid element ID.

See Also:

ELEMID_ANY, ELEMID_ASSIGN, ELEMID_MAX

Element

public Element(int nameID,
               int typeID,
               int elementID,
               String name)

Method Detail

getElementID

public int getElementID()

Returns the element ID.

Returns:

The element id.

setElementID

public void setElementID(int elementID)

Sets the element ID.

Parameters:

elementID - The element ID.

toString

public String toString()

Description copied from class: Field

Returns a string representation of field.

Overrides:

toString in class Field

Returns:

A string representation of this field.