Package com.basis.api.admin

Interface BBjAdminPropertyWriter

All Superinterfaces:

BBjAdminPropertyReader, Remote

All Known Subinterfaces:

BBjAdminAppDeploymentApplication, BBjAdminAppDeploymentConfiguration, BBjAdminAppDeploymentDemo, BBjAdminAppDeploymentResource, BBjAdminAsynchTriggerJob, BBjAdminAsynchTriggerTarget, BBjAdminAuditReplicationJob, BBjAdminAuditReplicationTarget, BBjAdminAutorun, BBjAdminAutorunProgram, BBjAdminBase, BBjAdminBBjColumn, BBjAdminBBjFile, BBjAdminBBjFile_1412, BBjAdminBBjIndex, BBjAdminBBjIndexSegment, BBjAdminBBjProcedure, BBjAdminBBjReplicationJob, BBjAdminBBjReplicationJob_1310, BBjAdminBBjReplicationTarget, BBjAdminBBjTable, BBjAdminBBjTask, BBjAdminBBjTypeDef, BBjAdminBuiApplication, BBjAdminBuiConfiguration, BBjAdminBuiDemo, BBjAdminBuiResource, BBjAdminColumn, BBjAdminCommitPropertyWriter, BBjAdminConfiguration, BBjAdminConnectionPool, BBjAdminContextInfo, BBjAdminCrossReference, BBjAdminDatabase, BBjAdminDatabase.DateHandler, BBjAdminDictionaryMigrationInfo, BBjAdminDirectoryFilter, BBjAdminDocumentIndex, BBjAdminDocumentLocation, BBjAdminElasticsearchDocumentIndex, BBjAdminEmailMessage, BBjAdminEmailService, BBjAdminESQLColumn, BBjAdminESQLIndex, BBjAdminESQLIndexSegment, BBjAdminESQLTable, BBjAdminFile, BBjAdminFilesystemServer, BBjAdminFulltextIndexValidationTask, 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, BBjAdminOnlineCopyJobConfig, BBjAdminOnlineCopyJobFieldMapConfig, BBjAdminOnlineCopyJobFileConfig, BBjAdminPauseTask, BBjAdminPrivilege, BBjAdminProcedure, BBjAdminProcedureParameter, BBjAdminProperty, BBjAdminRegexFilter, BBjAdminReplicationBBjTask, BBjAdminReplicationFilter, BBjAdminReplicationJob, BBjAdminReplicationPauseTask, BBjAdminReplicationResumeTask, BBjAdminReplicationSCALLTask, BBjAdminReplicationStartProcess, BBjAdminReplicationTarget, BBjAdminReplicationTarget_1311, BBjAdminReplicationTask, BBjAdminReplicationTaskGroup, BBjAdminResourceUrl, BBjAdminResumeTask, BBjAdminSCALLTask, BBjAdminSecurityGroup, BBjAdminSequence, BBjAdminServer, BBjAdminServletConfiguration, 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, BBjAdminRemoteWrapper, BBjAdminSimpleCommitPropWriter, BBjAdminSimpleDatabase, BBjAdminSimpleDatabase.BBjAdminSimpleDateHandler, BBjAdminSimplePropWriter, BBjAdminWebServiceMethodParameter

public interface BBjAdminPropertyWriter
extends BBjAdminPropertyReader

An interface for classes that need to write properties.

Method Summary

Modifier and Type	Method	Description
void	addType(String p_property, BBjAdminType p_type)	Adds a type for the specified property if this object was created with the ability to add new properties.
boolean	canAddNewProperties()	Is the user allowed to add new properties?
boolean	canClear()	Is the user allowed to clear properties?
void	clear()	Clear all properties that are not read only.
boolean	clearProperties(Set<String> p_properties)	Clear a set of properties.
boolean	clearProperty(String p_property)	Clear out the value of a property.
Set<String>	getReadOnly()	Set the complete set of read-only properties.
boolean	hasChanged()	Have properties been changed?
boolean	isReadOnly(String p_property)	Is a given property read-only.
void	setBoolean(String p_property, boolean p_value)	Set the boolean value of a property.
void	setDouble(String p_property, double p_value)	Set the double value of a property.
void	setInt(String p_property, int p_value)	Set the integer value of a property.
void	setList(String p_property, BBjAdminList p_value)	Set the BBjAdminList value of a property.
void	setLong(String p_property, long p_value)	Set the long value of a property.
void	setProperties(Map<String,Object> p_properties)	Set properties as a group from a Map.
void	setString(String p_property, String p_value)	Set the String value of a property.
void	setValue(String p_property, Object p_value)	Set the object value of a property.

