Package com.basis.api.admin.internal

Class BBjAdminSimplePropWriter

java.lang.Object

com.basis.api.admin.internal.BBjAdminSimplePropReader

com.basis.api.admin.internal.BBjAdminSimplePropWriter

All Implemented Interfaces:

BBjAdminPropertyReader, BBjAdminPropertyWriter, Serializable, Remote

Direct Known Subclasses:

BBjAdminClientBBjTask, BBjAdminClientPauseTask, BBjAdminClientResumeTask, BBjAdminClientSCALLTask, BBjAdminClientTaskGroup, BBjAdminSimpleDatabase.BBjAdminSimpleDateHandler, BBjAdminWebServiceMethodParameter

public class BBjAdminSimplePropWriter
extends BBjAdminSimplePropReader
implements BBjAdminPropertyWriter

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_hasChanged

Fields inherited from class com.basis.api.admin.internal.BBjAdminSimplePropReader

m_properties, m_types

Constructor Summary

Constructors

Constructor	Description
BBjAdminSimplePropWriter(BBjAdminPropertyWriter p_writer)
BBjAdminSimplePropWriter(Map<String,Object> p_properties, Map<String,BBjAdminType> p_types, Set<String> p_readOnly, boolean p_canClear, boolean p_canAddNewProperties)

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 class com.basis.api.admin.internal.BBjAdminSimplePropReader

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

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

Field Details

m_hasChanged

protected boolean m_hasChanged

Constructor Details

BBjAdminSimplePropWriter

public BBjAdminSimplePropWriter(Map<String,Object> p_properties,
 Map<String,BBjAdminType> p_types,
 Set<String> p_readOnly,
 boolean p_canClear,
 boolean p_canAddNewProperties)

BBjAdminSimplePropWriter

public BBjAdminSimplePropWriter(BBjAdminPropertyWriter p_writer)
                         throws BBjAdminException

Throws:

BBjAdminException

Method Details

clear

public void clear()
           throws BBjAdminException

Description copied from interface: BBjAdminPropertyWriter

Clear all properties that are not read only.

Specified by:

clear in interface BBjAdminPropertyWriter

Throws:

BBjAdminException

clearProperty

public boolean clearProperty(String p_property)
                      throws BBjAdminException

Description copied from interface: BBjAdminPropertyWriter

Clear out the value of a property.

Specified by:

clearProperty in interface BBjAdminPropertyWriter

Parameters:

p_property - Property name.

Returns:

Whether the property existed.

Throws:

BBjAdminException

isReadOnly

public boolean isReadOnly(String p_property)
                   throws BBjAdminException

Description copied from interface: BBjAdminPropertyWriter

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

Specified by:

isReadOnly in interface BBjAdminPropertyWriter

Parameters:

p_property - Property name.

Throws:

BBjAdminException - TODO

setBoolean

public void setBoolean(String p_property,
 boolean p_value)
                throws BBjAdminException

Description copied from interface: BBjAdminPropertyWriter

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

Specified by:

setBoolean in interface BBjAdminPropertyWriter

Parameters:

p_property - Property name.

p_value - New value for the property.

Throws:

BBjAdminException

setInt

public void setInt(String p_property,
 int p_value)
            throws BBjAdminException

Description copied from interface: BBjAdminPropertyWriter

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

Specified by:

setInt in interface BBjAdminPropertyWriter

Parameters:

p_property - Property name.

p_value - New value for the property.

Throws:

BBjAdminException

setLong

public void setLong(String p_property,
 long p_value)
             throws BBjAdminException

Description copied from interface: BBjAdminPropertyWriter

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

Specified by:

setLong in interface BBjAdminPropertyWriter

Parameters:

p_property - Property name.

p_value - New value for the property.

Throws:

BBjAdminException

setDouble

public void setDouble(String p_property,
 double p_value)
               throws BBjAdminException

Description copied from interface: BBjAdminPropertyWriter

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

Specified by:

setDouble in interface BBjAdminPropertyWriter

Parameters:

p_property - Property name.

p_value - New value for the property.

Throws:

BBjAdminException

setString

public void setString(String p_property,
 String p_value)
               throws BBjAdminException

Description copied from interface: BBjAdminPropertyWriter

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

Specified by:

setString in interface BBjAdminPropertyWriter

Parameters:

p_property - Property name.

p_value - New value for the property.

Throws:

BBjAdminException

setList

public void setList(String p_property,
 BBjAdminList p_value)
             throws BBjAdminException

Description copied from interface: BBjAdminPropertyWriter

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

Specified by:

setList in interface BBjAdminPropertyWriter

Parameters:

p_property - Property name.

p_value - New value for the property.

Throws:

BBjAdminException

setValue

public void setValue(String p_property,
 Object p_value)
              throws BBjAdminException

Description copied from interface: BBjAdminPropertyWriter

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

Specified by:

setValue in interface BBjAdminPropertyWriter

Parameters:

p_property - Property name.

p_value - New value for the property.

Throws:

BBjAdminException

setProperties

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

Description copied from interface: BBjAdminPropertyWriter

Set properties as a group from a Map.

Specified by:

setProperties in interface BBjAdminPropertyWriter

Parameters:

p_properties - Properties to set.

Throws:

BBjAdminException

clearProperties

public boolean clearProperties(Set<String> p_properties)
                        throws BBjAdminException

Description copied from interface: BBjAdminPropertyWriter

Clear a set of properties.

Specified by:

clearProperties in interface BBjAdminPropertyWriter

Parameters:

p_properties - Property names.

Returns:

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

Throws:

BBjAdminException

canAddNewProperties

public boolean canAddNewProperties()
                            throws BBjAdminException

Description copied from interface: BBjAdminPropertyWriter

Is the user allowed to add new properties?

Specified by:

canAddNewProperties in interface BBjAdminPropertyWriter

Throws:

BBjAdminException - TODO

canClear

public boolean canClear()
                 throws BBjAdminException

Description copied from interface: BBjAdminPropertyWriter

Is the user allowed to clear properties?

Specified by:

canClear in interface BBjAdminPropertyWriter

Throws:

BBjAdminException - TODO

hasChanged

public boolean hasChanged()
                   throws BBjAdminException

Description copied from interface: BBjAdminPropertyWriter

Have properties been changed?

Specified by:

hasChanged in interface BBjAdminPropertyWriter

Throws:

BBjAdminException - TODO

getReadOnly

public Set<String> getReadOnly()
                        throws BBjAdminException

Description copied from interface: BBjAdminPropertyWriter

Set the complete set of read-only properties.

Specified by:

getReadOnly in interface BBjAdminPropertyWriter

Throws:

BBjAdminException - TODO

addType

public void addType(String p_property,
 BBjAdminType p_type)
             throws BBjAdminException

Description copied from interface: BBjAdminPropertyWriter

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

Specified by:

addType in interface BBjAdminPropertyWriter

Throws:

BBjAdminException