All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class bea.jolt.pool.ServiceInfo

java.lang.Object
   |
   +----bea.jolt.pool.ServiceInfo

public class ServiceInfo
extends Object
This class provides the meta-information about a service and the parameters in the service. It can be used to generate HTML for a service with its input parameters.

Author:
Copyright (c) 1999 by BEA Systems, Inc. All Rights Reserved.

Constructor Index

 o ServiceInfo()

Method Index

 o getDataSet(SessionPool)
Gets an empty data set from the input parameters of this service.
 o getDefinition(SessionPool)
Gets the service definition from a repository.
 o getDisplayLength(String)
Gets the display length for the value of an attribute defined in the service definition.
 o getFieldName(String, int)
Maps a multi-occurrence attribute name from the BEA Jolt repository to a unique field name that can be used in a HTML Form.
 o getLabel(String, int)
Gets a presentable label for a multi-occurrence attribute.
 o getMaxCount(String)
Gets the maximum occurrence count for an attribute defined in the service definition.
 o getType(String)
Gets a data type presented in string for an attribute.
 o setName(String)
Sets the service name.

Constructors

 o ServiceInfo
 public ServiceInfo()

Methods

 o setName
 public void setName(String svcname)
Sets the service name.

Parameters:
svcname - The service name
 o getDataSet
 public DataSet getDataSet(SessionPool spool)
Gets an empty data set from the input parameters of this service.

Parameters:
spool - A session pool
Returns:
A web-server specific DataSet object
 o getDefinition
 public int getDefinition(SessionPool spool)
Gets the service definition from a repository.

Parameters:
spool - A session pool object
name - A sevice name
Returns:
0 if successful; -1 otherwise
 o getLabel
 public String getLabel(String name,
                        int index)
Gets a presentable label for a multi-occurrence attribute. The return string may look like name[0], but it is subject to change. This method is primarily for the generic HTML service.

Parameters:
name - The name of the attribute
index - An instance number
Returns:
name or the name with an index.
 o getFieldName
 public String getFieldName(String name,
                            int index)
Maps a multi-occurrence attribute name from the BEA Jolt repository to a unique field name that can be used in a HTML Form. The field name has a trailing "_" and an index number (for example, ACCOUNT_ID_2). This method is primarily used by the generic HTML service.

Parameters:
name - The name of the attribute
index - An instance number
Returns:
A unique field name
 o getMaxCount
 public int getMaxCount(String name)
Gets the maximum occurrence count for an attribute defined in the service definition. This method is primarily used by the generic HTML service.

Parameters:
name - The name of the attribute
Returns:
The maximum occurrence count
 o getDisplayLength
 public int getDisplayLength(String name)
Gets the display length for the value of an attribute defined in the service definition. If the data type of the attribute is string or CARRAY and the maximum length is undefined, the defaults are 32 and 80 respectively. This method is primarily used by the generic HTML service.

Parameters:
name - The name of the attribute
Returns:
The display field length
 o getType
 public String getType(String name)
Gets a data type presented in string for an attribute. The return value is subject to change. This method is primarily used by the generic HTML service.

Parameters:
name - The name of the attribute
Returns:
The data type string

All Packages  Class Hierarchy  This Package  Previous  Next  Index