Package com.basis.api.admin.internal

Class BBjAdminSimpleCommitPropWriter

java.lang.Object

com.basis.api.admin.internal.BBjAdminSimpleCommitPropWriter

All Implemented Interfaces:

BBjAdminCommitPropertyWriter, BBjAdminCommitWriter, BBjAdminPropertyReader, BBjAdminPropertyWriter, Remote

Direct Known Subclasses:

BBjAdminSimpleDatabase

public class BBjAdminSimpleCommitPropWriter
extends Object
implements BBjAdminCommitPropertyWriter

Constructor Summary

Constructors

Constructor	Description
BBjAdminSimpleCommitPropWriter(BBjAdminCommitPropertyWriter p_commit)
BBjAdminSimpleCommitPropWriter(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?
protected boolean	checkPermission(boolean p_write)
boolean	checkValueEqual(String p_property, Object p_value)	Is the provided value equal to the current value (if any)?
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.
void	commit()	Commit all property changes.
boolean	contains(String p_property)	Does a given property exist?
boolean	contains(Set<String> p_properties)	Do any of a set of properties exist?
boolean	getBoolean(String p_property)	Get a boolean value for a property.
Map<String,Object>	getChangedProperties()	Get the changed properties.
Set<String>	getClearedProperties()	Get the set of cleared properties.
double	getDouble(String p_property)	Get a double value for a property.
int	getInt(String p_property)	Get an integer value for a property.
BBjAdminList	getList(String p_property)	Get a BBjAdminList value for a property.
long	getLong(String p_property)	Get a long value for a property.
Map<String,Object>	getOriginalProperties()	Get the original properties list.
Map<String,Object>	getProperties()	Get a copy of all properties.
Set<String>	getReadOnly()	Set the complete set of read-only properties.
String	getString(String p_property)	Get a String value for a property.
BBjAdminType	getType(String p_property)	Get the value type of a property.
Map<String,BBjAdminType>	getTypes()	Get a copy of all of the type information.
Object	getValue(String p_property)	Get a object value for a property.
boolean	hasChanged()	Have properties been changed?
boolean	isReadOnly(String p_property)	Is a given property read-only.
void	refresh(Map<String,Object> p_properties)
void	rollback()	Roll back all property changes.
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 java.lang.Object

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

Constructor Details

BBjAdminSimpleCommitPropWriter

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

BBjAdminSimpleCommitPropWriter

public BBjAdminSimpleCommitPropWriter(BBjAdminCommitPropertyWriter p_commit)
                               throws BBjAdminException

Throws:

BBjAdminException

Method Details

refresh

public void refresh(Map<String,Object> p_properties)

commit

public void commit()
            throws BBjAdminException

Description copied from interface: BBjAdminCommitWriter

Commit all property changes.

Specified by:

commit in interface BBjAdminCommitWriter

Throws:

BBjAdminException

rollback

public void rollback()
              throws BBjAdminException

Description copied from interface: BBjAdminCommitWriter

Roll back all property changes. This will discard any changes that have been made in the properties and not committed.

Specified by:

rollback in interface BBjAdminCommitWriter

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

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

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

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

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

contains

public boolean contains(String p_property)
                 throws BBjAdminException

Description copied from interface: BBjAdminPropertyReader

Does a given property exist?

Specified by:

contains in interface BBjAdminPropertyReader

Throws:

BBjAdminException - TODO

contains

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

Description copied from interface: BBjAdminPropertyReader

Do any of a set of properties exist?

Specified by:

contains in interface BBjAdminPropertyReader

Throws:

BBjAdminException - TODO

getBoolean

public boolean getBoolean(String p_property)
                   throws BBjAdminException

Description copied from interface: BBjAdminPropertyReader

Get a boolean value for a property.

Specified by:

getBoolean in interface BBjAdminPropertyReader

Parameters:

p_property - Property name.

Returns:

Boolean value for a property, some properties do not have an boolean value.

Throws:

BBjAdminException

getDouble

public double getDouble(String p_property)
                 throws BBjAdminException

Description copied from interface: BBjAdminPropertyReader

Get a double value for a property.

Specified by:

getDouble in interface BBjAdminPropertyReader

Parameters:

p_property - Property name.

Returns:

Double value for a property, some properties do not have a double value.

Throws:

BBjAdminException

getInt

public int getInt(String p_property)
           throws BBjAdminException

Description copied from interface: BBjAdminPropertyReader

Get an integer value for a property.

Specified by:

getInt in interface BBjAdminPropertyReader

Parameters:

p_property - Property name.

Returns:

Integer value for a property, some properties do not have an integer value.

Throws:

BBjAdminException

getLong

public long getLong(String p_property)
             throws BBjAdminException

Description copied from interface: BBjAdminPropertyReader

Get a long value for a property.

Specified by:

getLong in interface BBjAdminPropertyReader

Parameters:

p_property - Property name.

Returns:

Long value for a property, some properties do not have an long value.

Throws:

BBjAdminException

getProperties

public Map<String,Object> getProperties()
                                 throws BBjAdminException

Description copied from interface: BBjAdminPropertyReader

Get a copy of all properties.

Specified by:

getProperties in interface BBjAdminPropertyReader

Throws:

BBjAdminException - TODO

getString

public String getString(String p_property)
                 throws BBjAdminException

Description copied from interface: BBjAdminPropertyReader

Get a String value for a property.

Specified by:

getString in interface BBjAdminPropertyReader

Parameters:

p_property - Property name.

Returns:

String value for a property, all property values can be retrieved as Strings.

Throws:

BBjAdminException

getList

public BBjAdminList getList(String p_property)
                     throws BBjAdminException

Description copied from interface: BBjAdminPropertyReader

Get a BBjAdminList value for a property.

Specified by:

getList in interface BBjAdminPropertyReader

Parameters:

p_property - Property name.

Returns:

BBjAdminList value for a property.

Throws:

BBjAdminException

getType

public BBjAdminType getType(String p_property)
                     throws BBjAdminException

Description copied from interface: BBjAdminPropertyReader

Get the value type of a property. The value type can be unknown.

Specified by:

getType in interface BBjAdminPropertyReader

Throws:

BBjAdminException - TODO

getTypes

public Map<String,BBjAdminType> getTypes()
                                  throws BBjAdminException

Description copied from interface: BBjAdminPropertyReader

Get a copy of all of the type information.

Specified by:

getTypes in interface BBjAdminPropertyReader

Throws:

BBjAdminException - TODO

getValue

public Object getValue(String p_property)
                throws BBjAdminException

Description copied from interface: BBjAdminPropertyReader

Get a object value for a property.

Specified by:

getValue in interface BBjAdminPropertyReader

Parameters:

p_property - Property name.

Returns:

Boolean value for a property, some properties do not have an boolean value.

Throws:

BBjAdminException

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

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

checkValueEqual

public boolean checkValueEqual(String p_property,
 Object p_value)
                        throws BBjAdminException

Description copied from interface: BBjAdminPropertyReader

Is the provided value equal to the current value (if any)?

Specified by:

checkValueEqual in interface BBjAdminPropertyReader

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

getClearedProperties

public Set<String> getClearedProperties()
                                 throws BBjAdminException

Description copied from interface: BBjAdminCommitPropertyWriter

Get the set of cleared properties.

Specified by:

getClearedProperties in interface BBjAdminCommitPropertyWriter

Throws:

BBjAdminException - TODO

getChangedProperties

public Map<String,Object> getChangedProperties()
                                        throws BBjAdminException

Description copied from interface: BBjAdminCommitPropertyWriter

Get the changed properties.

Specified by:

getChangedProperties in interface BBjAdminCommitPropertyWriter

Throws:

BBjAdminException - TODO

getOriginalProperties

public Map<String,Object> getOriginalProperties()
                                         throws BBjAdminException

Description copied from interface: BBjAdminCommitPropertyWriter

Get the original properties list.

Specified by:

getOriginalProperties in interface BBjAdminCommitPropertyWriter

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

checkPermission

protected boolean checkPermission(boolean p_write)