Oracle Warehouse Builder Java API Reference
10g Release 1 (10.1)

B12155-01

oracle.owb.aq
Interface AdvancedQueue

All Superinterfaces:
CompilableObject, Component, Extensible, OWBNamedObject, PropertyOwner, ReconcileSource, Snapshotable, ValidatableObject

public interface AdvancedQueue
extends OWBNamedObject, Component, PropertyOwner, Extensible, ValidatableObject, CompilableObject, ReconcileSource

This class represents an Oracle Advanced Queue. An AdvancedQueue has a Payload Type expressed as an ObjectType which defines it's basic structure. It can be instantiated only from Oracle Module using createAdvancedQueue() or findAdvancedQueue() methods.


Field Summary
static java.lang.String Prop_Deployable
          Name of the property representing if Deployable.
static java.lang.String Prop_PayloadType
          Name of the property representing Payload structure.
static java.lang.String Prop_QueueTableName
          Name of the property representing underlying Queue Table.
static java.lang.String Prop_Tablespace
          Name of the property representing the Tablespace.

 

Fields inherited from interface oracle.owb.metadatamgmt.changemgmt.Snapshotable
MAX_DEPENDENCY_DEPTH, MIN_DEPENDENCY_DEPTH

 

Method Summary
 ObjectType getPayloadType()
          This method returns the ObjectType which defines its payload.
 void setPayloadType(ObjectType payloadtype)
          This method sets the payload structure of this AdvancedQueue.
 void setProperty(java.lang.String key, java.lang.String value)
          This method sets the various properties for the AdvancedQueue.

 

Methods inherited from interface oracle.owb.foundation.OWBNamedObject
delete, getBusinessName, getClassDefinition, getComponent, getDescription, getName, getUOID, isDeletable, isEditable, isRenamable, setBusinessName, setDescription, setName

 

Methods inherited from interface oracle.owb.foundation.Component
getOwningFolder, isReloadNeeded, lock, reload, unlock

 

Methods inherited from interface oracle.owb.metadatamgmt.changemgmt.Snapshotable
compare, compare, compare, compare, createSnapshot, createSnapshot, createSnapshotWithDependeeComponents, createSnapshotWithDependeeComponents, getSnapshots

 

Methods inherited from interface oracle.owb.foundation.property.PropertyOwner
getDefaultPropertyValue, getLogicalPropertyKeys, getPhysicalPropertyKeys, getPropertyDomain, getPropertyKeys, getPropertyValue, getPropertyValueString, isLogicalProperty, isPhysicalProperty, isReadOnlyProperty, setPropertyValue, setPropertyValueByString

 

Methods inherited from interface oracle.owb.compile.ValidatableObject
validate

 

Methods inherited from interface oracle.owb.compile.CompilableObject
compile

 

Methods inherited from interface oracle.owb.reconcile.ReconcileSource
getReconcileTargetTypes, getType

 

Field Detail

Prop_PayloadType

public static final java.lang.String Prop_PayloadType
Name of the property representing Payload structure.
See Also:
Constant Field Values

Prop_Tablespace

public static final java.lang.String Prop_Tablespace
Name of the property representing the Tablespace.
See Also:
Constant Field Values

Prop_QueueTableName

public static final java.lang.String Prop_QueueTableName
Name of the property representing underlying Queue Table.
See Also:
Constant Field Values

Prop_Deployable

public static final java.lang.String Prop_Deployable
Name of the property representing if Deployable.
See Also:
Constant Field Values
Method Detail

getPayloadType

public ObjectType getPayloadType()
                          throws OWBException
This method returns the ObjectType which defines its payload.
Returns:
the ObjectType which defines it's payload.
Throws:
OWBException
See Also:
setPayloadType(ObjectType)

setPayloadType

public void setPayloadType(ObjectType payloadtype)
                    throws OWBException
This method sets the payload structure of this AdvancedQueue.
Parameters:
payloadtype - an ObjectType which defines the structure of its payload.
Throws:
OWBException
See Also:
getPayloadType()

setProperty

public void setProperty(java.lang.String key,
                        java.lang.String value)
                 throws NoSuchPropertyException,
TypeMismatchException
This method sets the various properties for the AdvancedQueue. The properties which can be set on Advanced Queue are all the public member attributes which are perfixed by "Prop_".
Parameters:
key - name of the property to be set.
value - value of the property to be set.
Throws:
NoSuchPropertyException - if the property name specified does not exist
TypeMismatchException - if the value specified is not of a compatible type

Oracle Warehouse Builder Java API Reference
10g Release 1 (10.1)

B12155-01

Copyright © 2003, Oracle. All Rights Reserved.