public final class AdaptationHome extends Object
Note: In previous versions, a dataspace was known as a branch, and a snapshot was known as a version.
Repository
Modifier and Type | Method and Description |
---|---|
Adaptation |
findAdaptationOrNull(AdaptationName aName)
Returns the specified dataset or record based on its
AdaptationName . |
List<Adaptation> |
findAllChildren(Adaptation aDataSetOrRecord)
Returns a list of all datasets or records that are direct children of the one specified.
|
List<Adaptation> |
findAllDescendants(Adaptation aDataSetOrRecord)
Returns a list of all the datasets and records that inherit from the one specified,
either as direct children or as descendants (recursive).
|
List<Adaptation> |
findAllRoots()
Returns all the dataset roots of this
AdaptationHome . |
Adaptation |
findParent(Adaptation aDataSetOrRecord)
Deprecated.
Replaced by
Adaptation.getParent() . |
List<AdaptationHome> |
getBranchChildren()
Returns the dataspaces which have been created from this
AdaptationHome . |
Date |
getCreationDate()
Returns the creation date of this dataspace or snapshot.
|
Profile |
getCreator()
Returns the creator profile of this dataspace or snapshot in the current
repository.
|
UserMessage |
getDescription()
Returns the internationalized description of this dataspace or snapshot.
|
String |
getDescription(Locale aLocale)
Returns the description of this dataspace or snapshot for a given locale.
|
HomeKey |
getKey()
Returns the key that identifies this dataspace or snapshot in the current
repository.
|
UserMessage |
getLabel()
Returns the internationalized label of this dataspace or snapshot.
|
String |
getLabel(Locale aLocale)
Returns the label of this dataspace or snapshot for a given locale.
|
String |
getLabelOrName(Locale aLocale)
Returns the label of this dataspace or snapshot for a given locale.
|
UserMessage |
getLabelOrNameAsUserMessage()
Returns the internationalized label of this dataspace or snapshot.
|
Profile |
getOwner()
Returns the owner profile of this dataspace or snapshot in the current
repository.
|
AdaptationHome |
getParent()
Returns the parent dataspace of this
AdaptationHome . |
AdaptationHome |
getParentBranch()
Returns the parent dataspace or snapshot of this
AdaptationHome . |
Repository |
getRepository()
Returns the repository that contains this
AdaptationHome . |
Date |
getTerminationDate()
Returns the date this dataspace or snapshot was closed, if it is closed.
|
Map<AdaptationName,ValidationReport> |
getValidationReportsMap(Severity minimalSeverity)
Returns a map of all validation reports of datasets in this
AdaptationHome
that have at least one validation item of the specified severity or higher. |
List<AdaptationHome> |
getVersionChildren()
Returns the snapshots which have been created from this
AdaptationHome . |
boolean |
isAncestorOf(AdaptationHome anotherHome)
Returns
true if this AdaptationHome is an ancestor of
the specified AdaptationHome (the AdaptationHome itself is excluded). |
boolean |
isBranch()
Returns
true if this AdaptationHome is a dataspace. |
boolean |
isBranchReference()
|
boolean |
isInitialVersion()
Returns
true if this AdaptationHome is an initial snapshot
of a dataspace. |
boolean |
isLockedBranch()
Returns
true if this AdaptationHome is a
locked dataspace. |
boolean |
isMarkedForHistoryPurge()
Returns
true if this AdaptationHome is marked for history purge. |
boolean |
isMarkedForPurge()
Deprecated.
|
boolean |
isOpen()
Returns
true if this AdaptationHome is either
an open snapshot or an open dataspace. |
boolean |
isOpenBranch()
Returns
true if this AdaptationHome is an open dataspace. |
boolean |
isOpenVersion()
Returns
true if this AdaptationHome is an open snapshot. |
boolean |
isTechnicalBranch()
Returns
true if this AdaptationHome is a
technical dataspace. |
boolean |
isTechnicalVersion()
Returns
true if this AdaptationHome
is a technical snapshot. |
boolean |
isVersion()
Returns
true if this AdaptationHome is a snapshot. |
void |
resetValidationReports()
Resets the validation reports of the datasets contained
in this dataspace.
|
String |
toDisplayString(Locale aLocale)
Returns a user-friendly string that specifies
the type of this object, for example, "Dataspace <key>" or "Snapshot <key>".
|
String |
toString() |
public Adaptation findAdaptationOrNull(AdaptationName aName)
AdaptationName
.
Returns null
if it cannot be found.AdaptationName
public Adaptation findParent(Adaptation aDataSetOrRecord)
Adaptation.getParent()
.public List<Adaptation> findAllChildren(Adaptation aDataSetOrRecord)
public List<Adaptation> findAllDescendants(Adaptation aDataSetOrRecord)
public List<Adaptation> findAllRoots()
AdaptationHome
.Adaptation.isRootAdaptation()
public HomeKey getKey()
public Profile getOwner()
public Profile getCreator()
Returns null
if no creator is defined. For example, technical
reserved branches are created by the 'System User'.
public UserMessage getLabel()
Returns null
if no labels are defined in any language.
public String getLabel(Locale aLocale)
null
if no label is defined for the locale provided.public String getLabelOrName(Locale aLocale)
public UserMessage getLabelOrNameAsUserMessage()
public UserMessage getDescription()
Returns null
if no descriptions are defined in any language.
public String getDescription(Locale aLocale)
null
if no description is defined for the locale provided.public Date getCreationDate()
public Date getTerminationDate()
Returns null
if the dataspace or snapshot is open.
public AdaptationHome getParent()
AdaptationHome
.
Returns null
if this is the reference dataspace
.
For a dataspace, its parent is always its initial snapshot. For a snapshot, its parent is always its parent dataspace.
public AdaptationHome getParentBranch()
AdaptationHome
.
Returns null
if this AdaptationHome
is the reference dataspace
.
Note: For a dataspace, its direct parent is its initial snapshot, hence its parent dataspace is the parent of this initial snapshot. For a snapshot, its parent dataspace is its direct parent.
getBranchChildren()
,
getVersionChildren()
public List<AdaptationHome> getBranchChildren()
AdaptationHome
.
Note: A dataspace has no direct dataspace children; when a dataspace is created from another dataspace, first an initial snapshot is created, then the new dataspace is created from this initial snapshot.
getVersionChildren()
public List<AdaptationHome> getVersionChildren()
AdaptationHome
.
A snapshot is always created from a dataspace.
getBranchChildren()
public Repository getRepository()
AdaptationHome
.public boolean isBranch()
true
if this AdaptationHome
is a dataspace.public boolean isBranchReference()
public boolean isOpenBranch()
true
if this AdaptationHome
is an open dataspace.public boolean isOpenVersion()
true
if this AdaptationHome
is an open snapshot.public boolean isOpen()
true
if this AdaptationHome
is either
an open snapshot or an open dataspace.public boolean isLockedBranch()
true
if this AdaptationHome
is a
locked dataspace.LockSpec
public boolean isMarkedForPurge()
false
.public boolean isMarkedForHistoryPurge()
true
if this AdaptationHome
is marked for history purge.public boolean isAncestorOf(AdaptationHome anotherHome)
true
if this AdaptationHome
is an ancestor of
the specified AdaptationHome
(the AdaptationHome
itself is excluded).public boolean isVersion()
true
if this AdaptationHome
is a snapshot.public boolean isInitialVersion()
true
if this AdaptationHome
is an initial snapshot
of a dataspace.
When a dataspace is created from another dataspace, first an initial snapshot is created, then the new dataspace is created from this initial snapshot.
Repository
public final String toDisplayString(Locale aLocale)
getKey()
public Map<AdaptationName,ValidationReport> getValidationReportsMap(Severity minimalSeverity)
AdaptationHome
that have at least one validation item of the specified severity or higher.
Since this method calls
Adaptation.getValidationReport(false)
on each dataset, it does not require the datasets to be activated.
The rules for ensuring that data in EBX® remains valid, with respect to potential concurrent updates, are explained in section Consistency and validation.
AdaptationName
s
and values ValidationReport
sValidationReport.hasItemsOfSeverityOrMore(Severity)
public final void resetValidationReports()
Adaptation.resetValidationReport(boolean)
,
getValidationReportsMap(Severity)
public final boolean isTechnicalBranch()
true
if this AdaptationHome
is a
technical dataspace.
A technical dataspace is used internally
used by EBX®, and cannot be closed or merged.public final boolean isTechnicalVersion()
true
if this AdaptationHome
is a technical snapshot.
A snapshot is technical if it is a snapshot of a technical dataspace.isTechnicalBranch()