wt.org
Class WTOrganization

java.lang.Object
  wt.fc.WTObject
      wt.fc.Item
          wt.org.WTPrincipal
              wt.org.WTGroup
                  wt.org.WTOrganization

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, wt.federation.FederatedLinkHolder, wt.federation.RemotelyLinkable, wt.iba.value.IBAReferenceable, DisplayIdentification, WTContained, DirectoryContextProvider, wt.recent.RecentlyVisited, wt.ufid.Federatable

public class WTOrganization
extends WTGroup
implements DirectoryContextProvider, wt.iba.value.IBAReferenceable, Externalizable

Use the newWTOrganization static factory method(s), not the WTOrganization 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

Method Summary

WTPrincipalReference	getAdministrator() Supported API: true
String	getClassification() Supported API: true
String	getCodingSystem() Supported API: true
String	getConferencingIdentifier() Supported API: true
URL	getConferencingURL() Supported API: true
String	getCreationBase(String service) This API should be used to retrieve the base in LDAP where the participant nodes need to be created.
String	getInternetDomain() Supported API: true
String	getLocation() Supported API: true
String	getPrimaryService() This API will return the primary directory service name defined in wt.properties.
String	getSearchBase(String service) This API should be used to retrieve the base distinguished name in LDAP where participants can be searched.
String	getSearchCriteria(String service, Class principalClass) This API is used to retrieve the actual filter if any, that needs to be applied while searching for participants within a specific search base.
Enumeration	getSearchCriteriaClasses(String service) This API is used to retrieve the type of object classes which are part of the search criteria defined if any, while searching for participants within a specific search base.
String	getSearchScope(String service) LDAP allows the following 3 different kinds to scopes for searches 1) base 2) onelevel 3) subtree This API returns the current scope that is set on all the searches being done within the context for which the Directory Context Provider is formulated.
int	getSizeLimit(String service) This API will return the results size limit that could be returned from LDAP for any specific search.
String[]	getSupportingServices() This API will return all the secondary directory service names that correspond to the JNDI adapters defined in Info* Engine Supported API: true
String	getUniqueIdentifier() Supported API: true
URL	getWebSite() Supported API: true
protected void	initialize(String name) Supports initialization, following construction of an instance.
protected void	initialize(String name, DirectoryContextProvider context) Supports initialization, following construction of an instance.
protected void	initialize(String name, String dn, String service) Supports initialization, following construction of an instance.
static WTOrganization	newWTOrganization(String name) Supported API: true
static WTOrganization	newWTOrganization(String name, DirectoryContextProvider context) Supported API: true
static WTOrganization	newWTOrganization(String name, String dn, String service) Supported API: true
void	setAdministrator(WTPrincipalReference administrator) Supported API: true
void	setClassification(String classification) Supported API: true
void	setConferencingIdentifier(String conferencingIdentifier) Supported API: true
void	setConferencingURL(URL conferencingURL) Supported API: true
void	setInternetDomain(String internetDomain) Supported API: true
void	setLocation(String location) Supported API: true
void	setSupportingServices(String[] supportingServices) Supported API: true
void	setWebSite(URL webSite) Supported API: true

Methods inherited from class wt.org.WTGroup

addMember, addMembers, getBusinessType, isMember, members, newWTGroup, newWTGroup, newWTGroup, parentGroups, removeMember, setDisabled

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

Method Detail

newWTOrganization

public static WTOrganization newWTOrganization(String name)
                                        throws WTException

Supported API: true

Parameters:

name -

Returns:

WTOrganization

Throws:

WTException

initialize

protected void initialize(String name)
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Overrides:

initialize in class WTGroup

Parameters:

name -

Throws:

WTException

newWTOrganization

public static WTOrganization newWTOrganization(String name,
                                               String dn,
                                               String service)
                                        throws WTException

Supported API: true

Parameters:

name -

dn -

service -

Returns:

WTOrganization

Throws:

WTException

initialize

protected void initialize(String name,
                          String dn,
                          String service)
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Overrides:

initialize in class WTGroup

Parameters:

name -

dn -

service -

Throws:

WTException

newWTOrganization

public static WTOrganization newWTOrganization(String name,
                                               DirectoryContextProvider context)
                                        throws WTException

Supported API: true

Parameters:

name -

context -

Returns:

WTOrganization

Throws:

WTException

initialize

protected void initialize(String name,
                          DirectoryContextProvider context)
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Overrides:

initialize in class WTGroup

Parameters:

name -

context -

Throws:

WTException

getAdministrator

public WTPrincipalReference getAdministrator()
                                      throws WTException

Supported API: true

Returns:

WTPrincipalReference

Throws:

WTException

setAdministrator

public void setAdministrator(WTPrincipalReference administrator)

Supported API: true

Parameters:

administrator -

getClassification

public String getClassification()
                         throws WTException

Supported API: true

Returns:

String

Throws:

WTException

setClassification

public void setClassification(String classification)

Supported API: true

Parameters:

classification -

getCodingSystem

public String getCodingSystem()

Supported API: true

Returns:

String

getConferencingIdentifier

public String getConferencingIdentifier()
                                 throws WTException

Supported API: true

Returns:

String

Throws:

WTException

setConferencingIdentifier

public void setConferencingIdentifier(String conferencingIdentifier)
                               throws WTException

Supported API: true

Parameters:

conferencingIdentifier -

Throws:

WTException

getConferencingURL

public URL getConferencingURL()
                       throws WTException

Supported API: true

Returns:

URL

Throws:

WTException

setConferencingURL

public void setConferencingURL(URL conferencingURL)
                        throws WTException

Supported API: true

Parameters:

conferencingURL -

Throws:

WTException

getInternetDomain

public String getInternetDomain()
                         throws WTException

Supported API: true

Returns:

String

Throws:

WTException

setInternetDomain

public void setInternetDomain(String internetDomain)
                       throws WTException

Supported API: true

Parameters:

internetDomain -

Throws:

WTException

getLocation

public String getLocation()
                   throws WTException

Supported API: true

Returns:

String

Throws:

WTException

setLocation

public void setLocation(String location)

Supported API: true

Parameters:

location -

setSupportingServices

public void setSupportingServices(String[] supportingServices)

Supported API: true

Parameters:

supportingServices -

getUniqueIdentifier

public String getUniqueIdentifier()

Supported API: true

Returns:

String

getWebSite

public URL getWebSite()
               throws WTException

Supported API: true

Returns:

URL

Throws:

WTException

setWebSite

public void setWebSite(URL webSite)

Supported API: true

Parameters:

webSite -

getCreationBase

public String getCreationBase(String service)
                       throws WTException

This API should be used to retrieve the base in LDAP where the participant nodes need to be created.

Supported API: true

Specified by:

getCreationBase in interface DirectoryContextProvider

Parameters:

service -

Returns:

String

Throws:

WTException

getPrimaryService

public String getPrimaryService()
                         throws WTException

This API will return the primary directory service name defined in wt.properties.

Supported API: true

Specified by:

getPrimaryService in interface DirectoryContextProvider

Returns:

String

Throws:

WTException

getSearchBase

public String getSearchBase(String service)
                     throws WTException

This API should be used to retrieve the base distinguished name in LDAP where participants can be searched.

Supported API: true

Specified by:

getSearchBase in interface DirectoryContextProvider

Parameters:

service -

Returns:

String

Throws:

WTException

getSearchCriteria

public String getSearchCriteria(String service,
                                Class principalClass)

This API is used to retrieve the actual filter if any, that needs to be applied while searching for participants within a specific search base. This API should only be used while querying participants stored in LDAP.

Supported API: true

Specified by:

getSearchCriteria in interface DirectoryContextProvider

Parameters:

service -

principalClass -

Returns:

String

getSearchCriteriaClasses

public Enumeration getSearchCriteriaClasses(String service)

This API is used to retrieve the type of object classes which are part of the search criteria defined if any, while searching for participants within a specific search base. Each directory service has its own definition of object classes that uniquely correspond to the type of Windchill objects that exist in the directory service. Aphelion has the following three definitions inetOrgPerson - WTUser groupOfUniqueNames - WTGroup ptcOrganization - WTOrganization

Supported API: true

Specified by:

getSearchCriteriaClasses in interface DirectoryContextProvider

Parameters:

service -

Returns:

Enumeration

getSearchScope

public String getSearchScope(String service)
                      throws WTException

LDAP allows the following 3 different kinds to scopes for searches 1) base 2) onelevel 3) subtree This API returns the current scope that is set on all the searches being done within the context for which the Directory Context Provider is formulated.

Supported API: true

Specified by:

getSearchScope in interface DirectoryContextProvider

Parameters:

service -

Returns:

String

Throws:

WTException

getSizeLimit

public int getSizeLimit(String service)

This API will return the results size limit that could be returned from LDAP for any specific search. If more results are found for a specific search, LDAP will limit the returned resultset to only the first 'n' number of entries unitl the maximum limit set is reached.

Supported API: true

Specified by:

getSizeLimit in interface DirectoryContextProvider

Parameters:

service -

Returns:

int

getSupportingServices

public String[] getSupportingServices()
                               throws WTException

This API will return all the secondary directory service names that correspond to the JNDI adapters defined in Info* Engine

Supported API: true

Specified by:

getSupportingServices in interface DirectoryContextProvider

Returns:

String[]

Throws:

WTException