com.ibm.edms.od

Class ODApplicationGroupField

java.lang.Object

com.ibm.edms.od.ODApplicationGroupField

All Implemented Interfaces:

java.io.Serializable

public class ODApplicationGroupField
extends java.lang.Object
implements java.io.Serializable

A class representing an OnDemand Application Group Field. It contains application group field information. WARNING: It is required that access to all ODWEK objects only be done in a single threaded environment.

(c) Copyright IBM Corp. 1993, 2015. All Rights Reserved

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
long	getFieldMask() The application group field mask.
short	getMask() Deprecated. see #getFieldMask New mask types added in 8.4.1.0 will not be available with this API.
java.lang.String	getName() The name of the application group field.
byte	getQual() The application group field qualifier.
byte	getType() The application group field type.
boolean	isLoadField() Check if a value required for this field when loading a new document using the ODWEK load APIs.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getName

public java.lang.String getName()

The name of the application group field.

Returns:

String The name of the application group field.

getMask

public short getMask()

Deprecated. see #getFieldMask New mask types added in 8.4.1.0 will not be available with this API.

The application group field mask.

Returns:

short The application group field mask.

See Also:

ODConstant

getFieldMask

public long getFieldMask()

The application group field mask.

Returns:

long The application group field mask.

See Also:

ODConstant

getType

public byte getType()

The application group field type.

Returns:

byte The application group field type.

getQual

public byte getQual()

The application group field qualifier.

Returns:

byte The application group field type.

isLoadField

public boolean isLoadField()

Check if a value required for this field when loading a new document using the ODWEK load APIs. For some field types, either the hit value is generated at load time automatically by the server, or the hit value is generated when an action is performed and therefore no value need be supplied.

Returns:

boolean

See Also:

ODServer.loadAddDoc(int, java.util.Hashtable, java.io.File)