com.adobe.idp.um.api.infomodel
Class DirectorySyncInfo

java.lang.Object
  com.adobe.idp.um.api.infomodel.DirectorySyncInfo

All Implemented Interfaces:

java.io.Serializable

public class DirectorySyncInfo
extends java.lang.Object
implements java.io.Serializable

Provides information about the directory synchronization process. When you programmatically synchronize users, you can use an instance of this type to determine the synchronization status. To see an object of this type used in a code example, see the Programmatically synchronizing users using the Java API quick start in Programming with LiveCycle ES4.

See Also:

Serialized Form

Field Summary

static int	SYNCSTATUS_ABORTED Synchronization was aborted.
static int	SYNCSTATUS_COMPLETED Synchronization is complete.
static int	SYNCSTATUS_INPROGRESS Synchronization is currently in progress.
static int	SYNCSTATUS_SCHEDULED Synchronization has been scheduled.
static int	SYNCSTATUS_UNKNOWN Unknown synchronization status.

Constructor Summary

DirectorySyncInfo(java.lang.String state, int syncStatus, java.util.Date date, int epochMajor)
Constructor that creates a synchronization information object.

Method Summary

int	getEpochMajor() Retrieves the major epoch.
java.util.Date	getLastSyncTime() Retrieves the last synchronization time.
java.lang.String	getSyncState() Retrieves the synchronization state.
int	getSyncStatus() Retrieves the synchronization status.
void	setEpochMajor(int epochMajor) Sets the major epoch.
void	setLastSyncTime(java.util.Date lastSyncTime) Sets the last synchronization time.
void	setSyncState(java.lang.String syncState) Sets the synchronization state.
void	setSyncStatus(int lastStatus) Sets the synchronization status.

Methods inherited from class java.lang.Object

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

Field Detail

SYNCSTATUS_UNKNOWN

public static final int SYNCSTATUS_UNKNOWN

Unknown synchronization status.

See Also:

Constant Field Values

SYNCSTATUS_COMPLETED

public static final int SYNCSTATUS_COMPLETED

Synchronization is complete.

See Also:

Constant Field Values

SYNCSTATUS_SCHEDULED

public static final int SYNCSTATUS_SCHEDULED

Synchronization has been scheduled.

See Also:

Constant Field Values

SYNCSTATUS_INPROGRESS

public static final int SYNCSTATUS_INPROGRESS

Synchronization is currently in progress.

See Also:

Constant Field Values

SYNCSTATUS_ABORTED

public static final int SYNCSTATUS_ABORTED

Synchronization was aborted.

See Also:

Constant Field Values

Constructor Detail

DirectorySyncInfo

public DirectorySyncInfo(java.lang.String state,
                         int syncStatus,
                         java.util.Date date,
                         int epochMajor)

Constructor that creates a synchronization information object.

Parameters:

state - The synchronization state.

syncStatus - The synchronization status.

date - The date.

epochMajor - The major epoch.

Method Detail

getSyncState

public java.lang.String getSyncState()

Retrieves the synchronization state.

Returns:

A string value that specifies the synchronization state.

setSyncState

public void setSyncState(java.lang.String syncState)

Sets the synchronization state.

Parameters:

syncState - A string value that specifies the synchronization state.

getLastSyncTime

public java.util.Date getLastSyncTime()

Retrieves the last synchronization time.

Returns:

A java.util.Date object that specifies the last synchronization time.

setLastSyncTime

public void setLastSyncTime(java.util.Date lastSyncTime)

Sets the last synchronization time.

Parameters:

lastSyncTime - A java.util.Date object that specifies the last synchronization time.

getEpochMajor

public int getEpochMajor()

Retrieves the major epoch.

Returns:

An integer value that specifies the major epoch.

setEpochMajor

public void setEpochMajor(int epochMajor)

Sets the major epoch.

Parameters:

epochMajor - An integer value that specifies the major epoch.

getSyncStatus

public int getSyncStatus()

Retrieves the synchronization status. To see this method is a code example, see the Programmatically synchronizing users using the Java API quick start in Programming with LiveCycle ES4.

Returns:

An integer value that specifies the synchronization status.

setSyncStatus

public void setSyncStatus(int lastStatus)

Sets the synchronization status.

Parameters:

lastStatus - An integer value that specifies the synchronization status.