public class OdiSessionFolder extends oracle.odi.domain.support.AbstractOdiEntity implements IWorkRuntimeOdiEntity
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.
OdiSession
,
Serialized FormModifier and Type | Field and Description |
---|---|
static int |
KEYWORDS_MAX_TOTAL_LENGTH
Maximum total length of an
OdiSessionFolder 's keywords. |
static int |
NAME_MAX_LENGTH
Maximum length of an
OdiSessionFolder 's name. |
Constructor and Description |
---|
OdiSessionFolder(java.lang.String pName)
Constructs a new
OdiSessionFolder , specified by name. |
Modifier and Type | Method and Description |
---|---|
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 |
getSessions(IOdiSessionFinder pFinder)
Obtains an unmodifiable collection of OdiSessions matching this
OdiSessionFolder 's keywords. |
void |
setKeywords(java.lang.String[] pKeywords)
Sets keywords for this
OdiSessionFolder . |
void |
setName(java.lang.String pName)
Sets name of this
OdiSessionFolder . |
equals, getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, hashCode, isInstanceLevelSecurityNeeded, isNew, toString
getGlobalId, getNumericId, hasCustomizedPersistenceMethodFor, invokeCustomizedPersistenceMethodFor
getFirstDate, getFirstUser, getLastDate, getLastUser, isInstanceLevelSecurityNeeded
getGlobalId
public static final int NAME_MAX_LENGTH
OdiSessionFolder
's name.public static final int KEYWORDS_MAX_TOTAL_LENGTH
OdiSessionFolder
's keywords.public OdiSessionFolder(java.lang.String pName)
OdiSessionFolder
, specified by name.pName
- - OdiSessionFolder
's nameDomainRuntimeException
- if pName is null, empty or longer than
400public java.lang.Number getSessionFolderId()
OdiSessionFolder
instance.OdiSessionFolder
instance.public java.lang.String getName()
OdiSessionFolder
instance.getName
in interface IOdiEntity
getName
in class oracle.odi.domain.support.AbstractOdiEntity
OdiSessionFolder
instance.public java.lang.String[] getKeywords()
OdiSessionFolder
.OdiSessionFolder
.public java.util.Collection getSessions(IOdiSessionFinder pFinder)
OdiSessionFolder
's keywords.pFinder
- finder for OdiSession
OdiSessionFolder
's keywords.public java.io.Serializable getInternalId()
IRepositoryEntity
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.
getInternalId
in interface IRepositoryEntity
public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
public void setName(java.lang.String pName)
OdiSessionFolder
.pName
- - nameDomainRuntimeException
- if pName is null, empty or longer than
400public void setKeywords(java.lang.String[] pKeywords)
OdiSessionFolder
.pKeywords
- array of string keywordsDomainRuntimeException
- if total length of keywords is greater than
250