public interface IConfigurationService
Modifier and Type | Method and Description |
---|---|
void |
applyRLSRules()
Apply Rules
|
void |
associateProfilesToUser(Id userId,
java.util.List<Id> profileIds)
Associates a list of profiles to a user.
|
void |
associateUsersToProfile(Id profileId,
java.util.List<Id> userIds)
Associates a list of users to a profile.
|
IDashboardView |
createDashboard(IDashboardView dashboard)
Creates a dashboard view
|
IRespView |
createRespView(IRespView respView)
Creates a responsive view
|
void |
deleteRespViews(java.util.Set<Id> respViewIds)
Deletes the responsive view
|
void |
disableCurrency(ICurrency currency)
Set the state of the currency specified by the ICurrency object to disabled.
|
void |
disableProfile(IProfile profile)
Disable the specified profile.
|
void |
disassociateProfilesFromUser(Id userId,
java.util.List<Id> profileIds)
Disassociates a list of profiles from a user.
|
void |
disassociateUsersFromProfile(Id profileId,
java.util.List<Id> userIds)
Disassociates a list of users to a profile.
|
void |
enableCurrency(ICurrency currency)
Set the state of the currency specified by the ICurrency object to enabled.
|
void |
enableProfile(IProfile profile)
Enable the specified profile.
|
void |
enableRespViews(java.util.Set<Id> ids,
boolean enable)
Enable/disable views with the specified IDs.
|
java.util.List<IRLSTypeDefinitionRules> |
getAllRLSRules()
Returns list of All the rules
|
Id |
getApplicableTaskView(IGRCObject grcObject)
Returns Id of the responsive view that is applicable to the input GRC object, or null if there is no applicable view.
|
ICurrency |
getBaseCurrency()
Retrieve the base currency.
|
IConfigProperties |
getConfigProperties()
Retrieve configuration properties.
|
IConfigurationFactory |
getConfigurationFactory()
Get an instance of IConfigurationFactory.
|
java.util.List<ICurrency> |
getCurrencies(boolean onlyEnabled)
Retrieves a list of ICurrency objects that are available in the configuration.
|
ICurrency |
getCurrency(ISOCurrencyCode currencyCode)
Retrieve currency information for the specified currency code.
|
double |
getCurrentExchangeRate(ICurrency currency)
Retrieve the current exchange rate for the currency.
|
IReportingPeriod |
getCurrentReportingPeriod()
Returns the "current" reporting period.
|
IDashboardView |
getDashboard(Id dashboardId,
RespViewState viewState)
Returns a dashboard view
|
IDashboardView |
getDashboard(Id profileId,
java.lang.String viewName,
RespViewState viewState)
Returns a dashboard view
|
DashboardList |
getDashboards(IFindOptions options,
RespViewState state)
Searches the dashboard views that meets the filter criteria with paging and sorting
|
IProfile |
getDefaultProfile()
Returns the system's default profile.
|
double |
getExchangeRate(ICurrency currency,
java.util.Date date)
Retrieve the exchange rate for the currency on a particular date.
|
java.util.List<IExchangeRate> |
getExchangeRateHistory(ICurrency currency)
Retrieve the exchange rate history for the currency.
|
java.util.List<IExchangeRate> |
getExchangeRates(boolean onlyEnabled)
Retrieve the exchange rates for all currencies based on the parameter.
|
java.lang.String |
getLocalizedApplicationText(Id keyId)
Retrieve the translated string associated with the key id.
|
java.lang.String |
getLocalizedApplicationText(java.lang.String key)
Retrieve the translated string associated with the key.
|
java.lang.String |
getLocalizedApplicationText(java.lang.String key,
java.util.Locale locale)
Retrieve the translated string associated with the key and the locale.
|
java.util.List<IApplicationText> |
getLocalizedApplicationTexts(java.util.Set<java.lang.String> categoryFilters)
Retrieve list of application text for the given categories, or for every category if given categoryFilters is empty.
|
java.util.List<IApplicationText> |
getLocalizedApplicationTexts(java.util.Set<java.lang.String> categoryFilters,
java.util.Locale locale)
Retrieve list of application text for given locale and for the given categories, or for every category if given categoryFilters is empty.
|
java.lang.String |
getLocalizedErrorText(int errorCode)
Retrieve the translated error message associated with the error code.
|
IProfile |
getPreferredProfile()
Returns the preferred profile for the current user.
|
IProfile |
getPreferredProfile(IUser user)
Returns the preferred profile for the specified user.
|
IProfile |
getProfile(Id profileId)
Returns the profile associated with the specified profile Identifier.
|
IProfile |
getProfile(java.lang.String name)
Returns the profile associated with the specified profile name.
|
java.util.List<IProfileFieldDefinition> |
getProfileFields(java.lang.String profileName,
java.lang.String objectName,
java.lang.String viewName)
Returns a list of profile field definitions for a specific view
in a profile.
|
java.util.List<IProfile> |
getProfiles()
Returns the list of profiles available in the system.
|
java.util.List<IProfile> |
getProfiles(IUser user)
Returns the list of profiles associated with the specified user.
|
IReportingPeriod |
getReportingPeriod(java.lang.String reportingPeriodLabel)
Returns a specific reporting period.
|
java.util.List<IReportingPeriod> |
getReportingPeriods()
Retrieve Reporting Periods
|
IRespView |
getRespView(Id respViewId,
RespViewState viewState)
Returns a responsive view
|
IRespView |
getRespView(ITypeDefinition typeDefinition,
RespViewType viewType,
java.lang.String viewName,
RespViewState viewState)
Returns a responsive view
|
IRespView |
getRespViewForWFActivity(IWFActivity activity,
Id resourceContentTypeId,
RespViewState viewState)
Returns a responsive view
|
RespViewList |
getRespViews(IFindOptions options,
RespViewState state)
Searches the responsive views that meets the filter criteria with paging and sorting
|
java.util.List<IRespView> |
getRespViews(RespViewFilter filter)
Searches the responsive views that meets the filter criteria
|
IRLSTypeDefinitionRules |
getRLSRules(ITypeDefinition ITypeDefinition)
Return a Rule for a specific contentTypeID
|
boolean |
isAdminMode()
Returns whether Administrator mode is enabled or disabled.
|
IDashboardView |
publishDashboard(Id dashboardId)
publishes the draft state of the dashboard
|
IRespView |
publishRespView(Id respViewId)
publishes the draft state of the view
|
void |
reorderRespViewRules(ITypeDefinition typeDefinition,
RespViewType viewType,
java.util.Map<Id,java.lang.Integer> orders)
Reorder identification rules for responsive views.
|
IDashboardView |
revertDraftDashboard(Id dashboardId)
Reverts the draft of the dashboard back to the previously published state
|
IRespView |
revertDraftRespView(Id respViewId)
Reverts the draft of the view back to the previously published state
|
IRLSTypeDefinitionRules |
saveRLSRules(IRLSTypeDefinitionRules rules)
Save Rules
|
void |
setAdminMode(boolean isAdminMode)
Set whether Administrator mode should be enabled or disabled.
|
void |
setExchangeRate(IExchangeRate exchangeRate)
Set a new exchange rate.
|
void |
setExchangeRates(java.util.List<IExchangeRate> exchangeRates)
Set a list of exchange rates.
|
void |
setPreferredProfile(IProfile profile)
Set the preferred profile for the current user.
|
void |
setPreferredProfile(IProfile profile,
IUser user)
Set the preferred profile for the user.
|
IDashboardView |
updateDashboard(IDashboardView dashboard)
Updates the dashboard view
|
IRespView |
updateRespView(IRespView respView)
Updates the responsive view
|
void setAdminMode(boolean isAdminMode)
isAdminMode
- - Specify true to enable and false to disableboolean isAdminMode()
ICurrency getCurrency(ISOCurrencyCode currencyCode)
currencyCode
- - Specify the ISO currency code.java.util.List<ICurrency> getCurrencies(boolean onlyEnabled)
onlyEnabled
- - true/false value to specify which currencies to return.void enableCurrency(ICurrency currency)
currency
- - currency to enable.void disableCurrency(ICurrency currency)
currency
- - currency to disable.ICurrency getBaseCurrency()
double getExchangeRate(ICurrency currency, java.util.Date date)
currency
- - The currency to use to get the exchange rate.date
- - The date for lookup.double getCurrentExchangeRate(ICurrency currency)
currency
- - The currency to use to get the exchange rate.java.util.List<IExchangeRate> getExchangeRateHistory(ICurrency currency)
currency
- - The currency to use to get the exchange rate history.java.util.List<IExchangeRate> getExchangeRates(boolean onlyEnabled)
onlyEnabled
- - Specifies whether to get the exchange rates only for enabled currencies or all currencies.
- If value is true, then exchange rates only for the enabled currencies are returned.
- If value is false, then exchange rates for all currencies are returned.java.util.List<IReportingPeriod> getReportingPeriods()
IReportingPeriod getCurrentReportingPeriod()
IReportingPeriod getReportingPeriod(java.lang.String reportingPeriodLabel)
reportingPeriodLabel
- - label of the reporting period to retrieve.java.lang.String getLocalizedApplicationText(java.lang.String key)
null
.
Examples:
String detailviewLabel = configService.getLocalizedApplicationText("com.label.activityview.detailview");
String roleTypeLabel = configService.getLocalizedApplicationText("com.label.role.type");
key
- - the key to the string.java.lang.String getLocalizedApplicationText(Id keyId)
null
.keyId
- - the key id to the string.java.lang.String getLocalizedApplicationText(java.lang.String key, java.util.Locale locale)
null
.
Examples:
String detailviewLabel = configService.getLocalizedApplicationText("com.label.activityview.detailview", locale);
String roleTypeLabel = configService.getLocalizedApplicationText("com.label.role.type", locale);
key
- - the key of the application string in openpages application.locale
- - specified java util locale for the application string.java.util.List<IApplicationText> getLocalizedApplicationTexts(java.util.Set<java.lang.String> categoryFilters)
categoryFilters
- - the set of category names to filter application texts.
If this is empty, all the application texts in the system will be retrieved.java.util.List<IApplicationText> getLocalizedApplicationTexts(java.util.Set<java.lang.String> categoryFilters, java.util.Locale locale)
categoryFilters
- - the set of category names to filter application texts.
If this is empty, all the application texts in the system will be retrieved.locale
- - specified java util locale for the application string.java.lang.String getLocalizedErrorText(int errorCode)
null
.errorCode
- - the error code.IConfigProperties getConfigProperties()
IConfigProperties
to check if the property exists in the system and to get the
value associated with the property key.java.util.List<IProfile> getProfiles()
IProfile getProfile(java.lang.String name)
name
- - the profile name.IProfile getProfile(Id profileId)
profileId
- - the profile Identifier.java.util.List<IProfile> getProfiles(IUser user)
user
- - the user.void associateUsersToProfile(Id profileId, java.util.List<Id> userIds)
profileId
- - the id of the profile to get associated to the usersuserIds
- - the list of ids for users who should be associated to the profile.void associateProfilesToUser(Id userId, java.util.List<Id> profileIds)
userId
- - the Id of the User to assign the profiles to.profileIds
- - the list of profile ids for the profiles that should be associated to the user.void disassociateUsersFromProfile(Id profileId, java.util.List<Id> userIds)
profileId
- - the id of the profile to get disassociated from the usersuserIds
- - the list of ids for users who should be disassociated from the profile.void disassociateProfilesFromUser(Id userId, java.util.List<Id> profileIds)
userId
- - the Id of the User to disassociate the profiles from.profileIds
- - the list of profile ids for the profiles that should be disassociated from the user.void setPreferredProfile(IProfile profile, IUser user)
profile
- - the profile to set as the preferred profile.user
- - the user.void setPreferredProfile(IProfile profile)
profile
- - the profile to set as the preferred profile.void disableProfile(IProfile profile)
profile
- - the profile to disable.void enableProfile(IProfile profile)
profile
- - the profile to enable.IProfile getDefaultProfile()
IProfile getPreferredProfile()
IProfile getPreferredProfile(IUser user)
user
- - the user.java.util.List<IProfileFieldDefinition> getProfileFields(java.lang.String profileName, java.lang.String objectName, java.lang.String viewName)
profileName
- - profile name. (Required)objectName
- - object name that is used in the profile. (Required)viewName
- - view name. (Required)IRLSTypeDefinitionRules getRLSRules(ITypeDefinition ITypeDefinition)
contentTypeId
- java.util.List<IRLSTypeDefinitionRules> getAllRLSRules()
IRLSTypeDefinitionRules saveRLSRules(IRLSTypeDefinitionRules rules)
rules
- void applyRLSRules()
void setExchangeRates(java.util.List<IExchangeRate> exchangeRates)
exchangeRates
- - a list of exchangeRates to set.void setExchangeRate(IExchangeRate exchangeRate)
Set a new exchange rate.
Example:
IServiceFactory factory = ServiceFactory.getServiceFactory(context);
IConfigurationService configService = factory.createConfigurationService();
String currencyCode = "CAD";
double rate = 0.8636;
Date startDate = null; // means current date.
IExchangeRate exchangeRate = configService.getConfigurationFactory().createExchangeRate(configService,
currencyCode,
rate,
startDate);
configService.setExchangeRate(exchangeRate);
exchangeRate
- - the exchangeRate to set.IConfigurationFactory getConfigurationFactory()
IRespView createRespView(IRespView respView)
respView
- the view to persistIRespView getRespViewForWFActivity(IWFActivity activity, Id resourceContentTypeId, RespViewState viewState)
activity
- the activity with view overridesresourceContentTypeId
- the resource content type (required for fetching view)viewState
- the state of the responsive view to retrieveIRespView getRespView(Id respViewId, RespViewState viewState)
respViewId
- the Id of the responsive view to look upviewState
- the state of the responsive view to retrieveIRespView getRespView(ITypeDefinition typeDefinition, RespViewType viewType, java.lang.String viewName, RespViewState viewState)
typeDefinition
- the type definition of the responsive view to look upviewType
- the type of the responsive view to look upviewName
- the name of the responsive view to look upviewState
- the state of the responsive view to retrieveIRespView updateRespView(IRespView respView)
respView
- the view to persistIRespView publishRespView(Id respViewId)
respViewId
- the Id of the responsive view to publishIRespView revertDraftRespView(Id respViewId)
respViewId
- the Id of the responsive view to revertvoid deleteRespViews(java.util.Set<Id> respViewIds)
respViewIds
- Set of the Ids of the responsive view to deletejava.util.List<IRespView> getRespViews(RespViewFilter filter)
filter
- the filter to search responsive viewsRespViewList getRespViews(IFindOptions options, RespViewState state)
filter
- - the filter to search responsive viewsstate
- - the state to fetch in the query resultvoid reorderRespViewRules(ITypeDefinition typeDefinition, RespViewType viewType, java.util.Map<Id,java.lang.Integer> orders)
typeDefinition
- - the type definition of the responsive viewsviewType
- - the responsive view typeorders
- - the map object from the responsive view Id to the new order value. The map does not necessarily have to contain all the views
with the same type definition and the same view type.Id getApplicableTaskView(IGRCObject grcObject)
IRespViewRuleCondition
) is evaluated based on the rule order ( IRespView.getRuleOrder()
).
And first matching view is returned by this API. If there is a default view, it is returned when there is no matching view based on the identification rule.grcObject
- to evaluate the view identification rule for.void enableRespViews(java.util.Set<Id> ids, boolean enable)
ids
- The view IDs to enable/disableenable
- TRUE enables the views; FALSE disables the viewsIDashboardView getDashboard(Id dashboardId, RespViewState viewState)
dashboardId
- the Id of the dashboard view to look upviewState
- the state of the dashboard view to retrieveIDashboardView getDashboard(Id profileId, java.lang.String viewName, RespViewState viewState)
profileId
- the Id of the Object Profile that the dashboard is associated toviewName
- the name of the dashboard view to look upviewState
- the state of the dashboard view to retrieveIDashboardView createDashboard(IDashboardView dashboard)
dashboard
- - The view to persistDashboardList getDashboards(IFindOptions options, RespViewState state)
filter
- the filter to search dashboard viewsIDashboardView updateDashboard(IDashboardView dashboard)
dashboard
- the view to persistIDashboardView publishDashboard(Id dashboardId)
dashboardId
- the Id of the dashboard view to publishIDashboardView revertDraftDashboard(Id dashboardId)
dashboardId
- the Id of the dashboard view to revert
Licensed Materials - Property of IBM
OpenPages with Watson (PID: 5725-D51)
© Copyright IBM Corporation 2013, 2019. All Rights Reserved.
US Government Users Restricted Rights -
Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.