|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ConfigManager
The Interface ConfigManager.
Method Summary | |
---|---|
void |
addAttribute(Constants.Entity entityType, AttributeDefinition ad) Creates the attribute in the schema based on the passed definition. |
void |
addCategory(Constants.Entity entityType, CategoryDefinition category) Adds a new category in the metadata file of the entityType |
void |
addDerivedAttributes(Constants.Entity entityType, java.util.Map derivedAttributesMap) Add a set of derived attributes. |
void |
deleteAttribute(Constants.Entity entityType, java.lang.String attributeName) Delete attribute from entityType's metadata and backend schema |
void |
deleteCategory(Constants.Entity entityType, java.lang.String categoryName) Deletes the category. |
java.util.List |
getAdminDefinedLOVCodes(Constants.Entity entityType, java.lang.String value) Gets the lov codes which match the passed value |
java.util.Map |
getAdvancedSearchAttributes(Constants.Entity entityType) Gets the advanced search attributes. |
AttributeDefinition |
getAttribute(Constants.Entity entityType, java.lang.String name) Gets the attribute details. |
java.util.Map |
getAttributes(Constants.Entity entityType) Gets all the attributes. |
java.util.Map |
getAttributes(Constants.Entity entityType, Constants.Properties property, java.lang.Object value) Gets the attributes, that match the given property |
java.util.Map |
getCategories(Constants.Entity entityType) Gets the categories. |
CategoryDefinition |
getCategory(Constants.Entity entityType, java.lang.String categoryName) Gets the category. |
java.util.List |
getDerivedAttribute(Constants.Entity entityType, java.lang.String attrName) Gets the derived attribute, that is attributes whose value depends on other attributes. |
java.util.Map |
getDerivedAttributes(Constants.Entity entityType) Gets the derived attributes, that is attributes whose value depends on other attributes. |
java.util.List |
getSearchableAttributes(Constants.Entity entityType) Gets the list of searchable attributes. |
java.util.List |
getSearchResultsTableAttributes(Constants.Entity entityType) Gets the search results table attributes. |
java.util.List |
getSimpleSearchAttributes(Constants.Entity entityType) Gets the simple search attributes. |
void |
setAdvancedSearchAttributes(Constants.Entity entityType, java.util.List attrs) Sets the advanced search attributes. |
void |
setSearchAttributes(Constants.Entity entityType, java.util.List simpleAttrs, java.util.List advancedAttrs, java.util.List resultsTableAttrs) Sets the various search attributes - simple, advanced and search results table column attributes. |
void |
setSearchResultsTableAttributes(Constants.Entity entityType, java.util.List attributes) Sets the search results table attributes. |
void |
setSimpleSearchAttributes(Constants.Entity entityType, java.util.List attrs) Sets the simple search attributes. |
void |
updateAttribute(Constants.Entity entityType, AttributeDefinition ad) Updates the attribute as per the fields passed in Attribute Definition, in the entityType metadata file as well as backend schema. |
void |
updateCategory(Constants.Entity entityType, CategoryDefinition cd) Update category. |
Method Detail |
---|
void addAttribute(Constants.Entity entityType, AttributeDefinition ad) throws NoSuchEntityException, InvalidCharacterException, AttributeAlreadyExistsException, CategoryDoesNotExistException, AttributeCannotBeRequiredException, oracle.iam.platform.kernel.ValidationFailedException, AttributeCreateException, ConfigManagerException
entityType
- the entity type (User, Role, etc)ad
- the Attribute Definition which contains details required to create the new attributeNoSuchEntityException
- the no such entity exception, thrown when the passed entity doesn't exist.InvalidCharacterException
- the invalid character exception, thrown when the attribute name has invalid charactersAttributeAlreadyExistsException
- the attribute already exists exception thrown when this attribute already exists.CategoryDoesNotExistException
- the category does not exist exception thrown when the attribute's category is not present.AttributeCannotBeRequiredException
- the attribute cannot be required exception thrown when the attribute is set as required.oracle.iam.platform.kernel.ValidationFailedException
- the validation failed exception, thrown when a validation in general failsAttributeCreateException
- the attribute create exception, thrown when an unexpected exception occursConfigManagerException
- the config manager exception, thrown when an unexpected exception occursvoid updateAttribute(Constants.Entity entityType, AttributeDefinition ad) throws AccessDeniedException, CannotModifyForSystemAttributeException, CannotModifyAttributePropertyException, CannotHideMandatoryWithoutDefaultException, CannotChangeToRequiredYetException, ConfigManagerException
entityType
- the entity type(User, Role, etc)ad
- the Attribute Definition which contains details about attribute to be modifiedAccessDeniedException
- the access denied exception thrown when logged in user doesn't have access to update the attributeCannotModifyForSystemAttributeException
- the cannot modify for system attribute exception, thrown when an unmodifiable field is being changedCannotModifyAttributePropertyException
- the cannot modify for attribute property exception, thrown when an attribute property cannot be changedCannotHideMandatoryWithoutDefaultException
- the cannot hide without default exception exception, thrown when an mandatory field without default is being hiddenCannotChangeToRequiredYetException
- the cannot change to required yet exception, thrown when a non required attribute is being changed to required without all user's having a value for that field.ConfigManagerException
- the config manager exception, thrown when a general exception occursvoid deleteAttribute(Constants.Entity entityType, java.lang.String attributeName) throws NoSuchEntityException, AccessDeniedException, NoSuchAttributeException, DeleteSystemAttributeException, ConfigManagerException
entityType
- the entity typeattributeName
- the attribute nameNoSuchEntityException
- the no such entity exception thrown if the entity doesn't existAccessDeniedException
- the access denied exception, thrown if logged in user doesn't have authorization for this operationNoSuchAttributeException
- the no such attribute exception, thrown if this attribute doesn't existDeleteSystemAttributeException
- the delete system attribute exception, thrown when an OOTB attribute is being deletedConfigManagerException
- the config manager exception, thrown when a general exception occursAttributeDefinition getAttribute(Constants.Entity entityType, java.lang.String name) throws NoSuchEntityException, NoSuchAttributeException, ConfigManagerException, AccessDeniedException
entityType
- the entity typename
- the name of the attributeNoSuchEntityException
- the no such entity exception, thrown if the entity doesn't existNoSuchAttributeException
- the no such attribute exception, thrown if the attribute doesn't existConfigManagerException
- the config manager exception, thrown if a general exception occursAccessDeniedException
- the access denied exception, thrown if the logged in user doesn't have authorization for this operationjava.util.Map getAttributes(Constants.Entity entityType) throws NoSuchEntityException, ConfigManagerException, AccessDeniedException
entityType
- the entity typeNoSuchEntityException
- the no such entity exception, thrown when the entity doesn't existConfigManagerException
- the config manager exception, thrown when a general exception occursAccessDeniedException
- the access denied exception, thrown when the logged in user doesn't have authorization for this operationjava.util.Map getAttributes(Constants.Entity entityType, Constants.Properties property, java.lang.Object value) throws NoSuchEntityException, ConfigManagerException, AccessDeniedException
entityType
- the entity typeproperty
- the property which the attributes should matchvalue
- the value which the attributes should haveNoSuchEntityException
- the no such entity exception, thrown when the entity doesn't existConfigManagerException
- the config manager exception, thrown when a general exception occursAccessDeniedException
- the access denied exception, thrown when the logged in user doesn't have authorization for this operationjava.util.List getAdminDefinedLOVCodes(Constants.Entity entityType, java.lang.String value) throws NoSuchEntityException, AccessDeniedException, ConfigManagerException
entityType
- the entity typevalue
- the value for getting the lov codesNoSuchEntityException
- the no such entity exception, thrown if the entity doesn't existAccessDeniedException
- the access denied exception, thrown if the logged in user doesn't have authorization for this operationConfigManagerException
- the config manager exception, thrown if a general exception occursvoid addCategory(Constants.Entity entityType, CategoryDefinition category) throws NoSuchEntityException, AccessDeniedException, DuplicateCategoryException, ConfigManagerException
entityType
- the entity typecategory
- the category definitionNoSuchEntityException
- the no such entity exception, thrown if the entity doesn't existAccessDeniedException
- the access denied exception, if logged in user doesn't have authorization for this operationDuplicateCategoryException
- the duplicate category exception, thrown if a category with same name already exists.ConfigManagerException
- the config manager exception, thrown when a general exception occursvoid deleteCategory(Constants.Entity entityType, java.lang.String categoryName) throws NoSuchEntityException, DeleteCategoryException, AccessDeniedException, ConfigManagerException
entityType
- the entity typecategoryName
- the category nameNoSuchEntityException
- the no such entity exception, thrown when the entity doesn't existDeleteCategoryException
- the delete category exception, thrown when the category being deleted has attributes under itAccessDeniedException
- the access denied exception, thrown when logged in user doesn't have authorization for this operationConfigManagerException
- the config manager exception, thrown when a general exception occursvoid updateCategory(Constants.Entity entityType, CategoryDefinition cd) throws NoSuchEntityException, AccessDeniedException, NoSuchCategoryException, ConfigManagerException
entityType
- the entity typecd
- the category definition containing details for the updateNoSuchEntityException
- the no such entity exception, thrown when the entity doesn't existAccessDeniedException
- the access denied exception, thrown when the logged in user doesn't have permission for the operationNoSuchCategoryException
- the no such category exception, thrown if the category doesn't existConfigManagerException
- the config manager exception, thrown if a general exception occursCategoryDefinition getCategory(Constants.Entity entityType, java.lang.String categoryName) throws NoSuchEntityException, AccessDeniedException
entityType
- the entity typecategoryName
- the category nameNoSuchEntityException
- the no such entity exception, thrown if the entity doesn't existAccessDeniedException
- the access denied exception, thrown if the logged in user doesn't have authorization for this operationjava.util.Map getCategories(Constants.Entity entityType) throws NoSuchEntityException, AccessDeniedException
entityType
- the entity typeNoSuchEntityException
- the no such entity exception, thrown if the entity doesn't existAccessDeniedException
- the access denied exception, thrown if the logged in user doesn't have authorization for this operationjava.util.List getDerivedAttribute(Constants.Entity entityType, java.lang.String attrName) throws NoSuchEntityException, AccessDeniedException, ConfigManagerException
entityType
- the entity typeattrName
- the attribute nameNoSuchEntityException
- the no such entity exception, thrown if the entity doesn't existAccessDeniedException
- the access denied exception, thrown if the logged in user doesn't have authorization for this operationConfigManagerException
- the config manager exception, thrown if a generic exception occursjava.util.Map getDerivedAttributes(Constants.Entity entityType) throws NoSuchEntityException, AccessDeniedException, ConfigManagerException
entityType
- the entity typeNoSuchEntityException
- the no such entity exception, thrown if the entity doesn't existAccessDeniedException
- the access denied exception, thrown if the logged in user doesn't have authorization for this operationConfigManagerException
- the config manager exception, thrown if a generic exception occursvoid addDerivedAttributes(Constants.Entity entityType, java.util.Map derivedAttributesMap) throws NoSuchEntityException, ConfigManagerException
entityType
- the entity typederivedAttributesMap
- the map of derived attribute name and its list of dependent attributes.NoSuchEntityException
- the no such entity exception, thrown if the entity doesn't existConfigManagerException
- the config manager exception, thrown if a generic exception occursjava.util.List getSearchableAttributes(Constants.Entity entityType) throws NoSuchEntityException, AccessDeniedException, ConfigManagerException
entityType
- the entity typeNoSuchEntityException
- the no such entity exception, thrown if the entity doesn't existAccessDeniedException
- the access denied exception, thrown if the logged in user doesn't have authorization for this operationConfigManagerException
- the config manager exception, thrown if a generic exception occursvoid setSearchAttributes(Constants.Entity entityType, java.util.List simpleAttrs, java.util.List advancedAttrs, java.util.List resultsTableAttrs) throws NoSuchEntityException, AccessDeniedException, EmptyAdvancedSearchAttributesException, EmptySimpleSearchAttributesException, EmptySearchResultsException, SearchResultsNotSubsetException, SimpleSearchNotSubsetException, ConfigManagerException
entityType
- the entity typesimpleAttrs
- the simple attributesadvancedAttrs
- the advanced attributesresultsTableAttrs
- the results table attributesNoSuchEntityException
- the no such entity exception, thrown when the entity doesn't existAccessDeniedException
- the access denied exception, thrown when the logged in user doesn't ahve authorization for this operationEmptyAdvancedSearchAttributesException
- the empty advanced search attributes exception, thrown when no advanced search attributes are specifiedEmptySimpleSearchAttributesException
- the empty simple search attributes exception, thrown when no simple search attributes are specifiedEmptySearchResultsException
- the empty search results exception, thrown when no search results attributes are specifiedSearchResultsNotSubsetException
- the search results not subset exception, thrown when search results attributes are not a subset of the advanced search attributesSimpleSearchNotSubsetException
- the simple search not subset exception, thrown when simple search attributes are not subset of advanced search attributesConfigManagerException
- the config manager exception, thrown when a generic exception occursjava.util.List getSimpleSearchAttributes(Constants.Entity entityType) throws NoSuchEntityException, AccessDeniedException
entityType
- the entity typeNoSuchEntityException
- the no such entity exception, thrown when the entity doesn't existAccessDeniedException
- the access denied exception, thrown when the logged in user doesn't have authorization for this operationvoid setSimpleSearchAttributes(Constants.Entity entityType, java.util.List attrs) throws NoSuchEntityException, AccessDeniedException, ConfigManagerException
entityType
- the entity typeattrs
- the attributesNoSuchEntityException
- the no such entity exception, thrown when the entity doesn't existAccessDeniedException
- the access denied exception, thrown when the logged in user doesn't have authorization for this operationConfigManagerException
- the config manager exception, thrown when a generic exception occursjava.util.Map getAdvancedSearchAttributes(Constants.Entity entityType) throws NoSuchEntityException, AccessDeniedException
entityType
- the entity typeNoSuchEntityException
- the no such entity exception, thrown when the entity doesn't existAccessDeniedException
- the access denied exception, thrown when the logged in user doesn't have authorization for this operationvoid setAdvancedSearchAttributes(Constants.Entity entityType, java.util.List attrs) throws NoSuchEntityException, AccessDeniedException, ConfigManagerException
entityType
- the entity typeattrs
- the advanced attributesNoSuchEntityException
- the no such entity exceptionAccessDeniedException
- the access denied exceptionConfigManagerException
- the config manager exceptionjava.util.List getSearchResultsTableAttributes(Constants.Entity entityType) throws NoSuchEntityException, AccessDeniedException
entityType
- the entity typeNoSuchEntityException
- the no such entity exception, when the entity doesn't existAccessDeniedException
- the access denied exception, thrown when the logged in user doesn't have authorization for this operationvoid setSearchResultsTableAttributes(Constants.Entity entityType, java.util.List attributes) throws NoSuchEntityException, AccessDeniedException, ConfigManagerException
entityType
- the entity typeattributes
- the search results attributesNoSuchEntityException
- the no such entity exception, thrown when the entity doesn't existAccessDeniedException
- the access denied exception, thrown when the logged in user doesn't have authorization for this operationConfigManagerException
- the config manager exception, thrown when a general exception occurs
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |