com.sap.ip.me.api.smartsync
Interface SyncBoDescriptor


public interface SyncBoDescriptor

A SyncBoDescriptor represents a metadata of a SyncBO. It provides read-access to:

Example: Retrieving the Top row of the SyncBo.

    SyncBoDescriptorFacade descriptorFacade =
           SmartSyncRuntime.getInstance().getSyncBoDescriptorFacade();
    SyncBoDescriptor boDes = descriptorFacade.getSyncBoDescriptor("Name");
    RowDescriptor Tow = boDes.getTopRowDescriptor();
  

Version:
2.1
Author:
SAP

Method Summary
 RowDescriptorIterator getAllRowDescriptors()
          Returns all child rows' RowDescriptor iterator.
 RelationDescriptorIterator getDependencyRelations()
          Returns all dependency relations on other SyncBOs.
 int getPosition(RowDescriptor row)
          Returns the position of a RowDescriptor within the SyncBoDescriptor RowDescriptors are stored in a sequence, which can be represented by int values.
 RowDescriptor getRowDescriptor(java.lang.String rowName)
          Returns the RowDescriptor for the specified child row name.
 int getRowDescriptorCount()
          Returns the number of RowDescriptor objects which belongs to this SyncBoDescriptor
 java.lang.String getSyncBoName()
          Returns the name of the SyncBo object defined by this SyncBoDescriptor.
 SyncProcessingType getSyncProcessing()
          Returns SyncProcessingType instance of this SyncBoDescriptor
 RowDescriptor getTopRowDescriptor()
          Returns this SyncBoDescriptor's TOP row RowDescriptor instance.
 int getVersionUid()
          Returns the unique version id of this SyncBoDescriptor
 boolean isAllowedCreate()
          Returns the permission value if the SyncBo defined by this SyncBoDescriptor is allowed to be inserted into the repository.
 boolean isAllowedDelete()
          Returns the permission value if the SyncBo defined by this SyncBoDescriptor is allowed to be deleted from the repository.
 boolean isAllowedModify()
          Returns the permission value if the SyncBo defined by this SyncBoDescriptor is allowed to be modified.
 boolean isMultiLangSupport()
          Returns the attribute value if the SyncBo defined by this SyncBoDescriptor supports multiple languages
 boolean isRequiredDirectSync()
          Returns the flag whether a direct synchronization is required for the SyncBo
 

Method Detail

getSyncBoName

public java.lang.String getSyncBoName()
Returns the name of the SyncBo object defined by this SyncBoDescriptor. For example, "customer order".

Returns:
the name of the SyncBo object defined by this SyncBoDescriptor

getSyncProcessing

public SyncProcessingType getSyncProcessing()
Returns SyncProcessingType instance of this SyncBoDescriptor

Returns:
SyncProcessingType

getTopRowDescriptor

public RowDescriptor getTopRowDescriptor()
Returns this SyncBoDescriptor's TOP row RowDescriptor instance.

Returns:
the RowDescriptor of the TOP row.
See Also:
RowDescriptor

getRowDescriptor

public RowDescriptor getRowDescriptor(java.lang.String rowName)
Returns the RowDescriptor for the specified child row name.

Returns:
the RowDescriptor for the specified child row name
See Also:
RowDescriptor

getAllRowDescriptors

public RowDescriptorIterator getAllRowDescriptors()
Returns all child rows' RowDescriptor iterator.

Returns:
the RowDescriptorIterator instance for all the defined child rows' RowDescriptor

isRequiredDirectSync

public boolean isRequiredDirectSync()
Returns the flag whether a direct synchronization is required for the SyncBo

Returns:
true if direct synchronization is required, otherwise false

isAllowedCreate

public boolean isAllowedCreate()
Returns the permission value if the SyncBo defined by this SyncBoDescriptor is allowed to be inserted into the repository.

Returns:
true if the SyncBo of this SyncBoDescriptor can be inserted; otherwise false

isAllowedModify

public boolean isAllowedModify()
Returns the permission value if the SyncBo defined by this SyncBoDescriptor is allowed to be modified. The following operations are considered as SyncBo modify operations:
  • top row or existing child row's field value updates
  • new child row insertion
  • existing child row replace
  • existing child row delete
    NOTE:
    On SP2, the treatment of SyncBo objects differs according to their status. This permission flag is not checked for any modify operations performed on the SyncBo objects of status LOCAL, UNLINKED and INITIAL. Thus the application has the freedom to manipulate the SyncBo prior to any further data-related operations or data synchronization.
    On the other hand, the modify permission is checked for SyncBo with the GLOBAL or IN_SYNC status, except for the cases even though the allowModify attribute is false.
  • field value update of any child rows with a LOCAL status.
  • removal/delete of a child row with a LOCAL status.
  • Returns:
    true if the SyncBo of this SyncBoDescriptor can be modified; otherwise false

  • isAllowedDelete

    public boolean isAllowedDelete()
    Returns the permission value if the SyncBo defined by this SyncBoDescriptor is allowed to be deleted from the repository.

    Returns:
    true if the SyncBo of this SyncBoDescriptor can be deleted; otherwise false

    isMultiLangSupport

    public boolean isMultiLangSupport()
    Returns the attribute value if the SyncBo defined by this SyncBoDescriptor supports multiple languages

    Returns:
    true if the SyncBo of this SyncBoDescriptor supports multiple languages; otherwise false

    getDependencyRelations

    public RelationDescriptorIterator getDependencyRelations()
    Returns all dependency relations on other SyncBOs. Dependencies exist due to foreign key relationships.
    For example, if the SyncBO "customer order" has a foreign key for "customer master", then "customer order" has a dependency on "customer master". However, not all foreign key relationships imply dependency; dependency only exists if the foreign key is necessary to successfully post SyncBOs in the backend.

    Returns:
    the RelationDescriptorIterator of all the dependencies of the SyncBo defined by this SyncBoDescriptor on other SyncBos

    getVersionUid

    public int getVersionUid()
    Returns the unique version id of this SyncBoDescriptor

    Returns:
    the unique version id of this SyncBoDescriptor

    getPosition

    public int getPosition(RowDescriptor row)
    Returns the position of a RowDescriptor within the SyncBoDescriptor RowDescriptors are stored in a sequence, which can be represented by int values. Example: SyncBo "Customer" contains 3 RowDescriptors in following sequence: TOP, 010, 020 The positons would be: TOP = 0, 010 = 1, 020 = 2

    Parameters:
    row - Description of the Parameter
    Returns:
    The position of the RowDescriptor within this SyncBoDescriptor or -1 if it is not a part of this SyncBoDescriptor

    getRowDescriptorCount

    public int getRowDescriptorCount()
    Returns the number of RowDescriptor objects which belongs to this SyncBoDescriptor

    Returns:


    Copyright © 2005 SAP AG. All Rights Reserved.