com.softwareag.mdm.adaptation
Class AdaptationHome

java.lang.Object
  com.softwareag.mdm.adaptation.AdaptationHome

public class AdaptationHome

extends Object

Represents a branch or a version in a repository.

See Also:

Repository

Method Summary

Adaptation	findAdaptationOrNull(AdaptationName aName) Returns the adaptation specified, null if not found.
List	findAllAgreements(com.softwareag.mdm.core.org.OrganizationName distributorName, Adaptation aRoot, boolean ignored) Deprecated. Replaced by findAllAgreements(Profile, Adaptation).
List	findAllAgreements(Profile distributor, Adaptation aRoot) Returns a list of all the adaptations that are an agreement with the distributor specified and that are under the root specified.
List	findAllChildren(Adaptation anAdaptation) Returns a list of the adaptations that are direct children of the adaptation specified.
List	findAllChildren(Adaptation anAdaptation, boolean ignored) Deprecated. Replaced by findAllChildren(Adaptation).
List	findAllDescendants(Adaptation anAdaptation) Returns a list of all the adaptations that inherit from the adaptation specified (either as direct children or as descendants of children, recursively).
List	findAllDescendants(Adaptation anAdaptation, boolean ignored) Deprecated. Replaced by findAllDescendants(Adaptation).
List	findAllRoots() Returns all the adaptation instance roots of this repository.
List	findAllRoots(boolean ignored) Deprecated. Replaced by findAllRoots().
Adaptation	findParent(Adaptation anAdaptation) Returns the parent of the adaptation specified, or null if it is a root.
Adaptation	findParent(Adaptation anAdaptation, boolean ignored) Deprecated. Replaced by findParent(Adaptation).
List	getBranchChildren() Returns the branches which have been created from this home.
Date	getCreationDate() Returns the creation date of this home.
String	getDescription(Locale aLocale) Returns the description of this home.
HomeKey	getKey() Returns the key that identifies this home in the current repository.
String	getLabel(Locale aLocale) Returns the label of this home.
String	getLabelOrName(Locale aLocale) Returns the label of this home.
Profile	getOwner() Returns the owner profile of this home in the current repository.
AdaptationHome	getParent() Returns the parent home, null if this home is the Reference branch.
AdaptationHome	getParentBranch() Returns the parent branch, null if this home is the Reference branch.
Adaptation	getPreferredEdition(Adaptation target) Deprecated. Since versioning features, edition/release distinction in a single home is no more significant, hence this method returns the same object as the argument.
Adaptation	getPreferredRelease(Adaptation target) Deprecated. Since versioning features, edition/release distinction in a single home is no more significant, hence this method returns the same object as the argument.
Repository	getRepository() Returns the repository that contains this home.
String	getRepositoryLabel() Deprecated. Replaced by RepositoryDeclaration.getRepositoryLabel().
Date	getTerminationDate() Returns the termination date of this home.
Map	getValidationReportsMap(Severity minimalSeverity) Returns a map of all validation reports of instances in this home that have at least a validation item of the severity specified or more.
List	getVersionChildren() Returns the versions which have been created from this home.
boolean	isAncestorOf(AdaptationHome anotherHome) Returns true if this home is an ancestor of the home specified (home itself is excluded).
boolean	isBranch() Returns true if this home is a branch.
boolean	isBranchReference() Returns true if this home is the Reference branch.
boolean	isInitialVersion() Returns true if this home is an initial version of a branch.
boolean	isOpen() Returns true if this home is either an open version or an open branch.
boolean	isOpenBranch() Returns true if this home is an open branch.
boolean	isOpenVersion() Returns true if this home is an open version.
boolean	isVersion() Returns true if this home is a version.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

findAdaptationOrNull

public Adaptation findAdaptationOrNull(AdaptationName aName)

Returns the adaptation specified, null if not found.

findParent

public Adaptation findParent(Adaptation anAdaptation)

Returns the parent of the adaptation specified, or null if it is a root.

See Also:

Adaptation.isRootAdaptation()

findAllChildren

public List findAllChildren(Adaptation anAdaptation)

Returns a list of the adaptations that are direct children of the adaptation specified.

findAllDescendants

public List findAllDescendants(Adaptation anAdaptation)

Returns a list of all the adaptations that inherit from the adaptation specified (either as direct children or as descendants of children, recursively).

findAllAgreements

public List findAllAgreements(Profile distributor,
                              Adaptation aRoot)

Returns a list of all the adaptations that are an agreement with the distributor specified and that are under the root specified.

