DocumentationAEM GuidesAEM Guides Documentation

Java-based API to work with folder profiles id175UB30E05Z

Last update: Fri Aug 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Experienced
  • Developer
NOTE
You can use Java-based APIs available in Experience Manager Guides to create custom plugins and extend out-of-the-box workflows. This article will be archived in November 2024.
View javadoc for the latest and detailed documentation on using the Java-based API.

The following Java-based API allows you to add conditional attributes to a folder-level profile. This API is available in the form of a bundle. You must include this bundle in your code to use this APIs.

Bundle details:

  • Group ID: com.adobe.fmdita

  • Artifact ID: api

  • Version: 3.2

  • Package: com.adobe.fmdita.api.profiles

  • Class details:

    code language-java 
    public class FolderProfileUtils extends Object

    The FolderProfileUtils class contains a method for adding conditional attributes in a folder profile.

Add conditional attributes to a folder profile

The addAttributeProfiles method adds conditional attributes to a folder-level profile.

Syntax:

public static boolean addAttributeProfiles
(List
<String> attributeNames,
List
    <String> values,
List
        <String> labels,
String profileName,
Session session) throws GuidesApiException

Parameters:

Name
Type
Description
attributeNames
String
A list of attribute names.
values
String
A list of values for the given attributes.
labels
String
A list of labels for the attribute- value pairs. 1
profileName
String
The name of the folder-level profile to which these attributes, values, and labels have to be applied. Important: All existing attributes-values-labels defined in the profile are overwritten.
session
javax.jcr.Session
A valid JCR session.

Returns:
true for success. In case of a failure, it throws an exception.

Exception:
Throws java.lang.Exception in the following scenarios:

  • If the API couldn’t get resourceResolverFactory object. In that case, you should restart the bundle.
  • If parameters passed to the API are invalid.
  • If the API is called through unauthorized user session, such as the user who is not an administrator for the given folder profile.

1 The attributeNames, values, and labels at the same index in an array list must correspond to the same entry.

recommendation-more-help
11125c99-e1a1-4369-b5d7-fb3098b9b178