com.adobe.idp.um.api.infomodel
Interface Domain

public interface Domain

Contains domain information related to LiveCycle ES2 users and groups. Using an instance of this type, you can determine information such as the domain to which a LiveCycle ES2 user belongs. To see an object of this type used in a code example, see the Managing users and groups using the Java API quick start in Programming with LiveCycle ES3.

Nested Class Summary

static class

Domain.DomainNameComprator A static class used to compare domains.

Field Summary

static String	STATUS_CURRENT The domain is current.
static String	STATUS_OBSOLETE The domain is obsolete.
static String	STATUS_PRE_OBSOLETE Domains can have a pre-obsolete state if the directory synchronization process has not yet completely marked them as obsolete.

Method Summary

String	getDomainCommonName() Retrieves the domain's common name.
String	getDomainName() Retrieves the domain's canonical name.
int	getDomainSubtype() Retrieves the subtype of the domain.
String	getOid() Retrieves the domain's identifier.
String	getStatus() Retrieves the domain's status.
String	getSyncState() Retrieves the domain's synchronization state.
int	getVisibility() Retrieves the domain's visibility.
boolean	isAccountLockingEnabled() Determines whether account locking is enabled.
boolean	isLocal() Determines whether the domain is local.
void	setAccountLocking(boolean accountLocking) Enables or disables the domain's account locking.
void	setDomainCommonName(String domainCommonName) Sets the domain's common name.
void	setVisibility(int visibility) Sets the domain's visibility.

Field Detail

STATUS_CURRENT

static final String STATUS_CURRENT

The domain is current.

STATUS_PRE_OBSOLETE

static final String STATUS_PRE_OBSOLETE

Domains can have a pre-obsolete state if the directory synchronization process has not yet completely marked them as obsolete. You may also use if (! STATUS_CURRENT) in your application code instead.

STATUS_OBSOLETE

static final String STATUS_OBSOLETE

The domain is obsolete.

Method Detail

getDomainCommonName

String getDomainCommonName()

Retrieves the domain's common name.

Returns:

The domain's common name.

getDomainName

String getDomainName()

Retrieves the domain's canonical name. To see this method used in a code example, see the Managing users and groups using the Java API quick start in Programming with LiveCycle ES3.

Returns:

The domain's canonical name.

isLocal

boolean isLocal()

Determines whether the domain is local.

Returns:

The value true if the domain is local, false otherwise.

getOid

String getOid()

Retrieves the domain's identifier.

Returns:

The domain's identifier.

isAccountLockingEnabled

boolean isAccountLockingEnabled()

Determines whether account locking is enabled.

Returns:

The value true if account locking is enabled, false otherwise.

getVisibility

int getVisibility()

Retrieves the domain's visibility.

Returns:

The domain's visibility.

setVisibility

void setVisibility(int visibility)

Sets the domain's visibility.

Parameters:

visibility - The domain's visibility.

setAccountLocking

void setAccountLocking(boolean accountLocking)

Enables or disables the domain's account locking.

Parameters:

accountLocking - The value true if account locking is enabled, false otherwise.

getStatus

String getStatus()

Retrieves the domain's status. The value STATUS_OBSOLETE is returned if the domain is obsolete.

Returns:

A string value that specifies the domain's status.

getSyncState

String getSyncState()

Retrieves the domain's synchronization state.

Returns:

A string value that specifies the domain's synchronization state.

setDomainCommonName

void setDomainCommonName(String domainCommonName)

Sets the domain's common name.

Parameters:

The - domain's common name.

getDomainSubtype

int getDomainSubtype()

Retrieves the subtype of the domain.

Returns:

An integer value that specifies the subtype of the domain.