Oracle® Data Integrator Java API Reference
11g Release 1 (11.1.1.3.0)

E17060-01

oracle.odi.domain.topology
Class OdiLogicalAgent

java.lang.Object
  extended by oracle.odi.domain.support.BusinessObject
      extended by oracle.odi.domain.support.AbstractRepositoryEntity
          extended by oracle.odi.domain.support.AbstractOdiEntity
              extended by oracle.odi.domain.topology.OdiLogicalAgent
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, IMasterOdiEntity, IOdiEntity, IRepositoryEntity

public class OdiLogicalAgent
extends oracle.odi.domain.support.AbstractOdiEntity
implements IMasterOdiEntity

An ODI logical agent to be used as reference to an OdiPhysicalAgent for a given OdiContext.

Since:
11.1.1.3.0
See Also:
Serialized Form

Field Summary
 
Fields inherited from class oracle.odi.domain.support.AbstractOdiEntity
STARTING_INTERNAL_VERSION
 
Constructor Summary
OdiLogicalAgent(java.lang.String pAgentName)
          Create a new OdiLogicalAgent.
 
Method Summary
 java.io.Serializable getInternalId()
          Provides a common getter for the persistence layer to obtain an identity, irrespective of the actual type of identity used.
 java.lang.Number getLogicalAgentId()
          This OdiLogicalAgent ID.
 java.lang.String getName()
          Obtains this OdiLogicalAgent's name.
 OdiPhysicalAgent getPhysicalAgent(OdiContext pContext)
          Obtains the OdiPhysicalAgent mapped to this OdiLogicalAgent for given OdiContext.
 IRepositoryEntity getSecurityContainer()
          Define a generic way to retrieve container for entities.
 
Methods inherited from class oracle.odi.domain.support.AbstractOdiEntity
equals, getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, hashCode, isInstanceLevelSecurityNeeded, isNew, toString
 
Methods inherited from class oracle.odi.domain.support.BusinessObject
clone
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface oracle.odi.domain.IOdiEntity
getFirstDate, getFirstUser, getLastDate, getLastUser, isInstanceLevelSecurityNeeded
 

Constructor Detail

OdiLogicalAgent

public OdiLogicalAgent(java.lang.String pAgentName)
Create a new OdiLogicalAgent.

Parameters:
pAgentName - the agent name
Method Detail

getInternalId

public java.io.Serializable getInternalId()
Description copied from interface: IRepositoryEntity
Provides a common getter for the persistence layer to obtain an identity, irrespective of the actual type of identity used.

Typically a subclass will delegate to a public SomePrimitiveWrapper getId() method. The necessity for the getInternalId() abstract method is solely because the persistence layer needs a way of obtaining the identity irrespective of the actual identity implementation choice.

Returning null from this method will indicate the object has never been saved. This will likely be relied on by some DAO implementations.

Specified by:
getInternalId in interface IRepositoryEntity
Returns:
the persistence identity of this instance

getLogicalAgentId

public java.lang.Number getLogicalAgentId()
This OdiLogicalAgent ID.

Returns:
the id

getName

public java.lang.String getName()
Obtains this OdiLogicalAgent's name.

Specified by:
getName in interface IOdiEntity
Overrides:
getName in class oracle.odi.domain.support.AbstractOdiEntity
Returns:
agent name

getPhysicalAgent

public OdiPhysicalAgent getPhysicalAgent(OdiContext pContext)
Obtains the OdiPhysicalAgent mapped to this OdiLogicalAgent for given OdiContext.

Parameters:
pContext - a context
Returns:
an OdiPhysicalAgent mapped to this, or null if none

getSecurityContainer

public IRepositoryEntity getSecurityContainer()
Description copied from interface: IRepositoryEntity
Define a generic way to retrieve container for entities.

Specified by:
getSecurityContainer in interface IRepositoryEntity
Returns:
container entity

Oracle® Data Integrator Java API Reference
11g Release 1 (11.1.1.3.0)

E17060-01

Copyright © 2010, Oracle and/or its affiliates. All rights reserved.