Skip Headers

Oracle® XML API Reference 10g Release 1 (10.1) Part No. B10789-01 |
| Contents

## EntityRef Interface

Table 15-15 summarizes the methods of available through `EntityRef` interface.

Table 15-15 Summary of EntityRef Methods; Dom Package

Function | Summary
--- | ---
EntityRef | Constructor.
getNotationName | Get entity's notation.
getPublicId | Get entity's public ID.
getSystemId | Get entity's system ID.
getType | Get entity's type.
~EntityRef | Public default destructor.

### EntityRef

Class constructor.

Syntax | Description
--- | ---
    EntityRef(
       const NodeRef< Node>& node_ref,
       Node* nptr);
| Used to create references to a given entity node after a call to create `Entity`.
    EntityRef(
       const EntityRef< Node>& nref);
| Copy constructor.

Parameter | Description
--- | ---
    node_ref
| reference to provide the context
    nptr
| referenced node

Returns

`(EntityRef)` `Node` reference object

### getNotationName

For unparsed entities, returns the name of its notation (in the data encoding). For parsed entities and other node types, returns `NULL`.

Syntax

    oratext* getNotationName() const;

Returns

`(oratext*)` entity's notation

### getPublicId

Returns an entity's public identifier (in the data encoding).

Syntax

    oratext* getPublicId() const;

Returns

`(oratext*)` entity's public identifier

### getSystemId

Returns an entity's system identifier (in the data encoding).

Syntax

    oratext* getSystemId() const;

Returns

`(oratext*)` entity's system identifier

### getType

Returns a boolean for an entity describing whether it is general (`TRUE`) or parameter (`FALSE`).

Syntax

    boolean getType() const;

Returns

`(boolean)` `TRUE` for general entity, `FALSE` for parameter entity

### ~EntityRef

This is the default destructor.

Syntax

    ~EntityRef();