|
Oracle Warehouse Builder Java API Reference 10g Release 1 (10.1) B12155-01 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This is the base interface for all OWB metadata objects exposed in the public API. It provides basic properties like name, business name and description. It always has a unique global identifier (UOID). A generic delete() method is provided at this level and inherited by all other objects. Deleting an OWB object will result in removing it from the repository, as well as from the Java object cache. Any further attempt to access the object will result in OWBException runtime exception being thrown.
Method Summary | |
void |
delete() Deletes the object. |
java.lang.String |
getBusinessName() Gets this object's business name. |
ClassDefinition |
getClassDefinition() Returns the class definition for this object. |
Component |
getComponent() Returns the owning Component for this object. |
java.lang.String |
getDescription() Gets this object's detailed description. |
java.lang.String |
getName() Gets this object's name. |
java.lang.String |
getUOID() Returns the unique identifier of this object. |
boolean |
isDeletable() Returns whether this object is deletable. |
boolean |
isEditable() Returns whether this object is editable. |
boolean |
isRenamable() Returns whether this object is renamable. |
void |
setBusinessName(java.lang.String businessName) Sets the business name for this object. |
void |
setDescription(java.lang.String description) Sets a detailed description for this object. |
void |
setName(java.lang.String name) Sets the name for this object. |
Method Detail |
public java.lang.String getUOID()
public java.lang.String getName()
setName(java.lang.String)
public void setName(java.lang.String name) throws NameSpaceException, InvalidFormatException
null
, and its length must be greater than 0 and less or equal to 30 charaters.name
- the name for this objectNameSpaceException
- if another OWBNamedObject
with the same name already exists within this object's namespaceInvalidFormatException
- if the desired name does not satisfy the format requirementsgetName()
public java.lang.String getBusinessName()
setBusinessName(java.lang.String)
public void setBusinessName(java.lang.String businessName) throws NameSpaceException, InvalidFormatException
null
, and its length must be greater than 0 and less or equal to 255 charaters.businessName
- the business name for this objectNameSpaceException
- if another OWBNamedObject
with the same business name already exists within this object's namespaceInvalidFormatException
- if the desired business name does not satisfy the format requirementsgetBusinessName()
public java.lang.String getDescription()
setDescription(java.lang.String)
public void setDescription(java.lang.String description)
description
- the object's descriptiongetDescription()
public void delete()
public Component getComponent()
Component
for this object. If the object is not part of any component, the method returns null
.null
if this object is not part of any componentpublic ClassDefinition getClassDefinition()
public boolean isEditable()
true
if the object is editable, and false
otherwisepublic boolean isRenamable()
true
if the object is renamable, and false
otherwisepublic boolean isDeletable()
true
if the object is deletable, and false
otherwise
|
Oracle Warehouse Builder Java API Reference 10g Release 1 (10.1) B12155-01 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |