Skip navigation links

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

E17060-04


oracle.odi.domain.marker
Class OdiMarkerGroup

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.marker.OdiMarkerGroup

All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, oracle.odi.core.audit.support.IAuditableFirstClassObject, IExportable, IOdiEntity, IRepositoryEntity, IWorkDevelopmentOdiEntity, ISmartExportable

public class OdiMarkerGroup
extends oracle.odi.domain.support.AbstractOdiEntity
implements IExportable, IWorkDevelopmentOdiEntity, ISmartExportable, oracle.odi.core.audit.support.IAuditableFirstClassObject

Represents design time metadata about a marker group.

OdiMarkerGroup class is the root entity and implements IOdiEntity interface. An OdiMarkerGroup has an ID that can be obtained from getMarkerGroupId() method call. This ID is assigned when an OdiMarkerGroup is stored in design time repository. This ID represents the identity of an OdiMarkerGroup. Equals / hashCode method are implemented according this identity.

There is two distinct scopes of OdiMarkerGroup: Global and Project.

Scope of an OdiMarkerGroup cannot be changed.

Life cycle of an OdiMarkerGroup begins at design time when it is created from constructor (Global Scope), from enclosing OdiProject (Project Scope), or when imported from external XML file. It is then typically stored inside ODI design time repository. The users can modify it in order to make it fit their needs. Life cycle ends when a user remove OdiMarkerGroup instance from design time repository, or if enclosing OdiProject is removed (Project Scope). An OdiMarkerGroup can be exported and imported. It implements the interface IExportable.

There is no public constructor for marker group. It can be accessed through IOdiMarkerGroupFinder.

Since:
11.1.1.7.0
See Also:
Serialized Form

Field Summary

 

Fields inherited from class oracle.odi.domain.support.AbstractOdiEntity
STARTING_INTERNAL_VERSION

 

Method Summary
 java.lang.String getCode()
          Obtains the code of this marker group in ODI.
 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 getMarkerGroupId()
          Returns the ID of this marker group.
 java.lang.String getName()
          Obtains the name of this marker group in ODI.
 OdiProject getProject()
          Returns the OdiProject instance for Project-Level marker group.
 IRepositoryEntity getSecurityContainer()
          Define a generic way to retrieve container for entities.
 boolean isGlobal()
          Returns whether this OdiMarkerGroup is global, or not
 boolean isInstanceLevelSecurityNeeded()
          Internal: this method is for internal purpose and must not be considered as part of the public API.

 

Methods inherited from class oracle.odi.domain.support.AbstractOdiEntity
equals, getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, hashCode, 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

 

Method Detail

getProject

public OdiProject getProject()
Returns the OdiProject instance for Project-Level marker group.
Returns:
this marker group's project or null if this marker group is Global

getMarkerGroupId

public java.lang.Number getMarkerGroupId()
Returns the ID of this marker group.
Returns:
this marker group's ID

isGlobal

public boolean isGlobal()
Returns whether this OdiMarkerGroup is global, or not
Returns:
true if the scope of marker group is Global, false otherwise (i.e. Project Scope)

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

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

isInstanceLevelSecurityNeeded

public boolean isInstanceLevelSecurityNeeded()
Description copied from interface: IOdiEntity
Internal: this method is for internal purpose and must not be considered as part of the public API.

Defines a method to capture the info on which object needs instance level privilege.

Specified by:
isInstanceLevelSecurityNeeded in interface IOdiEntity
Overrides:
isInstanceLevelSecurityNeeded in class oracle.odi.domain.support.AbstractOdiEntity
Returns:
true if instance level security needed, false otherwise

getCode

public java.lang.String getCode()
Obtains the code of this marker group in ODI.
Returns:
this marker group's code

getName

public java.lang.String getName()
Obtains the name of this marker group in ODI.
Specified by:
getName in interface IOdiEntity
Overrides:
getName in class oracle.odi.domain.support.AbstractOdiEntity
Returns:
this marker group's name

Skip navigation links

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

E17060-04


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