|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Company
Interface for Company object.
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 |
---|
static final java.lang.String copyright
Method Detail |
---|
void addCurrencies(java.util.List<com.ibm.icu.util.Currency> companyCurrencies)
companyCurrencies
- A List of Currency objects
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 Systemvoid addLocales(java.util.List<java.util.Locale> companyLocales)
companyLocales
- A List of Locale objects
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 SystemPIMCollection<Role> getRoles()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use.PIMCollection<User> getUsers()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use.java.util.Collection<AccessControlGroup> getAccessControlGroups()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use.java.util.Collection<com.ibm.icu.util.Currency> getCurrencies()
PIMInternalException
- If an internal error occursAccessControlGroup getDefaultAccessControlGroup()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use.AttributeCollection getDefaultAttributeCollection(Spec spec)
spec
- A primary spec or lookup spec
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.java.util.Locale getDefaultLocale()
PIMInternalException
- If an internal error occursHierarchy getDefaultLookupTableHierarchy()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_LIST
OrganizationHierarchy getDefaultOrganizationHierarchy()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_LIST
PrimarySpec getDefaultSpec()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use.java.util.Collection<java.util.Locale> getLocales()
PIMInternalException
- If an internal error occursvoid removeCurrencies(java.util.List<com.ibm.icu.util.Currency> companyCurrencies)
companyCurrencies
- A List of Currency objects to be removed
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 Systemvoid removeLocales(java.util.List<java.util.Locale> companyLocales)
companyLocales
- An List of Locale objects to be removed
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 Systemjava.lang.String getName()
PIMInternalException
- If an internal error occursjava.lang.String getCode()
PIMInternalException
- If an internal error occurs
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |