Field (Oracle Communications Billing and Revenue Management PCM Java API Reference)

java.lang.Object
- com.portal.pcm.Field

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

BinStrField, BufField, DecimalField, Element, EnumField, ErrField, Int64Field, IntField, NumField, ObjField, PoidField, StrField, SubStructField, TextBufField, TimeField, TStampField, UIntField
```
public class Field
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable
```
The field class contains information not only on the field ID, but on the type associated with it, and its permissions. Access methods are typed using specific Field subtypes to acheive compile-time type checking.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`OPFLG_CUST_FLDS_ONLY`
`static int`	`PIN_DD_FLDS_CUST_FLDS_MAX_RANGE1`
`static int`	`PIN_DD_FLDS_CUST_FLDS_MIN_RANGE1`
`static int`	`PIN_DD_FLDS_CUST_FLDS_MIN_RANGE2`
`static int`	`TYPE_ARRAY`
`static int`	`TYPE_BINSTR`
`static int`	`TYPE_BUF`
`static int`	`TYPE_DECIMAL`
`static int`	`TYPE_ENUM`
`static int`	`TYPE_ERR`
`static int`	`TYPE_INT`
`static int`	`TYPE_INT64`
`static int`	`TYPE_NUM`
`static int`	`TYPE_OBJ`
`static int`	`TYPE_POID`
`static int`	`TYPE_STR`
`static int`	`TYPE_SUBSTRUCT`
`static int`	`TYPE_TEXTBUF`
`static int`	`TYPE_TIME`
`static int`	`TYPE_TSTAMP`
`static int`	`TYPE_UINT`
`static int`	`TYPE_UNUSED`

Constructor Summary

Constructors
Constructor and Description
`Field(int nameID, int typeID)` Constructs an instance of `Field` from a name ID and a type ID.
`Field(int nameID, int typeID, java.lang.String name)` Constructs an instance of `Field` from a name ID , typeID and name .

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`clone()` Clones a field.
`boolean`	`equals(java.lang.Object other)` Determines if two fields are equal.
`static Field`	`fromName(int nameid)` Constructs and returns an instance of Field based on the name ID with type of the field.
`static Field`	`fromName(java.lang.String origName)` Constructs and returns an instance of Field based on the name of the field.
`static Field`	`fromPINName(java.lang.String name)` Constructs and returns an instance of Field based on the name of the field as defined in the C header files.
`int`	`getName()` Returns the field name.
`int`	`getNameID()` Returns the field name ID.
`java.lang.String`	`getNameString()` Returns the string name of the field as it appears in the C header files (for example, 'PIN_FLD_POID').
`static java.lang.String`	`getNameString(int nameID)` Returns the string name of the field as it appears in the C header files (for example, 'PIN_FLD_POID').
`java.lang.String`	`getPINType()` Returns a string representing the PIN type name of this field.
`int`	`getTypeID()` Returns the type name.
`int`	`hashCode()` Returns a hash value for this object.
`static java.lang.String`	`macroToClass(java.lang.String name)` Converts a string field name from the PIN macro form to the Java class name form.
`java.lang.String`	`toString()` Returns a string representation of field.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - TYPE_UNUSED
```
public static final int TYPE_UNUSED
```
    See Also:
    
    Constant Field Values
  - TYPE_INT
```
public static final int TYPE_INT
```
    See Also:
    
    Constant Field Values
  - TYPE_UINT
```
public static final int TYPE_UINT
```
    See Also:
    
    Constant Field Values
  - TYPE_ENUM
```
public static final int TYPE_ENUM
```
    See Also:
    
    Constant Field Values
  - TYPE_NUM
```
public static final int TYPE_NUM
```
    See Also:
    
    Constant Field Values
  - TYPE_STR
```
public static final int TYPE_STR
```
    See Also:
    
    Constant Field Values
  - TYPE_BUF
```
public static final int TYPE_BUF
```
    See Also:
    
    Constant Field Values
  - TYPE_POID
```
public static final int TYPE_POID
```
    See Also:
    
    Constant Field Values
  - TYPE_TSTAMP
```
public static final int TYPE_TSTAMP
```
    See Also:
    
    Constant Field Values
  - TYPE_ARRAY
```
public static final int TYPE_ARRAY
```
    See Also:
    
    Constant Field Values
  - TYPE_SUBSTRUCT
```
public static final int TYPE_SUBSTRUCT
```
    See Also:
    
    Constant Field Values
  - TYPE_OBJ
```
public static final int TYPE_OBJ
```
    See Also:
    
    Constant Field Values
  - TYPE_BINSTR
```
public static final int TYPE_BINSTR
```
    See Also:
    
    Constant Field Values
  - TYPE_ERR
```
public static final int TYPE_ERR
```
    See Also:
    
    Constant Field Values
  - TYPE_DECIMAL
```
public static final int TYPE_DECIMAL
```
    See Also:
    
    Constant Field Values
  - TYPE_TIME
```
public static final int TYPE_TIME
```
    See Also:
    
    Constant Field Values
  - TYPE_TEXTBUF
```
public static final int TYPE_TEXTBUF
```
    See Also:
    
    Constant Field Values
  - TYPE_INT64
```
public static final int TYPE_INT64
```
    See Also:
    
    Constant Field Values
  - OPFLG_CUST_FLDS_ONLY
