oracle.odi.domain.runtime.session
Class OdiSessionFolder

java.lang.Object
  oracle.odi.domain.support.BusinessObject
      oracle.odi.domain.support.AbstractRepositoryEntity
          oracle.odi.domain.support.AbstractOdiEntity
              oracle.odi.domain.runtime.session.OdiSessionFolder

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IOdiEntity, IRepositoryEntity

public class OdiSessionFolder
extends oracle.odi.domain.support.AbstractOdiEntity

An OdiSessionFolder is used to group OdiSession using predefined Keywords. Contrary to other types of folder in ODI, an OdiSessionFolder doesn't contain objects (i.e. OdiSessions). It is made of a collection of keywords that can be used to filter sessions that have been started / created with some keywords matching all the OdiSessionFolder's keywords.

Therefore, it is the only entity inside OdiSessionFolder aggregate, thus is the root. It is identified by a unique session folder ID that can be obtained from getSessionFolderId() method call. equals / hashCode methods are implemented according this identity.

Life cycle of an OdiSessionFolder begins when it is created in runtime repository. Some keywords can then be assigned to the OdiSessionFolder. Life cycle ends when the OdiSessionFolder is removed from runtime repository.

Since:

11.1.1.3.0

See Also:

OdiSession, Serialized Form

Field Summary

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

STARTING_INTERNAL_VERSION

Constructor Summary

OdiSessionFolder()

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.String[]	getKeywords() Returns keywords elements that are defined for this OdiSessionFolder.
java.lang.String	getName() Returns the name of this OdiSessionFolder instance.
IRepositoryEntity	getSecurityContainer() Define a generic way to retrieve container for entities.
java.lang.Number	getSessionFolderId() Returns id of this OdiSessionFolder instance.
java.util.Collection<OdiSession>	getSessions(IOdiSessionFinder pFinder) Obtains an unmodifiable collection of OdiSessions matching this OdiSessionFolder's keywords.

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

Constructor Detail

OdiSessionFolder

public OdiSessionFolder()

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.

Returns:

the persistence identity of this instance

getKeywords

public java.lang.String[] getKeywords()

Returns keywords elements that are defined for this OdiSessionFolder.

Returns:

keywords elements that are defined for this OdiSessionFolder.

getName

public java.lang.String getName()

Returns the name of this OdiSessionFolder instance.

Specified by:

getName in interface IOdiEntity

Overrides:

getName in class oracle.odi.domain.support.AbstractOdiEntity

Returns:

the name of this OdiSessionFolder instance.

getSecurityContainer

public IRepositoryEntity getSecurityContainer()

Description copied from interface: IRepositoryEntity

Define a generic way to retrieve container for entities.

Returns:

container entity

getSessionFolderId

public java.lang.Number getSessionFolderId()

Returns id of this OdiSessionFolder instance.

Returns:

id of this OdiSessionFolder instance.

getSessions

public java.util.Collection<OdiSession> getSessions(IOdiSessionFinder pFinder)

Obtains an unmodifiable collection of OdiSessions matching this OdiSessionFolder's keywords.

Parameters:

pFinder - finder for OdiSession

Returns:

an unmodifiable collection of OdiSessions matching this OdiSessionFolder's keywords.