Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Business Intelligence Publisher
11g Release 1 (11.1.1)

E22256-01


oracle.xdo.delivery
Class DeliveryComponent

java.lang.Object
  extended by oracle.xdo.delivery.DeliveryComponent

Direct Known Subclasses:
AbstractDeliveryRequest, DeliveryManager

public abstract class DeliveryComponent
extends java.lang.Object

Sole class for delivery components.


Field Summary
static java.lang.String RCS_ID
           

 

Constructor Summary
DeliveryComponent()
           
DeliveryComponent(java.util.Hashtable pProperties)
           

 

Method Summary
 void addProperties(java.util.Hashtable pProperties)
          Adds properties.
 void addProperties(java.util.Hashtable pProperties, boolean pOverride)
          Adds properties.
 void addProperty(java.lang.String pName, java.lang.Object pValue)
          Adds a property.
 boolean getBooleanProperty(java.lang.String pName)
          Returns boolean representation of the property value.
 boolean getBooleanProperty(java.lang.String pName, boolean pDefault)
          Returns boolean representation of the property value.
 int getIntegerProperty(java.lang.String pName)
          Returns int representation of the property value.
 int getIntegerProperty(java.lang.String pName, int pDefault)
          Returns int representation of the property value.
 java.util.Hashtable getProperties()
          Returns a list of properties defined in this object.
 java.lang.Object getProperty(java.lang.String pName)
          Returns a property value of the given property name.
 java.lang.String getStringProperty(java.lang.String pName)
          Returns the property value of the given property name in a string representation.
 void removeProperty(java.lang.String pName)
           
 void validateProperties()
          Validates properties.

 

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

RCS_ID

public static final java.lang.String RCS_ID
See Also:
Constant Field Values

Constructor Detail

DeliveryComponent

public DeliveryComponent()

DeliveryComponent

public DeliveryComponent(java.util.Hashtable pProperties)
Parameters:
pProperties -

Method Detail

addProperties

public void addProperties(java.util.Hashtable pProperties)
Adds properties. It copies all the properties defined in the parameter to the internal property list. It overrides the existing properties if duplicated.
Parameters:
pProperties -
See Also:
oracle.xdo.delivery.PropertyHandler#addProperties(java.util.Hashtable)

addProperties

public void addProperties(java.util.Hashtable pProperties,
                          boolean pOverride)
Adds properties. It copies all the properties defined in the parameter to the internal property list.
Parameters:
pProperties -
pOverride - override or not
See Also:
oracle.xdo.delivery.PropertyHandler#addProperties(java.util.Hashtable)

addProperty

public void addProperty(java.lang.String pName,
                        java.lang.Object pValue)
Adds a property.
Parameters:
pName - property name
pValue - property value
See Also:
oracle.xdo.delivery.PropertyHandler#addProperty(java.lang.String, java.lang.Object)

getProperty

public java.lang.Object getProperty(java.lang.String pName)
Returns a property value of the given property name.
Parameters:
pName - property name
Returns:
property value
See Also:
oracle.xdo.delivery.PropertyHandler#getProperty(java.lang.String)

getProperties

public java.util.Hashtable getProperties()
Returns a list of properties defined in this object.
Returns:
property list
See Also:
oracle.xdo.delivery.PropertyHandler#getProperties()

validateProperties

public void validateProperties()
                        throws MissingRequiredPropertyException,
                               InvalidPropertyValueException,
                               UndefinedPropertyException
Validates properties. Internal Use Only .
Throws:
MissingRequiredPropertyException
InvalidPropertyValueException
UndefinedPropertyException
See Also:
oracle.xdo.delivery.PropertyHandler#validateProperties()

getIntegerProperty

public int getIntegerProperty(java.lang.String pName)
Returns int representation of the property value. If the property Integer.intValue(), it returns the int value of the object. If the property value is a String object, it tries to parse the string as an int value and returns it. If the parsing fails, it returns 0. If the property value is anything else, it returns 0.
Parameters:
pName - property name
Returns:
propert value in int
See Also:
oracle.xdo.delivery.PropertyHandler#getIntegerProperty(java.lang.String)

getIntegerProperty

public int getIntegerProperty(java.lang.String pName,
                              int pDefault)
Returns int representation of the property value. If the property Integer.intValue(), it returns the int value of the object. If the property value is a String object, it tries to parse the string as an int value and returns it. If the parsing fails, it returns the default value. If the property value is anything else, it returns the defalut value.
Parameters:
pName - property name
pDefault - defalut value
Returns:
propert value in int
See Also:
oracle.xdo.delivery.PropertyHandler#getIntegerProperty(java.lang.String, int)

getBooleanProperty

public boolean getBooleanProperty(java.lang.String pName)
Returns boolean representation of the property value. If the property value is an Boolean object, it returns the Boolean.booleanValue(). If the property value is a String object, it returns true if the value is "true", returns false if the value is "false" (case insensitive). If the parsing fails, it returns false. If the property value is anything else, it returns false.
Parameters:
pName - property name
Returns:
property value in boolean
See Also:
oracle.xdo.delivery.PropertyHandler#getBooleanProperty(java.lang.String)

getBooleanProperty

public boolean getBooleanProperty(java.lang.String pName,
                                  boolean pDefault)
Returns boolean representation of the property value. If the property value is an Boolean object, it returns the Boolean.booleanValue(). If the property value is a String object, it returns true if the value is "true", returns "false" if the value is "false" (case insensitive). If the parsing fails, it returns the default value. If the property value is anything else, it returns the default value.
Parameters:
pName - property name
pDefault - default value
Returns:
property value in boolean
See Also:
oracle.xdo.delivery.PropertyHandler#getBooleanProperty(java.lang.String, boolean)

getStringProperty

public java.lang.String getStringProperty(java.lang.String pName)
Returns the property value of the given property name in a string representation.
Parameters:
pName - property name
Returns:
property value in string
See Also:
oracle.xdo.delivery.PropertyHandler#getStringProperty(java.lang.String)

removeProperty

public void removeProperty(java.lang.String pName)
See Also:
oracle.xdo.delivery.PropertyHandler#removeProperty(java.lang.String)

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Business Intelligence Publisher
11g Release 1 (11.1.1)

E22256-01


Copyright © 2010, 2011, Oracle. All rights reserved.