BBjAdminPropertyReader

All Superinterfaces:

java.rmi.Remote

All Known Subinterfaces:

BBjAdminAppDeploymentApplication, BBjAdminAppDeploymentConfiguration, BBjAdminAppDeploymentDemo, BBjAdminAppDeploymentResource, BBjAdminAsynchTriggerJob, BBjAdminAsynchTriggerTarget, BBjAdminAuditDB, BBjAdminAuditReplicationJob, BBjAdminAuditReplicationTarget, BBjAdminAutorun, BBjAdminAutorunProgram, BBjAdminBase, BBjAdminBBjColumn, BBjAdminBBjFile, BBjAdminBBjFile_1412, BBjAdminBBjIndex, BBjAdminBBjIndexSegment, BBjAdminBBjProcedure, BBjAdminBBjProcess, BBjAdminBBjProcessStackElement, BBjAdminBBjReplicationJob, BBjAdminBBjReplicationJob_1310, BBjAdminBBjReplicationTarget, BBjAdminBBjTable, BBjAdminBBjTask, BBjAdminBBjTypeDef, BBjAdminBuiApplication, BBjAdminBuiConfiguration, BBjAdminBuiDemo, BBjAdminBuiResource, BBjAdminColumn, BBjAdminCommitPropertyWriter, BBjAdminConfiguration, BBjAdminConnectionPool, BBjAdminContextInfo, BBjAdminCrossReference, BBjAdminDatabase, BBjAdminDatabase.DateHandler, BBjAdminDatabaseConnection, BBjAdminDatabaseStatement, BBjAdminDictionaryMigrationInfo, BBjAdminDirectoryFilter, BBjAdminDocumentIndex, BBjAdminDocumentLocation, BBjAdminElasticsearchDocumentIndex, BBjAdminEmailMessage, BBjAdminEmailService, BBjAdminESQLColumn, BBjAdminESQLIndex, BBjAdminESQLIndexSegment, BBjAdminESQLTable, BBjAdminFile, BBjAdminFilesystemServer, BBjAdminGlobFilter, BBjAdminIndex, BBjAdminIndexBuilderJob, BBjAdminIndexSegment, BBjAdminJnlpApplication, BBjAdminJnlpApplication_1411, BBjAdminJnlpApplicationDesc, BBjAdminJnlpConfiguration, BBjAdminJnlpDemo, BBjAdminJnlpInfoSection, BBjAdminJnlpPlatformResourceSection, BBjAdminJnlpResourceJar, BBjAdminJnlpResourceLibrary, BBjAdminJnlpResourceNativeLib, BBjAdminJnlpResourceProperty, BBjAdminJnlpResourcesSection, BBjAdminJSON, BBjAdminLDAPSearch, BBjAdminLegacyColumn, BBjAdminLegacyIndex, BBjAdminLegacyIndexSegment, BBjAdminLegacyProcedure, BBjAdminLegacyTable, BBjAdminLegacyTypeDef, BBjAdminLegacyView, BBjAdminLuceneDocumentIndex, BBjAdminMetadataDefinition, BBjAdminOnlineCopyJob, BBjAdminOnlineCopyJobConfig, BBjAdminOnlineCopyJobFieldMap, BBjAdminOnlineCopyJobFieldMapConfig, BBjAdminOnlineCopyJobFile, BBjAdminOnlineCopyJobFileConfig, BBjAdminOnlineCopyJobFileRun, BBjAdminOnlineCopyJobRun, BBjAdminOpenFile, BBjAdminPauseTask, BBjAdminPrivilege, BBjAdminProcedure, BBjAdminProcedureParameter, BBjAdminProperty, BBjAdminPropertyWriter, BBjAdminQueryAnalysis, BBjAdminRegexFilter, BBjAdminReplicationBBjTask, BBjAdminReplicationFileStats, BBjAdminReplicationFilter, BBjAdminReplicationJob, BBjAdminReplicationPauseTask, BBjAdminReplicationResumeTask, BBjAdminReplicationSCALLTask, BBjAdminReplicationStartProcess, BBjAdminReplicationTarget, BBjAdminReplicationTarget_1311, BBjAdminReplicationTask, BBjAdminReplicationTaskGroup, BBjAdminResourceUrl, BBjAdminResumeTask, BBjAdminSCALLTask, BBjAdminSecurityGroup, BBjAdminSequence, BBjAdminServer, BBjAdminServletConfiguration, BBjAdminSQLConnection, BBjAdminSQLReplicationJob, BBjAdminSSLInfo, BBjAdminSystemPermission, BBjAdminTable, BBjAdminTableAnalysisJob, BBjAdminTask, BBjAdminTaskGroup, BBjAdminTaskQueue, BBjAdminTriggers, BBjAdminTypeDef, BBjAdminUserPermissions, BBjAdminView, BBjAdminWebApplication, BBjAdminWebAppServer, BBjAdminWebAppServer_1500, BBjAdminWebAppServer_1700, BBjAdminWebService, BBjAdminWebService_1311, BBjAdminWebServiceMethod

All Known Implementing Classes:

