wt.federation
Class ProxyUser

java.lang.Object
  wt.fc.WTObject
      wt.fc.Item
          wt.org.WTPrincipal
              wt.org.WTUser
                  wt.federation.ProxyUser

All Implemented Interfaces:

Externalizable, Serializable, Principal, AccessControlled, wt.access.AccessControlList, wt.access.AdHocControlled, wt.access.PolicyAccessControlled, wt.access.SecurityLabeled, wt.admin.DomainAdministered, wt.fc.BusinessInformation, NetFactor, ObjectMappable, Persistable, Federated, wt.federation.FederatedLinkHolder, wt.federation.RemotelyLinkable, DisplayIdentification, Notifiable, wt.recent.RecentlyVisited, wt.ufid.Federatable, wt.workflow.notebook.SubjectOfNotebook

public class ProxyUser
extends WTUser
implements Federated, Externalizable

Use the newProxyUser static factory method(s), not the ProxyUser constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

static String	E_MAIL Label for the attribute.
static String	PREFERRED_LANGUAGE Label for the attribute.

Fields inherited from interface wt.federation.Federated

SERVICE_ID

Method Summary

QueryResult	findLinks(Class targetLinkClass, String obj1Role, Persistable obj2) Return all link objects that exist between the Federated object and the specified source object.
String	getEMail() Gets the value of the attribute: E_MAIL.
String	getPreferredLanguage() Gets the value of the attribute: PREFERRED_LANGUAGE.
FederatedService	getService() Return the service object referenced by the serviceId attribute.
ServiceIdentifier	getServiceId() Gets the object for the association that plays role: SERVICE_ID.
QueryResult	navigate(String role, Class linkClass, boolean onlyOtherSide) Return objects related to this federated source object given a role and link class.
QueryResult	navigate(String role, QuerySpec criteria, boolean onlyOtherSide) Return objects related to this federated source object given a role and link selection crtieria.
Enumeration	parentGroupNames() Returns an enumeration containing the names of the groups to which the user belongs.
Enumeration	parentGroups() Returns the groups to which the user belongs.
void	postStore() The persistence manager calls this method just after storing the proxy object in the database.
void	prepareForStore() The persistence manager calls this method just before storing the proxy object in the database.
void	preset() This method is called when a proxy object is first created by a service, just after the object is instantiated and its readExternal method has been called to populate its properties from attributes obtained from the remote information source.
void	refresh() Refresh the derived attributes of the object.
void	refreshIfStale() Refresh the derived attributes of the object, but only if the properties are stale.
void	setEMail(String a_EMail) Sets the value of the attribute: E_MAIL.
void	setPreferredLanguage(String a_PreferredLanguage) Sets the value of the attribute: PREFERRED_LANGUAGE.
void	setServiceId(ServiceIdentifier a_ServiceId) Sets the object for the association that plays role: SERVICE_ID.
String	toString() Returns a string representation of the user object.
void	update() Update the derived attributes of the object on the source service.

Methods inherited from class wt.org.WTUser

getBusinessType, initialize, initialize, initialize, initialize, newWTUser, newWTUser, newWTUser, newWTUser, setLocale

Methods inherited from class wt.org.WTPrincipal

getPrincipalDisplayIdentifier

Methods inherited from class wt.fc.WTObject

getDisplayIdentifier, getDisplayIdentity, getDisplayType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

E_MAIL

public static final String E_MAIL

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

PREFERRED_LANGUAGE

public static final String PREFERRED_LANGUAGE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

Method Detail

getEMail

public String getEMail()

Gets the value of the attribute: E_MAIL.

Supported API: true

Overrides:

getEMail in class WTUser

Returns:

String

setEMail

public void setEMail(String a_EMail)

Sets the value of the attribute: E_MAIL.

Supported API: true

Parameters:

a_EMail -

getPreferredLanguage

public String getPreferredLanguage()

Gets the value of the attribute: PREFERRED_LANGUAGE.

Supported API: true

Returns:

String

setPreferredLanguage

public void setPreferredLanguage(String a_PreferredLanguage)
                          throws WTException

Sets the value of the attribute: PREFERRED_LANGUAGE.

Supported API: true

Parameters:

a_PreferredLanguage -

Throws:

WTException

getService

public FederatedService getService()
                            throws wt.federation.FederationServicesException

Return the service object referenced by the serviceId attribute.

Supported API: true

Specified by:

getService in interface Federated

Returns:

FederatedService

Throws:

wt.federation.FederationServicesException

preset

public void preset()
            throws wt.federation.FederationServicesException

This method is called when a proxy object is first created by a service, just after the object is instantiated and its readExternal method has been called to populate its properties from attributes obtained from the remote information source. This method allows the proxy object to do further class-specific initialization.

Supported API: true

Specified by:

preset in interface Federated

Throws:

wt.federation.FederationServicesException

refresh

public void refresh()
             throws wt.federation.FederationServicesException

Refresh the derived attributes of the object.

Supported API: true

Specified by:

refresh in interface Federated

Throws:

wt.federation.FederationServicesException

refreshIfStale

public void refreshIfStale()
                    throws wt.federation.FederationServicesException

Refresh the derived attributes of the object, but only if the properties are stale.

Supported API: true

Specified by:

refreshIfStale in interface Federated

Throws:

wt.federation.FederationServicesException

update

public void update()
            throws wt.federation.FederationServicesException

Update the derived attributes of the object on the source service.

Supported API: true

Specified by:

update in interface Federated

Throws:

wt.federation.FederationServicesException

prepareForStore

public void prepareForStore()
                     throws wt.federation.FederationServicesException

The persistence manager calls this method just before storing the proxy object in the database. This gives the object an opportunity to make associated proxy objects persistent, if necessary.

Supported API: true

Specified by:

prepareForStore in interface Federated

Throws:

wt.federation.FederationServicesException

findLinks

public QueryResult findLinks(Class targetLinkClass,
                             String obj1Role,
                             Persistable obj2)
                      throws wt.federation.FederationServicesException

Return all link objects that exist between the Federated object and the specified source object.

Supported API: true

Specified by:

findLinks in interface Federated

Parameters:

targetLinkClass -

obj1Role -

obj2 -

Returns:

QueryResult

Throws:

wt.federation.FederationServicesException

navigate

public QueryResult navigate(String role,
                            Class linkClass,
                            boolean onlyOtherSide)
                     throws wt.federation.FederationServicesException

Return objects related to this federated source object given a role and link class. Return only the related objects themselves if specified. Otherwise, return both the related objects as well as the link objects that associate them with the source object.

Supported API: true

Specified by:

navigate in interface Federated

Parameters:

role -

linkClass -

onlyOtherSide -

Returns:

QueryResult

Throws:

wt.federation.FederationServicesException

navigate

public QueryResult navigate(String role,
                            QuerySpec criteria,
                            boolean onlyOtherSide)
                     throws wt.federation.FederationServicesException

Return objects related to this federated source object given a role and link selection crtieria. Return only the related objects themselves if specified. Otherwise, return both the related objects as well as the link objects that associate them with the source object.

Supported API: true

Specified by:

navigate in interface Federated

Parameters:

role -

criteria -

onlyOtherSide -

Returns:

QueryResult

Throws:

wt.federation.FederationServicesException

postStore

public void postStore()
               throws wt.federation.FederationServicesException

The persistence manager calls this method just after storing the proxy object in the database. This gives the object an opportunity to make associated objects persistent, if necessary. For example, links between the proxy object and other objects need to be persisted after the proxy object is persisted.

Supported API: true

Specified by:

postStore in interface Federated

Throws:

wt.federation.FederationServicesException

getServiceId

public ServiceIdentifier getServiceId()

Gets the object for the association that plays role: SERVICE_ID.

Supported API: true

Specified by:

getServiceId in interface Federated

Returns:

ServiceIdentifier

setServiceId

public void setServiceId(ServiceIdentifier a_ServiceId)
                  throws WTPropertyVetoException

Sets the object for the association that plays role: SERVICE_ID.

Supported API: true

Specified by:

setServiceId in interface Federated

Parameters:

a_ServiceId -

Throws:

WTPropertyVetoException

parentGroups

public Enumeration parentGroups()
                         throws WTException

Returns the groups to which the user belongs. The result is a principal reference enumeration.

Supported API: true

Overrides:

parentGroups in class WTUser

Returns:

Enumeration

Throws:

WTException

parentGroupNames

public Enumeration parentGroupNames()
                             throws WTException

Returns an enumeration containing the names of the groups to which the user belongs.

Supported API: true

Overrides:

parentGroupNames in class WTUser

Returns:

Enumeration

Throws:

WTException

toString

public String toString()

Returns a string representation of the user object.

Supported API: true

Specified by:

toString in interface Principal

Overrides:

toString in class WTUser

Returns:

String