```
public static final int OPFLG_CUST_FLDS_ONLY
```
    See Also:
    
    Constant Field Values
  - PIN_DD_FLDS_CUST_FLDS_MIN_RANGE1
```
public static final int PIN_DD_FLDS_CUST_FLDS_MIN_RANGE1
```
    See Also:
    
    Constant Field Values
  - PIN_DD_FLDS_CUST_FLDS_MAX_RANGE1
```
public static final int PIN_DD_FLDS_CUST_FLDS_MAX_RANGE1
```
    See Also:
    
    Constant Field Values
  - PIN_DD_FLDS_CUST_FLDS_MIN_RANGE2
```
public static final int PIN_DD_FLDS_CUST_FLDS_MIN_RANGE2
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Field
```
public Field(int nameID,
             int typeID,
             java.lang.String name)
```
    Constructs an instance of Field from a name ID , typeID and name .
    
    Parameters:
    
    nameID - A valid Portal field name.
    
    typeID - A valid Portal storable class type name.
    
    name - Name of the field.
  - Field
```
public Field(int nameID,
             int typeID)
```
    Constructs an instance of Field from a name ID and a type ID.
    
    Parameters:
    
    nameID - A valid Portal field name.
    
    typeID - A valid Portal storable class type name.
- Method Detail
  - fromPINName
```
public static Field fromPINName(java.lang.String name)
```
    Constructs and returns an instance of Field based on the name of the field as defined in the C header files.
    
    Parameters:
    
    name - The Field name string.
    
    Returns:
    
    A Field instance
  - fromName
```
public static Field fromName(java.lang.String origName)
```
    Constructs and returns an instance of Field based on the name of the field. If the name is in the form 'package.name', it is used literally. Otherwise, it is prepended by 'com.portal.pcm.fields.'. OrigName can be in the below formats
    1. com.portal.pcm.fields.< FieldName>
    2. PIN_FLD_XXX - OOB field with PIN_FLD_ prefix
    3. XXX_XXX - OOB field without PIN_FLD_ prefix
    4. PIN_FLD_XXX_XXX - custom field with PIN_FLD_ prefix
    5. XXX_XXX - custom field without PIN_FLD_ prefix
    6. FldPoid ,FldItems ,FldCustomerSegmentList,FldItemObj ..etc
    7. UnknownField123
    Parameters:
    
    origName - The Field name string
    
    Returns:
    
    A Field instance
  - fromName
```
public static Field fromName(int nameid)
```
    Constructs and returns an instance of Field based on the name ID with type of the field. If the ID doesn't match any known Fields, one will be constructed.
    
    Parameters:
    
    nameid - The name ID of the field with type, as in the C headers
    
    Returns:
    
    A Field instance
  - clone
```
public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
```
    Clones a field.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    Clone of field.
    
    Throws:
    
    java.lang.CloneNotSupportedException - thown if not supported.
  - getTypeID
```
public int getTypeID()
```
    Returns the type name.
    
    Returns:
    
    The type name ID. 0 if not known.
  - getNameID
```
public int getNameID()
```
    Returns the field name ID.
    
    Returns:
    
    The Field name ID without type information.
  - getName
```
public int getName()
```
    Returns the field name.
    
    Returns:
    
    The Field name with type information.
  - getNameString
```
public java.lang.String getNameString()
```
    Returns the string name of the field as it appears in the C header files (for example, 'PIN_FLD_POID').
    
    Returns:
    
    The field name string as it appears in C header files.
  - getNameString
```
public static java.lang.String getNameString(int nameID)
```
    Returns the string name of the field as it appears in the C header files (for example, 'PIN_FLD_POID').
    
    Returns:
    
    The field name string as it appears in C header files.
  - macroToClass
```
public static java.lang.String macroToClass(java.lang.String name)
```
    Converts a string field name from the PIN macro form to the Java class name form.
    
    Parameters:
    
    name - Field name in PIN macro form.
    
    Returns:
    
    A string containing the equivelant class name.
  - getPINType
```
public java.lang.String getPINType()
```
    Returns a string representing the PIN type name of this field.
    
    Returns:
    
    Type name in PIN format.
  - hashCode
```
public int hashCode()
```
    Returns a hash value for this object.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    A hash value, nominally the name ID.
  - equals
```
public boolean equals(java.lang.Object other)
```
    Determines if two fields are equal. This is true when their names match.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    other - The other field.
    
    Returns:
    
    true if the name ID of both fields is the same.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of field.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this field.

Class Field

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TYPE_UNUSED

TYPE_INT

TYPE_UINT

TYPE_ENUM

TYPE_NUM

TYPE_STR

TYPE_BUF

TYPE_POID

TYPE_TSTAMP

TYPE_ARRAY

TYPE_SUBSTRUCT

TYPE_OBJ

TYPE_BINSTR

TYPE_ERR

TYPE_DECIMAL

TYPE_TIME

TYPE_TEXTBUF

TYPE_INT64

OPFLG_CUST_FLDS_ONLY

PIN_DD_FLDS_CUST_FLDS_MIN_RANGE1

PIN_DD_FLDS_CUST_FLDS_MAX_RANGE1

PIN_DD_FLDS_CUST_FLDS_MIN_RANGE2

Constructor Detail

Field

Field

Method Detail

fromPINName

fromName

fromName

clone

getTypeID

getNameID

getName

getNameString

getNameString

macroToClass

getPINType

hashCode

equals

toString