com.ibm.edms.od

Class ODHold

java.lang.Object

com.ibm.edms.od.ODHold

All Implemented Interfaces:

java.io.Serializable

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

A class representing an OnDemand Hold Definition. This object is returned from a successful call to (ODServer.getHolds()).
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
java.lang.String	getBaseDescription() Get the base description of the hold.
java.lang.String	getBaseName() Get the base name of the hold.
java.lang.String	getDescription() Get the Description for the Hold.
java.lang.String	getName() Get the hold name.

Methods inherited from class java.lang.Object

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

Method Detail

getDescription

public java.lang.String getDescription()

Get the Description for the Hold. If no NLS strings are defined that match whichever locale the ODServer is running in, this method will return the description the Hold was created with. If a match is made, the description string that is mapped to that locale will be returned.

Returns:

String Cabinet Description.

getName

public java.lang.String getName()

Get the hold name. If no NLS strings are defined that match whichever locale the ODServer is running in, this method will return the name the Hold was created with. If a match is made, the name string that is mapped to that locale will be returned.

Returns:

String hold name

getBaseDescription

public java.lang.String getBaseDescription()

Get the base description of the hold.

Returns:

String The hold base description. This is the description the hold was first created with and your NLS setting does not effect the value returned.

getBaseName

public java.lang.String getBaseName()

Get the base name of the hold.

Returns:

String The hold base name. This is the name used to create the hold and your NLS setting does not effect the value returned.