com.day.cq.wcm.mobile.api.device.DeviceGroupProvider Maven / Gradle / Ivy

/*
 * Copyright 1997-2008 Day Management AG
 * Barfuesserplatz 6, 4001 Basel, Switzerland
 * All Rights Reserved.
 *
 * This software is the confidential and proprietary information of
 * Day Management AG, ("Confidential Information"). You shall not
 * disclose such Confidential Information and shall use it only in
 * accordance with the terms of the license agreement you entered into
 * with Day.
 */
package com.day.cq.wcm.mobile.api.device;

import java.util.Collection;

/**
 * The DeviceGroupProvider provides access to existing device groups.
 */
public interface DeviceGroupProvider {

    public static final String MOUNTPOINT_DEVICEGROUPS = "wcm/mobile/groups";

    /**
     * Returns the {@link DeviceGroup} as identified by its name. If no device group matches the given
     * name, null is returned.
     *
     * @param name The name of the desired device group.
     *
     * @return The device group with the given name, or null if not found.
     */
    DeviceGroup get(String name);

    /**
     * Returns all {@link DeviceGroup}s known to this provider.
     *
     * @return A Collection containing all known device groups.
     */
    Collection getAll();

    /**
     * Tries to find a matching {@link DeviceGroup} using the provided {@link DeviceGroupPredicate}.
     *
     * @param predicate The predicate to find a match with.
     *
     * @return The matching DeviceGroup or null if none was found.
     */
    DeviceGroup find(DeviceGroupPredicate predicate);
}