Class PropertySet
This abstract class represents an object with a type and properties.
public class PropertySet
extends DBItem
Hierarchical Diagram
Direct Known Subclasses
• Artifact
For more information on this subclass, refer to Class Artifact.
• Sheet
• CCItem
• For more information on this subclass, refer to Class CCItem.
Constructor
public PropertySet()
Methods
• getType
Returns the full type path of this PropertySet.
public String getType()
Throws: RSDException
• getIntegerProperty
Returns the value of the named property on this PropertySet. Throws an exception if the value of the specified property is not an integer.
public int getIntegerProperty(String name, int defaultValue)
Where:
name—The name of the property.
defaultValue—The default value to return if this PropertySet does not have the specified property.
Throws: RSDException
• getRealProperty
Returns the value of the named property on this PropertySet. Throws an exception if the value of the specified property is not a real value.
public double getRealProperty(String name, double defaultValue)
Where:
name—The name of the property.
defaultValue—The default value to return if this PropertySet does not have the specified property.
Throws: RSDException
• getStringProperty
Returns the value of the named property on this PropertySet. Throws an exception if the value of the specified property is not a string.
public String getStringProperty(String name, String defaultValue)
Where:
name—The name of the property.
defaultValue—The default value to return if this PropertySet does not have the specified property.
Throws: RSDException
• getProperty
Return the value of the named property on this PropertySet.
Value | Return Value |
Integer | java.lang.Integer object |
Real | java.lang.Real object |
string | java.lang.String object |
null (unset) | null |
public Object getProperty(String name, Object defaultValue)
Where:
name—The name of the property.
defaultValue—The default value to return if this PropertySet does not have the specified property.
Throws: RSDException
• getPropertiesNames
Returns a set of string objects each with a property name of this PropertySet.
public java.util.Set getPropertiesNames (java.lang.String[] exclusions)
Where:
exclusions—An array of strings that are the names of properties not to be included in the returned Set.
Throws: RSDException
• setProperty
Sets a parameter value and returns the value when the action succeeds. When the parameter name does not exist in the propertySet, it is added.
public Object setProperty (String parmName, Object parmValue)
Where:
parmName—The name of the parameter to set.
parmValue—The value to set on the parameter.
Throws: RSDException
• deleteProperty
Deletes the named property from this propertySet. You cannot delete a property that was applied from a dataset.
public Object deleteProperty(String name)
Where:
name—The name of the property to delete.
Throws: RSDException
Methods Inherited
The methods inherited from other classes are:
Class | Methods Inherited |
java.lang.Object | equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
