com.ibm.edms.od

Class ODApplicationGroup

java.lang.Object

com.ibm.edms.od.ODApplicationGroup

All Implemented Interfaces:

java.io.Serializable

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

A class representing an OnDemand Application Group. An instance of the ODApplicationGroup object provides an application developer access to information specified for an OnDemand Application Group.
An instance of the ODApplictionGroup object is generated via an instance of the ODServer object using the getApplicationGroup() method.

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

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
ODApplication	getApplication(java.lang.String name) Get an ODApplication object that is associated with this Application Group.
long	getApplicationGroupExpireDays() Get the Life of Data and Indexes Expire setting.
java.lang.String[]	getApplicationNames() Get the OnDemand applications associated with this application group.
java.lang.String	getDescription() The description of the application group.
short	getDocPerms() Get the Doc Permissions.
ODApplicationGroupField	getField(java.lang.String name) Get the ODApplicationGroupField object.
java.util.Enumeration	getFields() Get the Application Group Fields
long	getId() The application group identifier is an internal numeric representation of this ODApplicationGroup.
int	getIdPerms() Get the ID Permissions.
java.lang.String[]	getLoadFieldNames() Used with the ODServer loading capabilities
java.util.Enumeration	getLoadFields() Used with the ODServer loading capabilities
java.lang.String	getName() The name of the application group.
boolean	hasPageCountField() Used with the ODServer loading capabilities
boolean	isCFSODEnabled() Returns whether or not this application group has been enabled for CFSOD support.
boolean	isHoldEnabled() Returns whether or not this application group has been enabled for Enhanced Retention Management (Hold).
boolean	isRMEnabled() Returns whether or not this application group has been Records Manager enabled.

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.

Returns:

String The name of the application group.

getDescription

public java.lang.String getDescription()

The description of the application group.

Returns:

The description of the application group.

getApplicationNames

public java.lang.String[] getApplicationNames()

Get the OnDemand applications associated with this application group.

Returns:

String[] The names of the applications associated with this application group.

getId

public long getId()

The application group identifier is an internal numeric representation of this ODApplicationGroup.

Returns:

long The application group identifier.

isRMEnabled

public boolean isRMEnabled()

Returns whether or not this application group has been Records Manager enabled.

Returns:

boolean Is this application group records manager enabled.

isHoldEnabled

public boolean isHoldEnabled()

Returns whether or not this application group has been enabled for Enhanced Retention Management (Hold).

Returns:

boolean Is this application group Hold enabled.

isCFSODEnabled

public boolean isCFSODEnabled()

Returns whether or not this application group has been enabled for CFSOD support.

Returns:

boolean Is this application group CFSOD enabled.

getField

public ODApplicationGroupField getField(java.lang.String name)

Get the ODApplicationGroupField object.

Parameters:

name - The name of the Application Group field

Returns:

ODApplicationGroup

getFields

public java.util.Enumeration getFields()

Get the Application Group Fields

Returns:

Enumeration of ODApplicationGroupField objects.

getIdPerms

public int getIdPerms()

Get the ID Permissions. Use this mask value to determine the current user's Application Group ID permissions.
For Example:

      System.out.println("Has Permissions to access logical views " +
      ((odApplGrp.getDocPerms() & ODConstant.OD_APPLGRP_ID_LOGICAL_VIEW)!= 0 ? true : false));
 

See Also:

ODConstant.OD_APPLGRP_ID_ACCESS, ODConstant.OD_APPLGRP_ID_ADMIN, ODConstant.OD_APPLGRP_ID_LOGICAL_VIEW

getDocPerms

public short getDocPerms()

Get the Doc Permissions. Use this mask value to determine the current user's Application Group permissions for Documents.
For Example:

      System.out.println("Has Permissions to add documents " +
      ((odApplGrp.getDocPerms() & ODConstant.OD_PERM_ADD)!= 0 ? true : false));
 

See Also:

ODConstant.OD_PERM_VIEW, ODConstant.OD_PERM_ADD, ODConstant.OD_PERM_DELETE, ODConstant.OD_PERM_UPDATE, ODConstant.OD_PERM_PRINT, ODConstant.OD_PERM_FAX, ODConstant.OD_PERM_CUT

getApplication

public ODApplication getApplication(java.lang.String name)
                             throws ODException

Get an ODApplication object that is associated with this Application Group.

Parameters:

name - The Application Name string that you want to get.

Returns:

ODApplication object representing an OnDemand application.

Throws:

ODException

See Also:

ODApplication

getApplicationGroupExpireDays

public long getApplicationGroupExpireDays()
                                   throws ODException

Get the Life of Data and Indexes Expire setting.

Returns:

Number of Days

Throws:

ODException

getLoadFields

public java.util.Enumeration getLoadFields()

Used with the ODServer loading capabilities

Returns:

Enumeration of ODApplicationGroupField objects used to add documents using the ODWEK load capabilities

See Also:

ODServer.loadAddDoc(int, Hashtable, java.io.File), ODApplicationGroupField.isLoadField()

getLoadFieldNames

public java.lang.String[] getLoadFieldNames()

Used with the ODServer loading capabilities

Returns:

String[] of the names of the fields used to add documents using the ODWEK load capabilities

See Also:

ODServer.loadAddDoc(int, Hashtable, java.io.File), ODApplicationGroupField.isLoadField()

hasPageCountField

public boolean hasPageCountField()

Used with the ODServer loading capabilities

Returns:

boolean whether an Application Group has an Application Group field defined to contain the page count

See Also:

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