|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface User
The User interface serves as a common interface for the user related information.
Method Summary | |
---|---|
void |
addTelephoneNumber(TelephoneNumber telephoneNumber,
java.lang.String telephoneTypeId)
Deprecated. |
boolean |
canCreateAsset(Organization organization)
Check if the user has privilege to create an asset instance in the given organization. |
boolean |
canDelete(CentraSiteObject centraSiteObject)
Check if the user has privilege to delete the given RegistryObject. |
boolean |
canModify(CentraSiteRegistryObject centraSiteRegistryObject)
Check if the user has privilege to modify the given CentraSiteRegistryObject . |
java.lang.String |
getAvatar()
Get the profile picture's URL of the current user. |
CentraSiteRepositoryFolder |
getDefaultRepositoryFolder()
Get the repository location of the user. |
java.lang.String |
getDisplayName()
Returns the Display Name of the current user. |
java.util.Collection<java.lang.String> |
getEmailAddresses()
Get the collection of email addresses for the current user. |
java.lang.String |
getFirstName()
Get First Name of the current user. |
java.lang.String |
getLastName()
Get Last Name of the current user. |
java.lang.String |
getMiddleName()
Get Middle Name of the current user. |
java.util.Collection<Organization> |
getOrganizations()
Get all organizations this user belongs to. |
java.util.Collection<PostalAddress> |
getPostalAddress()
Get the Postal Addresses for the user. |
java.util.Collection<TelephoneNumber> |
getTelephoneNumbers(java.lang.String phoneType)
Get the collection of telephone numbers for the current user. |
UserPreferences |
getUserPreferences()
Return UserPreferences of this user. |
boolean |
isActive()
Whether current user is active or inactive |
boolean |
isCentraSiteAdministrator()
Checks whether this user has CSA role. |
boolean |
isGuest()
Check if the user is a guest. |
void |
setAvatar(java.io.InputStream inputStreamOfImage)
Upload the given image as the profile picture of the current user. |
void |
setEmailAddresses(java.util.Collection<java.lang.String> emailAddresses)
Sets the given collection of email addresses to the current user. |
void |
setFirstName(java.lang.String firstName)
Sets First Name for the current user. |
void |
setLastName(java.lang.String lastName)
Sets Last Name for the current user. |
void |
setMiddleName(java.lang.String middleName)
Sets Middle Name for the current user. |
void |
setTelephoneNumbers(java.util.Collection<TelephoneNumber> telephoneNumbers)
Sets the given collection of telephone numbers to the user |
Methods inherited from interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject |
---|
getConsumers, getDescription, getDescription, getDisplayVersion, getLCMAssignment, getLocalName, getMandatoryAttributeProfiles, getName, getName, getNameSpace, getNextVersion, getNextVersions, getOrganization, getOwner, getPreviousVersion, getPreviousVersions, getRegistryObject, getSubscribers, getSystemVersion, getUserVersion, getVisiblePrimaryProfiles, isLatestVersionObject, setDescription, setDescription, setDisplayVersion, setLCMState, setLocalName, setName, setName, setNameSpace, setOrganization, setOwner, setUserVersion |
Methods inherited from interface com.softwareag.centrasite.api.csom.CentraSiteObject |
---|
delete, getAttributeLink, getAttributeValue, getAttributeValue, getAttributeValue, getId, getType, isModified, isReadOnly, save, setAttributeValue, setAttributeValue, setAttributeValue |
Method Detail |
---|
java.lang.String getFirstName() throws CLLException
CLLException
- if CLL fails to return the user's First Namevoid setFirstName(java.lang.String firstName) throws CLLException
firstName
- First Name to be set for the user
CLLException
- if CLL fails to set the First Name for the userjava.lang.String getMiddleName() throws CLLException
CLLException
- if CLL fails to return the user's Middle Namevoid setMiddleName(java.lang.String middleName) throws CLLException
middleName
- Middle Name to be set for the user
CLLException
- if CLL fails to set the Middle Name for the userjava.lang.String getLastName() throws CLLException
CLLException
- if CLL fails to return the user's Last Namevoid setLastName(java.lang.String lastName) throws CLLException
lastName
- Last Name to be set for the user
CLLException
- if CLL fails to set the Last Name for the userjava.lang.String getDisplayName() throws CLLException
CLLException
- if CLL fails to return the user's Display Namejava.util.Collection<java.lang.String> getEmailAddresses() throws CLLException
CLLException
- if CLL fails to return the user's email addressesvoid setEmailAddresses(java.util.Collection<java.lang.String> emailAddresses) throws CLLException
emailAddresses
- Collection of email addresses to be set for the user
CLLException
- if CLL fails to set the given collection of email addresses to the userboolean isActive() throws CLLException
CLLException
- if CLL fails to return if the user is active or inactive@Deprecated void addTelephoneNumber(TelephoneNumber telephoneNumber, java.lang.String telephoneTypeId) throws CLLException
User.setTelephoneNumbers(Collection)
instead of this method
telephoneNumber
- Telephone numbertelephoneTypeId
- Phone-type categoryId
CLLException
- if CLL fails to add the given telephone number to the user.void setTelephoneNumbers(java.util.Collection<TelephoneNumber> telephoneNumbers) throws CLLException
telephoneNumbers
- a collection of TelephoneNumber
CLLException
- if CLL fails to add the given telephone number to the user.java.util.Collection<TelephoneNumber> getTelephoneNumbers(java.lang.String phoneType) throws CLLException
phoneType
-
CLLException
- if CLL fails to return the user's telephone numbersjava.util.Collection<Organization> getOrganizations() throws CLLException
CLLException
- if CLL fails to return the list of organizationsjava.util.Collection<PostalAddress> getPostalAddress() throws CLLException
CLLException
- if CLL fails to return the user's postal addressesboolean canModify(CentraSiteRegistryObject centraSiteRegistryObject) throws CLLException
CentraSiteRegistryObject
.
centraSiteRegistryObject
- CentraSite object to be verified
CLLException
- if CLL fails to verify the user's permission settingsboolean canDelete(CentraSiteObject centraSiteObject) throws CLLException
centraSiteObject
- CentraSiteObject
CLLException
- if CLL fails to verify the user's permission settingsboolean isCentraSiteAdministrator() throws com.softwareag.security.jaas.principals.SagGeneralSecurityException, javax.xml.registry.JAXRException
com.softwareag.security.jaas.principals.SagGeneralSecurityException
javax.xml.registry.JAXRException
boolean canCreateAsset(Organization organization) throws CLLException
organization
- Organization
.
CLLException
- if CLL fails to verify the user's permission settingsboolean isGuest() throws CLLException
CLLException
- if CLL fails to check if the user is a guestUserPreferences getUserPreferences() throws CLLException
UserPreferences
of this user.
UserPreferences
CLLException
- if CLL fails to get the UserPreferences
void setAvatar(java.io.InputStream inputStreamOfImage) throws CLLException
inputStreamOfImage
- Profile picture as InputStream
CLLException
- if CLL fails to upload the profile picturejava.lang.String getAvatar() throws CLLException
String
CLLException
- if CLL fails to return the profile picture's URLCentraSiteRepositoryFolder getDefaultRepositoryFolder() throws CLLException
CLLException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |