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

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

public final class StatusType
extends java.lang.Object

An enumeration of possible status types of the repository objects (SyncBo or Row). It can be assigned to either a SyncBo instance or a Row instance.

Since:
2.1
Author:
SAP
See Also:
SyncBo, Row, ProcessingStatusType, PositionStatusType

Field Summary
static StatusType GLOBAL
          Represents the global state of the object's status.
static StatusType IN_SYNC
          Represents an object's state indicating that the object is the synchronization with the data in the backend database.
static StatusType INITIAL
          Represents the initial state of the object's status.
static StatusType LOCAL
          Represents the local state of the object's status.
static StatusType UNLINKED
          Represents the unlinked state of the object's status.
 
Method Summary
 boolean canBeDeleted()
          Deprecated.  
 boolean canBeInserted()
          Deprecated.  
 boolean canReplace()
          Deprecated.  
static StatusType forString(java.lang.String string)
          Returns the correspnoding StatusType instance with the specified String representation.
 boolean isInitialized()
          Deprecated.  
 boolean isLinked()
          Returns the boolean flag indicating whether the object is linked to the repository or not.
 java.lang.String toString()
          Returns the string representation of this StatusType.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

INITIAL

public static final StatusType INITIAL
Represents the initial state of the object's status. Initial status implies:
  • that the object is not yet a part of the repository and could only be added thru their correspoding insert methods.
  • that the object's SyncKey is unassigned. It will be assigned a unique SyncKey value upon its insertion into the repository.


  • UNLINKED

    public static final StatusType UNLINKED
    Represents the unlinked state of the object's status. Unlinked status implies:
  • that the object is not yet a part of the repository and could only be added thru their correspoding replace methods.
  • that the object's SyncKey value is the same with the original where it was cloned from. The updates/changes in the object will be reflected to the original SyncBo upon its replacement.


  • LOCAL

    public static final StatusType LOCAL
    Represents the local state of the object's status. Local status implies:
  • that the object is a part of the local repository.
  • that accessible and modifiable without lesser plausibility checks
  • that it is assigned a read-only globally unique SyncKey
  • that it is not yet uploaded in to the backend database


  • IN_SYNC

    public static final StatusType IN_SYNC
    Represents an object's state indicating that the object is the synchronization with the data in the backend database. In_Sync status implies:
  • that the object and its elements are in the process of being synchronized with that in the backend.
  • that its former state could only either Local or Global.
  • that it is locked for any modifications locally in version 2.1.


  • GLOBAL

    public static final StatusType GLOBAL
    Represents the global state of the object's status. Global status implies:
  • that the object has a corresponding copy ot itself in the backend.
  • that it is accessible and is modifiable with a higher level of modify permission tests imposed as compared to the Local status.

  • Method Detail

    forString

    public static StatusType forString(java.lang.String string)
    Returns the correspnoding StatusType instance with the specified String representation.

    Parameters:
    string - the specified String representation.
    - "I" for StatusType.INITIAL
    - "U" for StatusType.UNLINKED
    - "L" for StatusType.LOCAL
    - "G" for StatusType.GLOBAL
    - "S" for StatusType.IN_SYNC
    Returns:
    the correspnoding StatusType instance

    isInitialized

    public boolean isInitialized()
    Deprecated.  

    Returns the boolean flag indicating whether this instance is initialized or not.

    Returns:
    true if this StatusType has been initialized; otherwise null.

    isLinked

    public boolean isLinked()
    Returns the boolean flag indicating whether the object is linked to the repository or not.

    Returns:
    true if the object is linked with the repository; otherwise false.

    canReplace

    public boolean canReplace()
    Deprecated.  

    Returns the boolean flag indicating whether the object is replaceable or not.

    Returns:
    true if the object is replaceable; otherwise false.

    canBeInserted

    public boolean canBeInserted()
    Deprecated.  

    Returns the boolean flag indicating whether the object is insertable or not.

    Returns:
    true if the object is insertable; otherwise false.

    canBeDeleted

    public boolean canBeDeleted()
    Deprecated.  

    Returns the boolean flag indicating whether the object is removable or not.

    Returns:
    true if the object is removable; otherwise false.

    toString

    public java.lang.String toString()
    Returns the string representation of this StatusType.

    Returns:
    the string representation of this StatusType


    Copyright © 2005 SAP AG. All Rights Reserved.