com.ibm.pim.organization
Interface Company


public interface Company

Interface for Company object.

Since:
6.0.0

Field Summary
static java.lang.String copyright
           
 
Method Summary
 void addCurrencies(java.util.List<com.ibm.icu.util.Currency> companyCurrencies)
          Adds new Currencies to those available to this company
 void addLocales(java.util.List<java.util.Locale> companyLocales)
          Adds new Locales to those available to this company
 java.util.Collection<AccessControlGroup> getAccessControlGroups()
          Returns all access control groups in the context of this company.
 java.lang.String getCode()
          Retrieves the company code.
 java.util.Collection<com.ibm.icu.util.Currency> getCurrencies()
          Returns all Currencies in the context of this company.
 AccessControlGroup getDefaultAccessControlGroup()
          Retrieves the default AccessControlGroup for this company
 AttributeCollection getDefaultAttributeCollection(Spec spec)
          Retrieves the default Attribute Collection for the given spec
 java.util.Locale getDefaultLocale()
          Retrieves the default Locale for this company
 Hierarchy getDefaultLookupTableHierarchy()
          Retrieves the default Lookup Table hierarchy for this company
 OrganizationHierarchy getDefaultOrganizationHierarchy()
          Retrieves the default Organization Hierarchy for this company
 PrimarySpec getDefaultSpec()
          Retrieves the default Spec for this company
 java.util.Collection<java.util.Locale> getLocales()
          Retrieves all Locales available to this company
 java.lang.String getName()
          Retrieves the company name.
 PIMCollection<Role> getRoles()
          Returns all roles associated with the company
 PIMCollection<User> getUsers()
          Returns all users in the context of this company
 void removeCurrencies(java.util.List<com.ibm.icu.util.Currency> companyCurrencies)
          Removes Currencies from those available to this company.
 void removeLocales(java.util.List<java.util.Locale> companyLocales)
          Removes Locales from those available to this company.
 

Field Detail

copyright

static final java.lang.String copyright
See Also:
Constant Field Values
Method Detail

addCurrencies

void addCurrencies(java.util.List<com.ibm.icu.util.Currency> companyCurrencies)
Adds new Currencies to those available to this company

Parameters:
companyCurrencies - A List of Currency objects
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use.
java.lang.IllegalArgumentException - If any of the input parameters is null or if any of the Currency is not supported by the PIM System

addLocales

void addLocales(java.util.List<java.util.Locale> companyLocales)
Adds new Locales to those available to this company

Parameters:
companyLocales - A List of Locale objects
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use.
java.lang.IllegalArgumentException - If any of the input parameters is null or if any of the Locale is not supported by the PIM System

getRoles

PIMCollection<Role> getRoles()
Returns all roles associated with the company

Returns:
Collection of Roles
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use.

getUsers

PIMCollection<User> getUsers()
Returns all users in the context of this company

Returns:
Collection of Users
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use.

getAccessControlGroups

java.util.Collection<AccessControlGroup> getAccessControlGroups()
Returns all access control groups in the context of this company.

Returns:
Collection of AccessControlGroups
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use.

getCurrencies

java.util.Collection<com.ibm.icu.util.Currency> getCurrencies()
Returns all Currencies in the context of this company.

Returns:
A Collection of Currency objects
Throws:
PIMInternalException - If an internal error occurs

getDefaultAccessControlGroup

AccessControlGroup getDefaultAccessControlGroup()
Retrieves the default AccessControlGroup for this company

Returns:
An Access Control Group object
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use.

getDefaultAttributeCollection

AttributeCollection getDefaultAttributeCollection(Spec spec)
Retrieves the default Attribute Collection for the given spec

Parameters:
spec - A primary spec or lookup spec
Returns:
An AttributeCollection object
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use.
java.lang.IllegalArgumentException - If any of the input parameters is null or if the spec passed in as the argument is not a Primary Spec or Lookup Spec.

getDefaultLocale

java.util.Locale getDefaultLocale()
Retrieves the default Locale for this company

Returns:
A Locale object
Throws:
PIMInternalException - If an internal error occurs

getDefaultLookupTableHierarchy

Hierarchy getDefaultLookupTableHierarchy()
Retrieves the default Lookup Table hierarchy for this company

Returns:
A Hierarchy object
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user does not have the equivalent of Permission.HIERARCHY_LIST

getDefaultOrganizationHierarchy

OrganizationHierarchy getDefaultOrganizationHierarchy()
Retrieves the default Organization Hierarchy for this company

Returns:
A OrganizationHierarchy object
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user does not have the equivalent of Permission.HIERARCHY_LIST

getDefaultSpec

PrimarySpec getDefaultSpec()
Retrieves the default Spec for this company

Returns:
A Spec object
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use.

getLocales

java.util.Collection<java.util.Locale> getLocales()
Retrieves all Locales available to this company

Returns:
A Collection of Locale objects
Throws:
PIMInternalException - If an internal error occurs

removeCurrencies

void removeCurrencies(java.util.List<com.ibm.icu.util.Currency> companyCurrencies)
Removes Currencies from those available to this company.

Parameters:
companyCurrencies - A List of Currency objects to be removed
Throws:
PIMInternalException - If an internal error occurs or if an attempt is made to remove a currency which is in use.
PIMAuthorizationException - Reserved for future use.
java.lang.IllegalArgumentException - If any of the input parameters is null or if any of the Currency is not supported by the PIM System

removeLocales

void removeLocales(java.util.List<java.util.Locale> companyLocales)
Removes Locales from those available to this company. This will also remove the given locales from any specs that are localized using them. In the event of a database problem an exception is thrown. This is to ensure that a rollback can be carried out safely by the caller.

Parameters:
companyLocales - An List of Locale objects to be removed
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use.
java.lang.IllegalArgumentException - If any of the input parameters is null or or if any of the Locale is not supported by the PIM System

getName

java.lang.String getName()
Retrieves the company name.

Returns:
A String value
Throws:
PIMInternalException - If an internal error occurs

getCode

java.lang.String getCode()
Retrieves the company code.

Returns:
A String value
Throws:
PIMInternalException - If an internal error occurs