com.ibm.edms.od

Class ODHitProperties

java.lang.Object

com.ibm.edms.od.ODHitProperties

All Implemented Interfaces:

java.io.Serializable

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

A class containing the properties for an OnDemand hit. This class is to be used to obtain the OnDemand internal property values for a hit.

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

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
long	getAGId() Return the application group identifier for this hit.
long	getAId() Return the application identifier for this hit.
java.lang.String	getApplicationGroupName() Return the application group name for this hit.
java.lang.String	getApplicationName() Return the application name for this hit.
long	getCompLength() Return the compressed document length.
long	getCompOffset() Return the compressed document offset within the compressed object.
java.lang.String	getEndDate() Return the load end date for this hit.
java.lang.String	getInternalDocName() Return the internal document name associated with this hit.
long	getLength() Return the document length.
java.lang.String	getLoadName() Return the load name for this hit.
long	getOffset() Return the documents offset within the storage object.
short	getPrimaryNodeId() Deprecated. Use ODHitProperties.getPriNodeId(). Deprecated v9.5.
long	getPriNodeId() Return the primary node identifier for this hit.
long	getRId() Return the resource identifier for this hit.
long	getSecNodeId() Return the secondary node identifier for this hit.
short	getSecondaryNodeId() Deprecated. Use ODHitProperties.getSecNodeId(). Deprecated v9.5.
java.lang.String	getStartDate() Return the load start date for this hit.
java.lang.String	getTableName() Return the document table name associated with this hit.

Methods inherited from class java.lang.Object

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

Method Detail

getInternalDocName

public java.lang.String getInternalDocName()

Return the internal document name associated with this hit.
This is the OnDemand internal document name and should not be used for end user display.

Returns:

String.

getTableName

public java.lang.String getTableName()

Return the document table name associated with this hit.

Returns:

String.

getOffset

public long getOffset()

Return the documents offset within the storage object.

Returns:

long.

getLength

public long getLength()

Return the document length. NOTE: The ODHitProperties.getLength() API returns the size of the document data without AFP resources. For data loaded into your OnDemand server as large object, the ODHitProperties.getLength() API will only return the large object header length. Alternatives include specifying an application group field with Document Size enabled, then calling ODHit.getDocumentSize(), or using the ODHit.isLargeObject(), ODHitgetNumSegments(), and ODHitgetNumPagesInSegment ()APIs to estimate the size of large object documents.

Returns:

long.

getCompOffset

public long getCompOffset()

Return the compressed document offset within the compressed object.

Returns:

long.

getCompLength

public long getCompLength()

Return the compressed document length.

Returns:

long.

getAGId

public long getAGId()

Return the application group identifier for this hit.

Returns:

long.

getAId

public long getAId()

Return the application identifier for this hit.

Returns:

long.

getRId

public long getRId()

Return the resource identifier for this hit.

Returns:

long.

getApplicationGroupName

public java.lang.String getApplicationGroupName()

Return the application group name for this hit.

Returns:

String.

getApplicationName

public java.lang.String getApplicationName()

Return the application name for this hit.

Returns:

String.

getPrimaryNodeId

public short getPrimaryNodeId()

Deprecated. Use ODHitProperties.getPriNodeId(). Deprecated v9.5.

Return the primary node identifier for this hit.

Returns:

short.

getSecondaryNodeId

public short getSecondaryNodeId()

Deprecated. Use ODHitProperties.getSecNodeId(). Deprecated v9.5.

Return the secondary node identifier for this hit.

Returns:

short.

getPriNodeId

public long getPriNodeId()

Return the primary node identifier for this hit.

Returns:

long.

getSecNodeId

public long getSecNodeId()

Return the secondary node identifier for this hit.

Returns:

long.

getLoadName

public java.lang.String getLoadName()

Return the load name for this hit.

Returns:

String.

getStartDate

public java.lang.String getStartDate()

Return the load start date for this hit. The date will always come back in the format mm-dd-yyyy.

Returns:

String.

getEndDate

public java.lang.String getEndDate()

Return the load end date for this hit. The date will always come back in the format mm-dd-yyyy.

Returns:

String.