com.ibm.edms.od

Class ODApplication

java.lang.Object

com.ibm.edms.od.ODApplication

All Implemented Interfaces:

java.io.Serializable

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

A class representing an OnDemand Application. An instance of the ODApplication object provides an application developer access to information specified for an OnDemand Application.

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

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() The description of the application.
char	getDocumentType() The document type stored in this application.
java.lang.String	getExtension() Get the File Extension as set for the specified OnDemand Application View Settings.
ODLogicalView	getLogicalView(java.lang.String lvname) Get the ODLogicalView object for the specified view.
java.util.Enumeration	getLogicalViewNames() Get the list of Logical View names that are defined to this Application.
java.lang.String	getName() The name of the application.

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.

Returns:

String The name of the application.

getDescription

public java.lang.String getDescription()

The description of the application.

Returns:

The description of the application.

getExtension

public java.lang.String getExtension()

Get the File Extension as set for the specified OnDemand Application View Settings. This is as specified in the OnDemand Administrator Application->View Information Tab.

NOTE:: Only DataType = UserDefined will have an Extension. All other DataTypes are viewed natively.

Returns:

String File Extension. If application is not specified Datatype = UserDefined, a null string is returned.

getDocumentType

public char getDocumentType()

The document type stored in this application.

Returns:

char value for document type

See Also:

ODConstant.FileTypeAFP, ODConstant.FileTypeBMP, ODConstant.FileTypeSCS_EXT, ODConstant.FileTypeDJDE, ODConstant.FileTypeEMAIL, ODConstant.FileTypeJFIF, ODConstant.FileTypeGIF, ODConstant.FileTypeLINE, ODConstant.FileTypeMETA, ODConstant.FileTypeNONE, ODConstant.FileTypePDF, ODConstant.FileTypePNG, ODConstant.FileTypeSCS, ODConstant.FileTypeUSRDEF, ODConstant.FileTypePCX, ODConstant.FileTypeXML

getLogicalViewNames

public java.util.Enumeration getLogicalViewNames()

Get the list of Logical View names that are defined to this Application.

Returns:

Enumeration of String objects containing the LogicalView Names.

See Also:

ODLogicalView

getLogicalView

public ODLogicalView getLogicalView(java.lang.String lvname)
                             throws java.lang.Exception

Get the ODLogicalView object for the specified view. The details stored in the ODLogicalView can then be used to setup the LineData or AFP report for viewing.

Parameters:

lvname - The LogicalView Name

Returns:

ODLogicalView

Throws:

java.lang.Exception

See Also:

ODLogicalView