001/**
002 *
003 * Copyright 2003-2007 Jive Software.
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * You may obtain a copy of the License at
008 *
009 *     http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package org.jivesoftware.smackx.workgroup.agent;
019
020/**
021 * Type of content being included in the offer. The content actually explains the reason
022 * the agent is getting an offer.
023 *
024 * @author Gaston Dombiak
025 */
026public abstract class OfferContent {
027
028    /**
029     * Returns true if the content of the offer is related to a user request. This is the
030     * most common type of offers an agent should receive.
031     *
032     * @return true if the content of the offer is related to a user request.
033     */
034    abstract boolean isUserRequest();
035
036    /**
037     * Returns true if the content of the offer is related to a room invitation made by another
038     * agent. This type of offer include the room to join, metadata sent by the user while joining
039     * the queue and the reason why the agent is being invited.
040     *
041     * @return true if the content of the offer is related to a room invitation made by another agent.
042     */
043    abstract boolean isInvitation();
044
045    /**
046     * Returns true if the content of the offer is related to a service transfer made by another
047     * agent. This type of offers include the room to join, metadata sent by the user while joining the
048     * queue and the reason why the agent is receiving the transfer offer.
049     *
050     * @return true if the content of the offer is related to a service transfer made by another agent.
051     */
052    abstract boolean isTransfer();
053}