BBjAdminClientBBjTask, BBjAdminClientPauseTask, BBjAdminClientResumeTask, BBjAdminClientSCALLTask, BBjAdminClientTaskGroup
```
public interface BBjAdminPropertyReader
extends java.rmi.Remote
```
An interface for classes that need to read properties.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`checkValueEqual(java.lang.String p_property, java.lang.Object p_value)` Is the provided value equal to the current value (if any)?
`boolean`	`contains(java.util.Set<java.lang.String> p_properties)` Do any of a set of properties exist?
`boolean`	`contains(java.lang.String p_property)` Does a given property exist?
`boolean`	`getBoolean(java.lang.String p_property)` Get a boolean value for a property.
`double`	`getDouble(java.lang.String p_property)` Get a double value for a property.
`int`	`getInt(java.lang.String p_property)` Get an integer value for a property.
`BBjAdminList`	`getList(java.lang.String p_property)` Get a BBjAdminList value for a property.
`long`	`getLong(java.lang.String p_property)` Get a long value for a property.
`java.util.Map<java.lang.String,java.lang.Object>`	`getProperties()` Get a copy of all properties.
`java.lang.String`	`getString(java.lang.String p_property)` Get a String value for a property.
`BBjAdminType`	`getType(java.lang.String p_property)` Get the value type of a property.
`java.util.Map<java.lang.String,BBjAdminType>`	`getTypes()` Get a copy of all of the type information.
`java.lang.Object`	`getValue(java.lang.String p_property)` Get a object value for a property.

- Method Detail
  - getProperties
```
java.util.Map<java.lang.String,java.lang.Object> getProperties()
                                                        throws BBjAdminException
```
    Get a copy of all properties.
    
    Throws:
    
    BBjAdminException - TODO
  - getTypes
```
java.util.Map<java.lang.String,BBjAdminType> getTypes()
                                               throws BBjAdminException
```
    Get a copy of all of the type information.
    
    Throws:
    
    BBjAdminException - TODO
  - contains
```
boolean contains(java.lang.String p_property)
          throws BBjAdminException
```
    Does a given property exist?
    
    Parameters:
    
    p_property -
    
    Throws:
    
    BBjAdminException - TODO
  - contains
```
boolean contains(java.util.Set<java.lang.String> p_properties)
          throws BBjAdminException
```
    Do any of a set of properties exist?
    
    Parameters:
    
    p_properties -
    
    Throws:
    
    BBjAdminException - TODO
  - getString
```
java.lang.String getString(java.lang.String p_property)
                    throws BBjAdminException
```
    Get a String value for a property.
    
    Parameters:
    
    p_property - Property name.
    
    Returns:
    
    String value for a property, all property values can be retrieved as Strings.
    
    Throws:
    
    BBjAdminException
  - getList
```
BBjAdminList getList(java.lang.String p_property)
              throws BBjAdminException
```
    Get a BBjAdminList value for a property.
    
    Parameters:
    
    p_property - Property name.
    
    Returns:
    
    BBjAdminList value for a property.
    
    Throws:
    
    BBjAdminException
  - getInt
```
int getInt(java.lang.String p_property)
    throws BBjAdminException
```
    Get an integer value for a property.
    
    Parameters:
    
    p_property - Property name.
    
    Returns:
    
    Integer value for a property, some properties do not have an integer value.
    
    Throws:
    
    BBjAdminException
  - getLong
```
long getLong(java.lang.String p_property)
      throws BBjAdminException
```
    Get a long value for a property.
    
    Parameters:
    
    p_property - Property name.
    
    Returns:
    
    Long value for a property, some properties do not have an long value.
    
    Throws:
    
    BBjAdminException
  - getBoolean
```
boolean getBoolean(java.lang.String p_property)
            throws BBjAdminException
```
    Get a boolean value for a property.
    
    Parameters:
    
    p_property - Property name.
    
    Returns:
    
    Boolean value for a property, some properties do not have an boolean value.
    
    Throws:
    
    BBjAdminException
  - getDouble
```
double getDouble(java.lang.String p_property)
          throws BBjAdminException
```
    Get a double value for a property.
    
    Parameters:
    
    p_property - Property name.
    
    Returns:
    
    Double value for a property, some properties do not have a double value.
    
    Throws:
    
    BBjAdminException
  - getValue
```
java.lang.Object getValue(java.lang.String p_property)
                   throws BBjAdminException
```
    Get a object value for a property.
    
    Parameters:
    
    p_property - Property name.
    
    Returns:
    
    Boolean value for a property, some properties do not have an boolean value.
    
    Throws:
    
    BBjAdminException
  - getType
```
BBjAdminType getType(java.lang.String p_property)
              throws BBjAdminException
```
    Get the value type of a property. The value type can be unknown.
    
    Parameters:
    
    p_property -
    
    Throws:
    
    BBjAdminException - TODO
  - checkValueEqual
```
boolean checkValueEqual(java.lang.String p_property,
                        java.lang.Object p_value)
                 throws BBjAdminException
```
    Is the provided value equal to the current value (if any)?
    
    Parameters:
    
    p_property -
    
    p_value -
    
    Throws:
    
    BBjAdminException - TODO

Interface BBjAdminPropertyReader

Method Summary

Method Detail

getProperties

getTypes

contains

contains

getString

getList

getInt

getLong

getBoolean

getDouble

getValue

getType

checkValueEqual