Packagecom.adobe.idp.um.api.infomodel
Interfacepublic interface PrincipalReference

This class contains reference information for a Principal. A principal contains a union of information found in a User and a Group.


Public Methods
 MethodDefined By
  
String getCanonicalName()
Retrieves the canonical name of this principal.
PrincipalReference
  
String getCommonName()
Retrieves the common (display) name of this principal.
PrincipalReference
  
String getDomainCommonName()
Retrieves the common (display) name of the domain associated with this principal.
PrincipalReference
  
String getDomainName()
Retrieves the canonical name of the domain associated with this principal.
PrincipalReference
  
String getEmail()
Retrieves the primary email identifier associated with this principal.
PrincipalReference
  
String getOid()
Retrieves the principal identifier.
PrincipalReference
  
String getOrg()
Retrieves the organization to which the principal belongs.
PrincipalReference
  
String getPrincipalType()
Retrieves the principal type.
PrincipalReference
  
String getStatus()
Retrieves the principal's status.
PrincipalReference
  
int getVisibility()
Retrieves the visibility level of the Principal.
PrincipalReference
  
boolean isSystem()
Determines whether this is a system principal.
PrincipalReference
  
void setCanonicalName(String canonicalName)
Sets the principal's canonical name.
PrincipalReference
  
void setCommonName(String commonName)
Sets the principal's common name.
PrincipalReference
  
void setDomainName(String domainName)
Sets the principal's domain name.
PrincipalReference
  
void setEmail(String email)
Sets the principal's email identifier.
PrincipalReference
  
void setOid(String oid)
Sets the principal's identifier.
PrincipalReference
  
void setOrg(String org)
Sets the principal's organization.
PrincipalReference
  
void setPrincipalType(String principalType)
Sets the principal's type.
PrincipalReference
  
void setStatus(String status)
Sets the principal's status.
PrincipalReference
Public Constants
 ConstantDefined By
  PRINCIPALTYPE_GROUP
[static] Group principal type.
PrincipalReference
  PRINCIPALTYPE_SERVICE
[static] Service principal type.
PrincipalReference
  PRINCIPALTYPE_SPECIAL
[static] Do not use.
PrincipalReference
  PRINCIPALTYPE_SYSTEM
[static] System principal type.
PrincipalReference
  PRINCIPALTYPE_USER
[static] User principal type.
PrincipalReference
  STATUS_CURRENT
[static] The principal is current (active in the system).
PrincipalReference
  STATUS_OBSOLETE
[static] The principal is obsolete (deleted from the system).
PrincipalReference
Method Detail
getCanonicalName()
public String getCanonicalName()

Retrieves the canonical name of this principal. This string is unique within the scope of the domain. Thus the pair {getCanonicalName(), getDomainName()} uniquely identifies the principal.

Returns
The canonical name of this principal.

Example
How to use examples
"uid=doe,ou=People,o=adobe.com"
getCommonName() 
public String getCommonName()

Retrieves the common (display) name of this principal.

Returns
The common (display) name of this principal.

Example
How to use examples
"John Doe"
getDomainCommonName() 
public String getDomainCommonName()

Retrieves the common (display) name of the domain associated with this principal.

Returns
The common (display) name of the domain associated with this principal.

Example
How to use examples
"Adobe Systems"
getDomainName() 
public String getDomainName()

Retrieves the canonical name of the domain associated with this principal.

Returns
The canonical name of the domain associated with this principal.

Example
How to use examples
"adobe.com"
getEmail() 
public String getEmail()

Retrieves the primary email identifier associated with this principal.

Returns
The primary email identifier associated with this principal.

Example
How to use examples
"doe@adobe.com"
getOid() 
public String getOid()

Retrieves the principal identifier.

Returns
The principal identifier.
getOrg() 
public String getOrg()

Retrieves the organization to which the principal belongs.

Returns
The organization to which the principal belongs.

Example
How to use examples
"Adobe"
getPrincipalType() 
public String getPrincipalType()

Retrieves the principal type.

Returns
The principal type.
getStatus() 
public String getStatus()

Retrieves the principal's status.

Returns
The principal's status.
getVisibility() 
public int getVisibility()

Retrieves the visibility level of the Principal. INVISIBLE : The principal is invisible. value: 0 SEARCHES : The principal can be found with searches. value:1 GUI : The principal can appear in the user interface. value: 2

Returns
The visibility level of the Principal.
isSystem() 
public boolean isSystem()

Determines whether this is a system principal.

Returns
true if this is a system principal, false otherwise.
setCanonicalName() 
public void setCanonicalName(String canonicalName)

Sets the principal's canonical name.

Parameters

canonicalName — The principal's canonical name.

setCommonName() 
public void setCommonName(String commonName)

Sets the principal's common name.

Parameters

commonName — The principal's common name.

setDomainName() 
public void setDomainName(String domainName)

Sets the principal's domain name.

Parameters

domainName — The principal's domain name.

setEmail() 
public void setEmail(String email)

Sets the principal's email identifier.

Parameters

email — The principal's email identifier.

setOid() 
public void setOid(String oid)

Sets the principal's identifier.

Parameters

oid — The principal's identifier.

setOrg() 
public void setOrg(String org)

Sets the principal's organization.

Parameters

org — The principal's organization.

setPrincipalType() 
public void setPrincipalType(String principalType)

Sets the principal's type.

Parameters

principalType — The principal's type.

setStatus() 
public void setStatus(String status)

Sets the principal's status.

Parameters

status — The principal's status.

Constant Detail
PRINCIPALTYPE_GROUPConstant
public static final PRINCIPALTYPE_GROUP

Group principal type.

PRINCIPALTYPE_SERVICEConstant 
public static final PRINCIPALTYPE_SERVICE

Service principal type. Service accounts are for services that are expected to run continually.

PRINCIPALTYPE_SPECIALConstant 
public static final PRINCIPALTYPE_SPECIAL
Deprecated: Use PRINCIPALTYPE_SYSTEM or PRINCIPALTYPE_SERVICE instead.

Do not use.

PRINCIPALTYPE_SYSTEMConstant 
public static final PRINCIPALTYPE_SYSTEM

System principal type. The system type can be used for hidden accounts that will not run as a service.

PRINCIPALTYPE_USERConstant 
public static final PRINCIPALTYPE_USER

User principal type.

STATUS_CURRENTConstant 
public static final STATUS_CURRENT

The principal is current (active in the system).

STATUS_OBSOLETEConstant 
public static final STATUS_OBSOLETE

The principal is obsolete (deleted from the system).




© 2004-2008 Adobe Systems Incorporated. All rights reserved.
Wed Oct 1 2008, 10:46 PM -04:00

 

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

Current page: http://livedocs.adobe.com/livecycle/8.2/programLC/programmer/javadoc/com/adobe/idp/um/api/infomodel/PrincipalReference.html