Package com.adobe.idp.um.api.infomodel
Interfacepublic interface Domain

This is the interface containing domain information.



Public Methods
 MethodDefined by
  
Retrieves the domain's common name.
Domain
  
String getDomainName()
Retrieves the domain's canonical name.
Domain
  
String getOid()
Retrieves the domain's identifier.
Domain
  
String getStatus()
Retrieves the domain's status.
Domain
  
String getSyncState()
Retrieves the domain's synchronization state.
Domain
  
Retrieves the domain's visibility.
Domain
  
Determines whether account locking is enabled.
Domain
  
boolean isLocal()
Determines whether the domain is local.
Domain
  
void setAccountLocking(boolean accountLocking)
Enables or disables the domain's account locking.
Domain
  
void setDomainCommonName(String domainCommonName)
Sets the domain's commmon name.
Domain
  
void setVisibility(int visibility)
Sets the domain's visibility.
Domain
Public Constants
 ConstantDefined by
  STATUS_CURRENT
[static] The domain is current.
Domain
  STATUS_OBSOLETE
[static] The domain is obsolete.
Domain
  STATUS_PRE_OBSOLETE
[static] Domains can have a pre-obsolete state if the directory synchronization process has not yet completely marked them as obsolete.
Domain
Method Detail
getDomainCommonName()
public String getDomainCommonName()

Retrieves the domain's common name.

Returns
The domain's common name.
getDomainName() 
public String getDomainName()

Retrieves the domain's canonical name.

Returns
The domain's canonical name.
getOid() 
public String getOid()

Retrieves the domain's identifier.

Returns
The domain's identifier.
getStatus() 
public String getStatus()

Retrieves the domain's status.

Returns
The domain's status.
getSyncState() 
public String getSyncState()

Retrieves the domain's synchronization state.

Returns
The domain's synchronization state.
getVisibility() 
public int getVisibility()

Retrieves the domain's visibility.

Returns
The domain's visibility.
isAccountLockingEnabled() 
public boolean isAccountLockingEnabled()

Determines whether account locking is enabled.

Returns
true if account locking is enabled, false otherwise.
isLocal() 
public boolean isLocal()

Determines whether the domain is local.

Returns
true if the domain is local, false otherwise.
setAccountLocking() 
public void setAccountLocking(boolean accountLocking)

Enables or disables the domain's account locking.

Parameters

accountLockingtrue if account locking is enabled, false otherwise.

setDomainCommonName() 
public void setDomainCommonName(String domainCommonName)

Sets the domain's commmon name.

Parameters

domainCommonName — domain's commmon name.

setVisibility() 
public void setVisibility(int visibility)

Sets the domain's visibility.

Parameters

visibility — The domain's visibility.

Constant Detail
STATUS_CURRENTConstant
public static final STATUS_CURRENT

The domain is current.

STATUS_OBSOLETEConstant 
public static final STATUS_OBSOLETE

The domain is obsolete.

STATUS_PRE_OBSOLETEConstant 
public static final 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.





 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/programmer/javadoc/com/adobe/idp/um/api/infomodel/Domain.html