buildframework/helium/sf/java/signaling/src/com/nokia/helium/signal/Notifier.java
author wbernard
Fri, 13 Aug 2010 14:59:05 +0300
changeset 628 7c4a911dc066
parent 587 85df38eb4012
permissions -rw-r--r--
helium_11.0.0-e00f171ca185
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     1
/*
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     2
* Copyright (c) 2007-2008 Nokia Corporation and/or its subsidiary(-ies).
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     3
* All rights reserved.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     4
* This component and the accompanying materials are made available
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     5
* under the terms of the License "Eclipse Public License v1.0"
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     6
* which accompanies this distribution, and is available
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     8
*
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     9
* Initial Contributors:
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    11
*
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    12
* Contributors:
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    13
*
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    14
* Description:  
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    15
*
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    16
*/
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    17
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    18
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    19
package com.nokia.helium.signal;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    20
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    21
import org.apache.tools.ant.Project;
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    22
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    23
import com.nokia.helium.signal.ant.types.NotifierInput;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    24
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    25
/**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    26
 * This interface describe what method a Notifier needs to implement.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    27
 * 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    28
 */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    29
public interface Notifier {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    30
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    31
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    32
     * Setting the project.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    33
     * 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    34
     * @param project
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    35
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    36
    void setProject(Project project);
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    37
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    38
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    39
     * Sends the data to the requested sender list with specified notifier
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    40
     * 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    41
     * @param signalName is the name of the signal that has been raised.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    42
     * @param failStatus indicates whether to fail the build or not
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    43
     * @param notifierInput contains signal notifier info
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    44
     * @param message is the message from the signal that has been raised.           
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    45
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    46
    void sendData(String signalName, boolean failStatus,
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    47
            NotifierInput notifierInput, String message );
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    48
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    49
}