findAllRoots

public List findAllRoots()

Returns all the adaptation instance roots of this repository.

See Also:

Adaptation.isRootAdaptation()

getKey

public HomeKey getKey()

Returns the key that identifies this home in the current repository.

getOwner

public Profile getOwner()

Returns the owner profile of this home in the current repository.

getLabel

public String getLabel(Locale aLocale)

Returns the label of this home. It may be null.

getLabelOrName

public String getLabelOrName(Locale aLocale)

Returns the label of this home. If not defined, it returns the key name.

getDescription

public String getDescription(Locale aLocale)

Returns the description of this home. If not defined, it returns null.

getCreationDate

public Date getCreationDate()

Returns the creation date of this home.

getTerminationDate

public Date getTerminationDate()

Returns the termination date of this home.

If termination date is null, the home is considered as open.

getParent

public AdaptationHome getParent()

Returns the parent home, null if this home is the Reference branch.

For a branch, its parent is its initial version. For a version, its parent is its parent branch.

getParentBranch

public AdaptationHome getParentBranch()

Returns the parent branch, null if this home is the Reference branch.

For a branch, its direct parent is its initial version, hence its parent branch is the parent of this initial version. For a version, its parent branch is its direct parent.

See Also:

getBranchChildren(), getVersionChildren()

getBranchChildren

public List getBranchChildren()

Returns the branches which have been created from this home.

A branch has no direct branch children (when a branch is created from another branch, an initial version is first created, then the new branch is created from this initial version).

getVersionChildren

public List getVersionChildren()

Returns the versions which have been created from this home.

A version is always created from a branch.

getRepository

public Repository getRepository()

Returns the repository that contains this home.

isBranch

public boolean isBranch()

Returns true if this home is a branch.

isBranchReference

public boolean isBranchReference()

Returns true if this home is the Reference branch.

isOpenBranch

public boolean isOpenBranch()

Returns true if this home is an open branch.

isOpenVersion

public boolean isOpenVersion()

Returns true if this home is an open version.

isOpen

public boolean isOpen()

Returns true if this home is either an open version or an open branch.

isAncestorOf

public boolean isAncestorOf(AdaptationHome anotherHome)

Returns true if this home is an ancestor of the home specified (home itself is excluded).

isVersion

public boolean isVersion()

Returns true if this home is a version.

isInitialVersion

public boolean isInitialVersion()

Returns true if this home is an initial version of a branch.

When a branch is created from another branch, an initial version is first created, then the new branch is created from this initial version.

See Also:

Repository

getRepositoryLabel

public String getRepositoryLabel()

Deprecated. Replaced by RepositoryDeclaration.getRepositoryLabel().

findAllAgreements

public List findAllAgreements(com.softwareag.mdm.core.org.OrganizationName distributorName,
                              Adaptation aRoot,
                              boolean ignored)
                       throws com.softwareag.mdm.core.org.OrganizationNotFoundException

Deprecated. Replaced by findAllAgreements(Profile, Adaptation).

Throws:

com.softwareag.mdm.core.org.OrganizationNotFoundException

findAllRoots

public List findAllRoots(boolean ignored)

Deprecated. Replaced by findAllRoots().

findAllChildren

public List findAllChildren(Adaptation anAdaptation,
                            boolean ignored)

Deprecated. Replaced by findAllChildren(Adaptation).

findAllDescendants

public List findAllDescendants(Adaptation anAdaptation,
                               boolean ignored)

Deprecated. Replaced by findAllDescendants(Adaptation).

findParent

public Adaptation findParent(Adaptation anAdaptation,
                             boolean ignored)

Deprecated. Replaced by findParent(Adaptation).

getPreferredEdition

public Adaptation getPreferredEdition(Adaptation target)

Deprecated. Since versioning features, edition/release distinction in a single home is no more significant, hence this method returns the same object as the argument.

getPreferredRelease

public Adaptation getPreferredRelease(Adaptation target)

Deprecated. Since versioning features, edition/release distinction in a single home is no more significant, hence this method returns the same object as the argument.

toString

public String toString()

getValidationReportsMap

public Map getValidationReportsMap(Severity minimalSeverity)

Returns a map of all validation reports of instances in this home that have at least a validation item of the severity specified or more.

Returns:

a map whose keys are AdaptationNames an values ValidationReports

See Also:

ValidationReport.hasItemsOfSeverityOrMore(Severity), Adaptation.getValidationReport(), Consistency and validation