com.plumtree.portalpages.browsing.editors.objectdelivery.common
Class ODDependency

java.lang.Object
  com.plumtree.portalpages.browsing.editors.objectdelivery.common.ODDependency

public class ODDependency
extends java.lang.Object

Author:

adolfoc This class is a simple representation of a dependency returned by the ObjectMigration API, with some bonus features.

Field Summary

protected int	m_nCLASSID
protected int	m_nDependencyType
protected IPTMigrationElement	m_ptMEParent
protected java.lang.String	m_strName Our local information
protected java.lang.String	m_strUUID
static int	ODD_GET_ALL These constants are used as a mask with the GetODDependency call to select what type of dependencies to return.
static int	ODD_GET_HIDDEN
static int	ODD_GET_SUPPORTED
static int	ODD_GET_UNSUPPORTED

Constructor Summary

ODDependency(java.lang.String strName, java.lang.String strUUID, int nCLASSID, int nDependencyType, IPTMigrationElement ptMEParent)
Constructor for ODDependency.

Method Summary

boolean	equals(java.lang.Object arg0)
static XPArrayList	GetAllUnImportableODDependencies(IPTMigrationElement ptME) Static method which creates a bunch of ODDependencies, given a MigrationElement.
int	GetCLASSID() Returns the CLASSID.
int	GetDependencyType() Returns the dependencyType.
IPTMigrationElement	GetMEParent() Returns the mEParent.
java.lang.String	GetName() Returns the name.
static XPArrayList	GetODDependencies(IPTMigrationElement ptME) Static method which creates a bunch of ODDependencies, given a MigrationElement.
static XPArrayList	GetODDependencies(IPTMigrationElement ptME, int nSelectMask) Static method which creates a bunch of ODDependencies given a Migration Element and a selection criteria (see the mask defined above).
static XPArrayList	GetSupportedODDependencies(IPTMigrationElement ptME) Static method which creates a bunch of ODDependencies, given a MigrationElement.
static XPArrayList	GetUnImportableODDependencies(IPTMigrationElement ptME) Static method which creates a bunch of ODDependencies, given a MigrationElement.
java.lang.String	GetUUID() Returns the uUID.
boolean	IsDependentBy(int nDependencyMask) Returns whether or not this dependency is of this dependency type:

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ODD_GET_ALL

public static final int ODD_GET_ALL

These constants are used as a mask with the GetODDependency call to select what type of dependencies to return.

See Also:

Constant Field Values

ODD_GET_SUPPORTED

public static final int ODD_GET_SUPPORTED

See Also:

Constant Field Values

ODD_GET_UNSUPPORTED

public static final int ODD_GET_UNSUPPORTED

See Also:

Constant Field Values

ODD_GET_HIDDEN

public static final int ODD_GET_HIDDEN

See Also:

Constant Field Values

m_ptMEParent

protected IPTMigrationElement m_ptMEParent

m_strName

protected java.lang.String m_strName

Our local information

m_strUUID

protected java.lang.String m_strUUID

m_nCLASSID

protected int m_nCLASSID

m_nDependencyType

protected int m_nDependencyType

Constructor Detail

ODDependency

public ODDependency(java.lang.String strName,
                    java.lang.String strUUID,
                    int nCLASSID,
                    int nDependencyType,
                    IPTMigrationElement ptMEParent)

Constructor for ODDependency.

Method Detail

GetCLASSID

public int GetCLASSID()

Returns the CLASSID.

Returns:

int

GetDependencyType

public int GetDependencyType()

Returns the dependencyType.

Returns:

int

GetMEParent

public IPTMigrationElement GetMEParent()

Returns the mEParent.

Returns:

IPTMigrationElement

GetName

public java.lang.String GetName()

Returns the name.

Returns:

String

GetODDependencies

public static XPArrayList GetODDependencies(IPTMigrationElement ptME,
                                            int nSelectMask)

Static method which creates a bunch of ODDependencies given a Migration Element and a selection criteria (see the mask defined above).

GetODDependencies

public static XPArrayList GetODDependencies(IPTMigrationElement ptME)

Static method which creates a bunch of ODDependencies, given a MigrationElement.

GetSupportedODDependencies

public static XPArrayList GetSupportedODDependencies(IPTMigrationElement ptME)

Static method which creates a bunch of ODDependencies, given a MigrationElement. Returns an array of only those ODDependencies that are supported (as listed in ObjectDeliveryHelper.m_arSupportedCLASSIDS); This method does not return Folders as supported dependencies.

GetUUID

public java.lang.String GetUUID()

Returns the uUID.

Returns:

String

GetUnImportableODDependencies

public static XPArrayList GetUnImportableODDependencies(IPTMigrationElement ptME)

Static method which creates a bunch of ODDependencies, given a MigrationElement. Returns an array of only those ODDependencies that are NOT supported (as listed in ObjectDeliveryHelper.m_arSupportedCLASSIDS); This method DOES NOT return Folder Dependencies or Users as UnSupported.

GetAllUnImportableODDependencies

public static XPArrayList GetAllUnImportableODDependencies(IPTMigrationElement ptME)

Static method which creates a bunch of ODDependencies, given a MigrationElement. Returns an array of only those ODDependencies that are NOT supported (as listed in ObjectDeliveryHelper.m_arSupportedCLASSIDS); This method DOES return Folder Dependencies or Users as UnSupported.

IsDependentBy

public boolean IsDependentBy(int nDependencyMask)

Returns whether or not this dependency is of this dependency type:

Returns:

boolean

equals

public boolean equals(java.lang.Object arg0)

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(Object)