|
Collaboration API Documentation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.filenet.bso.api.collaboration.data.SubjectInfo
The SubjectInfo
class is a collection of data about a specific user or group.
Field Summary | |
static java.lang.String |
DISPLAYNAME_SYMNAME
Value of "DisplayName"; Content Engine property. |
static java.lang.String |
DISTINGUISHEDNAME_SYMNAME
Value of "DistinguishedName"; Content Engine property. |
static java.lang.String[] |
GROUP_PROPERTIES
String array of persistent Group properties. |
static java.lang.String |
GROUPS_SYMNAME
Value of "Groups"; Content Engine property. |
static java.lang.String |
MEMBEROFGROUPS_SYMNAME
Value of "MemberOfGroups"; Content Engine property. |
static java.lang.String |
NAME_SYMNAME
Value of "Name"; Content Engine property. |
static java.lang.String |
SHORTNAME_SYMNAME
Value of "ShortName"; Content Engine property. |
static java.lang.String[] |
USER_PROPERTIES
String array of persistent User properties. |
static java.lang.String |
USERS_SYMNAME
Value of "Users"; Content Engine property. |
Constructor Summary | |
protected |
SubjectInfo()
|
|
SubjectInfo(com.filenet.wcm.api.SecurityGrantee subject,
filenet.vw.api.VWSession vwSession)
|
|
SubjectInfo(java.lang.String subjectID,
int subjectType,
java.lang.String displayName,
java.lang.String shortName,
java.lang.String domainName,
java.lang.String emailAddress)
|
|
SubjectInfo(java.lang.String subjectID,
int subjectType,
java.lang.String displayName,
java.lang.String shortName,
java.lang.String domainName,
filenet.vw.api.VWSession vwSession)
|
|
SubjectInfo(java.lang.String subjectID,
java.lang.String displayName,
java.lang.String emailAddress)
|
Method Summary | |
boolean |
equals(java.lang.Object obj)
Verify the object properties match. |
java.lang.String |
getDisplayName()
Returns the display name of the subject. |
java.lang.String |
getDomainName()
Returns the full domain name of the subject. |
java.lang.String |
getEmailAddress()
Returns the email address as configured in VWUserInfo. |
java.lang.String |
getID()
Returns the subject ID. |
java.lang.String |
getShortName()
Returns the short name of the subject. |
int |
getType()
Returns the type of subject (TYPE_USER or TYPE_GROUP). |
boolean |
isEnterpriseUser()
|
boolean |
isUser()
|
void |
setEmailAddress(java.lang.String emailAddress)
Sets a user's email address, precluding the retrieval of an address from the P8 LDAP. |
void |
setLastException(BsoRuntimeException ex)
|
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final java.lang.String DISPLAYNAME_SYMNAME
public static final java.lang.String DISTINGUISHEDNAME_SYMNAME
public static final java.lang.String GROUPS_SYMNAME
public static final java.lang.String MEMBEROFGROUPS_SYMNAME
public static final java.lang.String NAME_SYMNAME
public static final java.lang.String SHORTNAME_SYMNAME
public static final java.lang.String USERS_SYMNAME
public static final java.lang.String[] USER_PROPERTIES
public static final java.lang.String[] GROUP_PROPERTIES
Constructor Detail |
protected SubjectInfo()
public SubjectInfo(com.filenet.wcm.api.SecurityGrantee subject, filenet.vw.api.VWSession vwSession)
public SubjectInfo(java.lang.String subjectID, int subjectType, java.lang.String displayName, java.lang.String shortName, java.lang.String domainName, java.lang.String emailAddress)
public SubjectInfo(java.lang.String subjectID, java.lang.String displayName, java.lang.String emailAddress)
public SubjectInfo(java.lang.String subjectID, int subjectType, java.lang.String displayName, java.lang.String shortName, java.lang.String domainName, filenet.vw.api.VWSession vwSession)
Method Detail |
public java.lang.String getID()
String
containing the subject ID.public java.lang.String getDomainName()
String
containing the full domain name of the subject.public java.lang.String getDisplayName()
String
containing the display name of the subject.public java.lang.String getShortName()
String
containing the short name of the subject.public java.lang.String getEmailAddress()
String
containing the email address of the user.public void setEmailAddress(java.lang.String emailAddress)
emailAddress
- Email address to be used for email notifications.
Throws an exception if the emailAddress is empty.public int getType()
int
value that specifies subject type.public boolean isUser()
public boolean isEnterpriseUser()
public void setLastException(BsoRuntimeException ex)
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
obj
- must be of type SubjectInfo
or objects cannot match.public java.lang.String toString()
toString
in class java.lang.Object
|
Collaboration API Documentation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |