com.softwareag.centrasite.api.csom
Interface Organization

All Superinterfaces:
CentraSiteObject, CentraSiteRegistryObject

public interface Organization
extends CentraSiteRegistryObject

CSOM Organization Common interface for organization related information.


Method Summary
 User getAdministrator()
          Get the Administrator user for the current Organization
 int getChildOrganizationCount()
          Gets the count of child organization for the current organization
 java.util.Collection<Organization> getChildOrganizations()
          Gets all immediate children Organizations.
 java.util.Collection<java.lang.String> getEmailAddresses()
          Get the Email Address of the current Organization
 Organization getParentOrganization()
          Gets the parent (container) organization.
 PostalAddress getPostalAddress()
          Gets the PostalAddress for this User
 User getPrimaryContact()
          Get the primary contact User for the current Organization
 Organization getRootOrganziation()
          Gets the root organization.
 java.util.Collection<Service> getServices()
          Gets all children Services for the current Organization
 java.util.Collection<TelephoneNumber> getTelephoneNumbers(java.lang.String phoneType)
          Gets the telephone numbers for this User that match the specified telephone number type.
 java.util.Collection<User> getUsers()
          Gets the Collection of Users affiliated with this Organization
 java.lang.String getWebPage()
          Get the webPageURL of current Organization.
 
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

getPrimaryContact

User getPrimaryContact()
                       throws CLLException
Get the primary contact User for the current Organization

Returns:
primary contact user
Throws:
CLLException

getAdministrator

User getAdministrator()
                      throws CLLException
Get the Administrator user for the current Organization

Returns:
User
Throws:
CLLException

getUsers

java.util.Collection<User> getUsers()
                                    throws CLLException
Gets the Collection of Users affiliated with this Organization

Returns:
users
Throws:
CLLException

getServices

java.util.Collection<Service> getServices()
                                          throws CLLException
Gets all children Services for the current Organization

Returns:
services that belong to this organization
Throws:
CLLException

getTelephoneNumbers

java.util.Collection<TelephoneNumber> getTelephoneNumbers(java.lang.String phoneType)
                                                          throws CLLException
Gets the telephone numbers for this User that match the specified telephone number type.

Parameters:
phoneType - phonetype
Returns:
telephone number
Throws:
CLLException

getChildOrganizationCount

int getChildOrganizationCount()
                              throws CLLException
Gets the count of child organization for the current organization

Returns:
childOrganizationCount
Throws:
CLLException

getChildOrganizations

java.util.Collection<Organization> getChildOrganizations()
                                                         throws CLLException
Gets all immediate children Organizations.

Returns:
childOrganizations
Throws:
CLLException

getParentOrganization

Organization getParentOrganization()
                                   throws CLLException
Gets the parent (container) organization.

Returns:
parentOrganization
Throws:
CLLException

getRootOrganziation

Organization getRootOrganziation()
                                 throws CLLException
Gets the root organization.

Returns:
root organization, if present. Otherwise, returns current organization.
Throws:
CLLException

getWebPage

java.lang.String getWebPage()
                            throws CLLException
Get the webPageURL of current Organization.

Returns:
webPageURL of current Organization.
Throws:
CLLException

getEmailAddresses

java.util.Collection<java.lang.String> getEmailAddresses()
                                                         throws CLLException
Get the Email Address of the current Organization

Returns:
Email Address of the current Organization
Throws:
CLLException

getPostalAddress

PostalAddress getPostalAddress()
                               throws CLLException
Gets the PostalAddress for this User

Returns:
The postal address of this Organization
Throws:
CLLException