Methods inherited from interface com.basis.api.admin.BBjAdminPropertyReader

checkValueEqual, contains, contains, getBoolean, getDouble, getInt, getList, getLong, getProperties, getString, getType, getTypes, getValue

Method Details

canClear

boolean canClear()
          throws BBjAdminException

Is the user allowed to clear properties?

Throws:

BBjAdminException - TODO

canAddNewProperties

boolean canAddNewProperties()
                     throws BBjAdminException

Is the user allowed to add new properties?

Throws:

BBjAdminException - TODO

hasChanged

boolean hasChanged()
            throws BBjAdminException

Have properties been changed?

Throws:

BBjAdminException - TODO

clear

void clear()
    throws BBjAdminException

Clear all properties that are not read only.

Throws:

BBjAdminException

setProperties

void setProperties(Map<String,Object> p_properties)
            throws BBjAdminException

Set properties as a group from a Map.

Parameters:

p_properties - Properties to set.

Throws:

BBjAdminException

clearProperties

boolean clearProperties(Set<String> p_properties)
                 throws BBjAdminException

Clear a set of properties.

Parameters:

p_properties - Property names.

Returns:

Whether any of the properties has a non-null value.

Throws:

BBjAdminException

clearProperty

boolean clearProperty(String p_property)
               throws BBjAdminException

Clear out the value of a property.

Parameters:

p_property - Property name.

Returns:

Whether the property existed.

Throws:

BBjAdminException

setString

void setString(String p_property,
 String p_value)
        throws BBjAdminException

Set the String value of a property. This can fail if the property needs a specific type of value or is read-only.

Parameters:

p_property - Property name.

p_value - New value for the property.

Throws:

BBjAdminException

setList

void setList(String p_property,
 BBjAdminList p_value)
      throws BBjAdminException

Set the BBjAdminList value of a property. This can fail if the property is read-only.

Parameters:

p_property - Property name.

p_value - New value for the property.

Throws:

BBjAdminException

setInt

void setInt(String p_property,
 int p_value)
     throws BBjAdminException

Set the integer value of a property. This can fail if the property needs a specific type of value or is read-only.

Parameters:

p_property - Property name.

p_value - New value for the property.

Throws:

BBjAdminException

setLong

void setLong(String p_property,
 long p_value)
      throws BBjAdminException

Set the long value of a property. This can fail if the property needs a specific type of value or is read-only.

Parameters:

p_property - Property name.

p_value - New value for the property.

Throws:

BBjAdminException

setBoolean

void setBoolean(String p_property,
 boolean p_value)
         throws BBjAdminException

Set the boolean value of a property. This can fail if the property needs a specific type of value or is read-only.

Parameters:

p_property - Property name.

p_value - New value for the property.

Throws:

BBjAdminException

setDouble

void setDouble(String p_property,
 double p_value)
        throws BBjAdminException

Set the double value of a property. This can fail if the property needs a specific type of value or is read-only.

Parameters:

p_property - Property name.

p_value - New value for the property.

Throws:

BBjAdminException

setValue

void setValue(String p_property,
 Object p_value)
       throws BBjAdminException

Set the object value of a property. This can fail if the property needs a specific type of value or is read-only.

Parameters:

p_property - Property name.

p_value - New value for the property.

Throws:

BBjAdminException

addType

void addType(String p_property,
 BBjAdminType p_type)
      throws BBjAdminException

Adds a type for the specified property if this object was created with the ability to add new properties.

Parameters:

p_property -

p_type -

Throws:

BBjAdminException

isReadOnly

boolean isReadOnly(String p_property)
            throws BBjAdminException

Is a given property read-only. By default they are _not_ read only.

Parameters:

p_property - Property name.

Throws:

BBjAdminException - TODO

getReadOnly

Set<String> getReadOnly()
                 throws BBjAdminException

Set the complete set of read-only properties.

Throws:

BBjAdminException - TODO