com.gemstone.gemfire.cache.query.CqAttributes Maven / Gradle / Ivy
/*
* Copyright (c) 2010-2015 Pivotal Software, Inc. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you
* may not use this file except in compliance with the License. You
* may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
* implied. See the License for the specific language governing
* permissions and limitations under the License. See accompanying
* LICENSE file.
*/
package com.gemstone.gemfire.cache.query;
/**
* This interface holds all attribute values for a CQ and provides methods for
* retrieving all attribute settings. This interface can be modified only by
* the CqAttributesFactory class (before CQ creation) and the CqAttributesMutator
* interface (after CQ creation).
*
* For compatibility rules and default values, see {@link CqAttributesFactory}.
*
* @author Anil
* @since 5.5
*/
public interface CqAttributes {
/**
* Get the CqListeners set with the CQ.
* Returns all the Listener associated with this CQ.
* @see CqListener
* @return CQListener[] array of CqListner
*/
public CqListener[] getCqListeners();
/**
* Get the CqListener set with the CQ.
* Returns the CqListener associated with the CQ.
* If there are more than one CqListener throws IllegalStateException.
* @see CqListener
* @return CqListener Object, returns null if there is no CqListener.
*/
public CqListener getCqListener();
}