com.sap.ip.me.api.smartsync
Class DependencyType

java.lang.Object
  extended bycom.sap.ip.me.api.smartsync.DependencyType

public final class DependencyType
extends java.lang.Object

An enumeration of possible dependencies between SyncBOs with foreign key relationships. This can either be

  • INDEPENDENT - no dependencies.
  • RELATED_DEPENDENT - dependency of the RELATED SyncBO to the RELATING SyncBO.If e.g. the SyncBO "customer order" has a foreign key for "customer master", then "customer order" could depend on "customer master".The "customer order" will be the related syncBo.
  • RELATING_DEPENDENT - dependency of the RELATING SyncBO to the RELATED SyncBO.If e.g. the SyncBO "customer order" has a foreign key for "customer master", then "customer order" could depend on "customer master".The "customer master" will be the relating syncBo.

    Not all foreign key relationships imply dependency; dependency only exists if the foreign key is necessary to successfully post SyncBOs in to the backend.
    Example:
    To retrieve the RelationDescriptor from a certain FieldDescriptor fieldDesc object.
    RelationDescriptor relationDesc = fieldDesc.getRelatedRelation();
    DependencyType dependencyType = relationDesc.getDependency();

    The value of dependencyType will be DependencyType.INDEPENDENT,DependencyType.RELATED_DEPENDENT,
    DependencyType.RELATING_DEPENDENT for Independent,Related dependent,Relating dependent types of relationships.

    Since:
    2.1
    Author:
    SAP
    See Also:
    RelationDescriptor

    Field Summary
    static DependencyType INDEPENDENT
              Represents a non-dependency.
    static DependencyType RELATED_DEPENDENT
              Describes dependency of related entity on relating entity
    static DependencyType RELATING_DEPENDENT
              Describes dependency of relating entity on related entity
     
    Method Summary
    static DependencyType forString(java.lang.String typeString)
              Returns the DependencyType instance for the specified type string
     java.lang.String toString()
              Returns the String description of this DependencyType object; either one of the following: "independent", "relatedDependent" , "relatingDependent"
     
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
     

    Field Detail

    INDEPENDENT

    public static DependencyType INDEPENDENT
    Represents a non-dependency.


    RELATING_DEPENDENT

    public static DependencyType RELATING_DEPENDENT
    Describes dependency of relating entity on related entity


    RELATED_DEPENDENT

    public static DependencyType RELATED_DEPENDENT
    Describes dependency of related entity on relating entity

    Method Detail

    forString

    public static DependencyType forString(java.lang.String typeString)
    Returns the DependencyType instance for the specified type string

    Parameters:
    typeString - the dependency type string that is either of the following: "independent", "relatedDependent" , "relatingDependent"
    Returns:
    The corresponding DependencyType object for the specified type

    toString

    public java.lang.String toString()
    Returns the String description of this DependencyType object; either one of the following: "independent", "relatedDependent" , "relatingDependent"

    Returns:
    the dependency description


    Copyright © 2005 SAP AG. All Rights Reserved.